DtEnvironmentalKinematicState Controls kinematic state of a scene object. This class has no accessors to kinematic data due to updaters being in the render thread. Do not add accessors for kin state info. This class does not support ground clamping, VRF sends positions to VRV that are already ground clamped. Some TGs require that their orienation be "levelled" to the terrain. This is achieved by making calling to the network listener that can correctly calculate the leveled orientation. This class applies the levelled orientation on the scene object if myOrientationLevelling is set. This can be enabled using setOrientationLevelling, or by setting the bool visualizer definition field "enablelevelling". Default is false.

Inheritance diagram for makVrv::DtEnvironmentalKinematicState:

[legend]

Public Member Functions
	DtEnvironmentalKinematicState (DtStateListener &listener, DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager)

virtual	~DtEnvironmentalKinematicState ()

	DtEnvironmentalKinematicState ()=delete

	DtEnvironmentalKinematicState (const DtEnvironmentalKinematicState &)=delete

DtEnvironmentalKinematicState &	operator= (const DtEnvironmentalKinematicState &)=delete

virtual void	initialize () override

virtual void	setLocation (const DtVector &location)

virtual void	setRelativeLocation (const DtVector &)

virtual void	startEmbarked () override

virtual void	endEmbarked () override

virtual DtEnvironmentalEmbarkationUpdaterAgent *	findEmbarkationUpdater ()


virtual void	setOrientationLevelling (bool enabled)

virtual bool	isOrientationLevelling ()

virtual DtTaitBryan	level ()

Public Member Functions inherited from makVrv::DtKinematicState
	DtKinematicState (DtStateListener &listener, DtAgentManagerInterface &sceneInterface, DtSharedSettingsManager &settingsManager)

virtual	~DtKinematicState ()

	DtKinematicState ()=delete

	DtKinematicState (const DtKinematicState &)=delete

DtKinematicState &	operator= (const DtKinematicState &)=delete

virtual void	processKinematicStateDefinition (const DtVisualizerDefinition *visDef)

virtual void	disconnectUpdaters ()

virtual void	addSceneObject (DtModelSetId modelSet, DtSceneObjectAgent *sceneObjectAgent)

virtual void	removeSceneObject (DtModelSetId modelSet, DtSceneObjectAgent *sceneObjectAgent)

virtual DtSceneObjectAgent *	findSceneObjectForModelSet (DtModelSetId modelSet)

virtual bool	distribute () const

virtual void	setDistribute (const bool distribute)

virtual void	setParentElement (DtElement *parent)

virtual void	updateParentElementSceneObject (DtElement *parent)

Static Public Member Functions
static const std::string &	theClassName ()

Protected Member Functions
virtual void	connectToListenerSignals () override

virtual void	connectToSettingsSignals () override

virtual void	createUpdaters () override

virtual void	destroyUpdaters () override

virtual void	addSceneObjectToUpdaters (DtModelSetId modelSet, DtSceneObjectAgent *sceneObjectAgent) override

virtual void	removeSceneObjectFromUpdaters (DtModelSetId modelSet, DtSceneObjectAgent *sceneObjectAgent) override

virtual void	resetSpatial ()

virtual void	slot_embarkationModeChanged (DtEmbarkationMode mode)

Protected Member Functions inherited from makVrv::DtKinematicState
virtual void	setEmbarked (const DtUniqueID &id)

Protected Attributes
DtTacticalGraphicStateListener &	myTacticalGraphicListener

DtEnvironmentalEmbarkationUpdaterAgent *	myEmbarkationUpdaterAgent

bool	myOrientationLevelling

DtVector	myLocalLocation

DtVector	myRelativeLocation

Protected Attributes inherited from makVrv::DtKinematicState
SceneObjectMap	mySceneObjectMap

DtStateListener &	myStateListener

DtAgentManagerInterface &	mySceneInterface

DtSharedSettingsManager &	mySettingsManager

DtSignalConnectionManager	myConnections

DtUniqueID	myEmbarkedParentSceneObjectID

bool	myEmbarkedFlag

bool	myInitialized

bool	myDistributeFlag

Additional Inherited Members
Protected Types inherited from makVrv::DtKinematicState
using	SceneObjectMap = std::unordered_map< DtModelSetId, DtSceneObjectAgent * >

Constructor & Destructor Documentation

makVrv::DtEnvironmentalKinematicState::DtEnvironmentalKinematicState	(	DtStateListener &	listener,
		DtAgentManagerInterface &	sceneInterface,
		DtSharedSettingsManager &	settingsManager
	)

CTOR.

virtual makVrv::DtEnvironmentalKinematicState::~DtEnvironmentalKinematicState ( )

virtual

DTOR.

makVrv::DtEnvironmentalKinematicState::DtEnvironmentalKinematicState ( )

delete

not allowed - default constructor

makVrv::DtEnvironmentalKinematicState::DtEnvironmentalKinematicState ( const DtEnvironmentalKinematicState & )

delete

not allowed - copy constructor

Member Function Documentation

DtEnvironmentalKinematicState& makVrv::DtEnvironmentalKinematicState::operator= ( const DtEnvironmentalKinematicState & )

delete

not allowed - equals operator

virtual void makVrv::DtEnvironmentalKinematicState::initialize ( )

overridevirtual

Initialize the Kinematic State Object.

Reimplemented from makVrv::DtKinematicState.

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState, and makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::setLocation ( const DtVector & location )

virtual

Call to scene object to set location without changing the offset.

virtual void makVrv::DtEnvironmentalKinematicState::setRelativeLocation ( const DtVector & )

virtual

If attached, the location offset from the origin of the entity.

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::startEmbarked ( )

overridevirtual

Needs to be public for the Vertex Visualizer / Element.

Implements makVrv::DtKinematicState.

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState, and makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::endEmbarked ( )

overridevirtual

Embarkation / ParentingAttempts to find a valid scene object id from the parent element calls setEmbarked if one is found. Uses the 3D Models ( ModelSet3dModels ) scene object if it is available, if not it will then try the Icons2D scene object and finally the ModelsColorized scene object.

Implements makVrv::DtKinematicState.

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState, and makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::setOrientationLevelling ( bool enabled )

virtual

Level.

virtual bool makVrv::DtEnvironmentalKinematicState::isOrientationLevelling ( )

virtual

Level.

virtual DtTaitBryan makVrv::DtEnvironmentalKinematicState::level ( )

virtual

Given the current coordinate system, return that Tait-Bryans that will keep the waypoint upright in any coordinate system Makes call to listener so it can use a network location Adds myHeadingOrientationDelta if set.

static const std::string& makVrv::DtEnvironmentalKinematicState::theClassName ( )

static

Returns "DtEnvironmentalKinematicState", this is used by the DtKinematicStateCreatorTemplate to find and register the correct creator instance e.g. findInstance( KinematicState::theClassName() + "Creator" ));.

virtual DtEnvironmentalEmbarkationUpdaterAgent* makVrv::DtEnvironmentalKinematicState::findEmbarkationUpdater ( )

virtual

Return a pointer to the embarkation updater Vertex kinematic states also use this updater Owned by shape kinematic states.

virtual void makVrv::DtEnvironmentalKinematicState::connectToListenerSignals ( )

overrideprotectedvirtual

No-op.

Reimplemented from makVrv::DtKinematicState.

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState, and makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::connectToSettingsSignals ( )

overrideprotectedvirtual

Not implemented - derived kin states do.

Implements makVrv::DtKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::createUpdaters ( )

overrideprotectedvirtual

Called by initialize.

Implements makVrv::DtKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::destroyUpdaters ( )

overrideprotectedvirtual

Not implemented.

Implements makVrv::DtKinematicState.

Reimplemented in makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::addSceneObjectToUpdaters	(	DtModelSetId	modelSet,
		DtSceneObjectAgent *	sceneObjectAgent
	)

overrideprotectedvirtual

Not implemented.

Implements makVrv::DtKinematicState.

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState, and makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::removeSceneObjectFromUpdaters	(	DtModelSetId	modelSet,
		DtSceneObjectAgent *	sceneObjectAgent
	)

overrideprotectedvirtual

Not implemented.

Implements makVrv::DtKinematicState.

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState, and makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::resetSpatial ( )

protectedvirtual

Reimplemented in makVrv::DtShapeEnvironmentalKinematicState, and makVrv::DtVertexEnvironmentalKinematicState.

virtual void makVrv::DtEnvironmentalKinematicState::slot_embarkationModeChanged ( DtEmbarkationMode mode )

protectedvirtual

Member Data Documentation

DtTacticalGraphicStateListener& makVrv::DtEnvironmentalKinematicState::myTacticalGraphicListener

protected

DtEnvironmentalEmbarkationUpdaterAgent* makVrv::DtEnvironmentalKinematicState::myEmbarkationUpdaterAgent

protected

bool makVrv::DtEnvironmentalKinematicState::myOrientationLevelling

protected

DtVector makVrv::DtEnvironmentalKinematicState::myLocalLocation

protected

DtVector makVrv::DtEnvironmentalKinematicState::myRelativeLocation

protected

The documentation for this class was generated from the following file:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvCore/DtEnvironmentalKinematicState.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation