makVrv::DtEntityKinStateVisualizer Class Reference

Visualizes the kinematic state of an entity by moving a scene object. More...

Inheritance diagram for makVrv::DtEntityKinStateVisualizer:

Public Member Functions
	DtEntityKinStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEntityKinStateVisualizer ()
	DTOR.
virtual void	setLocation (const DtVector &)
	Call to scene object to set location.
virtual void	setLocation (const DtVector &, double time)
	This version will use the time supplied as the dead reckoned time.
virtual void	setOrientation (const DtTaitBryan &)
	Call to scene object to set orientation.
virtual void	setOrientation (const DtTaitBryan &, double time)
	This version will use the time supplied as the dead reckoned time.
virtual void	setVelocity (const DtVector &)
	Call to scene object to set velocity.
virtual void	setVelocity (const DtVector &, double time)
	This version will use the time supplied as the dead reckoned time.
virtual void	setAngularVelocity (const DtVector &)
	Call to scene object to set angular velocity.
virtual void	setAngularVelocity (const DtVector &, double time)
	This version will use the time supplied as the dead reckoned time.
virtual void	setAcceleration (const DtVector &)
	Call to scene object to set acceleration.
virtual void	setAcceleration (const DtVector &, double time)
	This version will use the time supplied as the dead reckoned time.
virtual void	setDeadReckoning (bool position, bool velocity, bool orientation)
virtual void	setEmbarked (const DtUniqueID &id)
	Embarks this object on the specified parent object.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Set the visual definition.
void	setSmoothingEnabled (bool enabled)
	Set whether the Entity smooths.
void	setSmoothingPeriod (float scale)
	Set the period for entity smoothing.
virtual void	setGroundClampingCullingEnabled (bool enabled)
	Ground clamping code.
virtual void	setGroundClampingScale (float scale)
	Set the scale factor for ground clamping distance culling by radius.
virtual void	setGroundClamping (bool enabled)
	Set ground clamping enabled or not.
virtual void	setGroundClampingMode (DtGroundClampingUpdater::GroundClampingMode mode)
	Set ground clamping mode using bit flags defined in DtGroundClampingUpdater::GroundClampingMode.
virtual void	setPossibleGroundClampingModes (DtGroundClampingUpdater::GroundClampingMode possibleModes)
	Set the flags for all possible modes for this entity.
virtual DtGroundClampingUpdater::GroundClampingMode	groundClampingMode ()
	Get the entity's current ground clamping mode.
void	setAutoEnableGroundClamping (bool b)
bool	autoEnableGroundClamping () const
virtual void	resetSpatialAttributes ()
DtEntityStateListener &	entityStateListener ()
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
Public Member Functions inherited from makVrv::DtSceneObjectVisualizer
	DtSceneObjectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
virtual	~DtSceneObjectVisualizer ()
virtual DtUniqueID	uniqueID () const
	Return unique id of mySceneObjectAgent, if it exists, else returns 0;.
virtual DtSceneObjectAgent *	sceneObjectAgent ()
virtual void	setParent (DtStateVisualizer *p)
	Override of base class setParent to simply set the parent without destroying/recreating model agents.
virtual void	setSceneObjectAgent (DtSceneObjectAgent *)
virtual void	setElementID (const DtElementID &elementID)
DtElementID	elementID () const
virtual bool	show (int)
	Override to show/hide scene object agent (if it exists)
virtual bool	hide (int)
	Will call destroyModelAgents(), if, when the context is added, it is the first context in the list.
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
void	setModelDefinition (const std::string &definition)
	Sets the model definition and creates agent(s) based on that definition.
const std::string &	modelDefinition () const
	Gets the current model definition.
virtual bool	setVisible (bool visible, int context)
	Returns true if this context wants to show or hide the item.
virtual void	initialize ()
	Initialize the visualizer.
virtual bool	isVisible () const
	Returns true if visible.
virtual void	setSelected (bool)
	Sets selected state.
virtual bool	selected () const
void	setName (const std::string &)
	Internal name of state visualizer.
const std::string &	name () const
virtual void	setPickable (bool)
	Sets pickable state.
virtual bool	pickable () const
virtual void	setUniqueID (DtUniqueID id)
int	visualizerType () const
void	setShowHideContext (const std::vector< int > &s)
	Set show/hide context without changing visibility of item.
DtStateListener &	listener ()
DtBaseConnection &	simulation ()
	Get the connection for this visualizer.
void	setDistribute (bool b)
	Whether or not to distribute over the network.
bool	distribute () const

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()
	This class's type info.

Protected Member Functions
virtual void	createModelAgents ()
	Creates the model agent. If already created, makes it visible.
virtual void	destroyModelAgents ()
	Model agent is only destroyed in destructor.
virtual void	setModelDefinitionForAgents ()
	Sets model definition for all the agents that this visualizer might be using.
virtual void	embarkedStateChanged ()
virtual void	createEmbarkedUpdater ()
virtual void	createUpdater ()
virtual void	initializeObjectAgent ()
Protected Member Functions inherited from makVrv::DtSceneObjectVisualizer
virtual DtSceneObjectAgent *	createObjectAgent ()
Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void	slot_mouseDown (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
	Called when the mouse is clicked in this visualizer.
virtual void	slot_mouseUp (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual void	slot_mouseDblClick (DtMouseState &mouseState, const std::string &displayEngineName, const std::string &windowName, const std::string &channelName)
virtual bool	supportsShowHideContext (int) const
	Default returns true.
template<typename T , typename C >
void	connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity.

Protected Attributes
DtDeadReckonGroundClampUpdaterAgent *	myDeadReckonGroundClampUpdaterAgent
DtAttachableDeadReckonUpdaterAgent *	myEmbarkedUpdaterAgent
bool	myEmbarkedFlag
DtUniqueID	myEmbarkedParentID
bool	myGroundClampingEnabled
	Ground clamping members.
float	myGroundClampingScale
bool	myAutoEnableGroundClamping
bool	myGroundClampingCullingEnabled
bool	mySmoothingEnabled
float	mySmoothingPeriod
std::string	myMotionModel
DtGroundClampingUpdater::GroundClampingMode	myGroundClampingMode
DtGroundClampingUpdater::GroundClampingMode	myPossibleGroundClampingModes
bool	myDRPos
bool	myDRVel
bool	myDROri
DtEntityStateListener *	myEntityListener
	Same as myListener, but casted for convenience.
Protected Attributes inherited from makVrv::DtSceneObjectVisualizer
DtElementID	myElementID
Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection &	mySimulation
DtStateListener &	myListener
bool	myDistributeFlag
DtUniqueID	myUniqueID
std::string	myName
std::string	myModelDefinition
DtSignalConnectionManager	myConnections
int	myModelSet
int	myVisualizerType
std::vector< int >	myShowHideContexts
bool	mySelected
bool	myPickable
bool	myVisible
DtStateVisualizer *	myParent
DtSceneObjectAgent *	mySceneObjectAgent

Additional Inherited Members
Public Types inherited from makVrv::DtStateVisualizer
enum	Type {   AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,   AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000 }
	Visualizer class types that are supportable via visualizers. More...
Public Attributes inherited from makVrv::DtStateVisualizer
boost::signal< void(DtStateVisualizer *, DtStateVisualizer *, DtStateVisualizer *)>	signal_reparented
	Signaled when the parent of this item changes, called before destroying any model agents.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDown
	Emitted when the entity's indicator is clicked.
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseUp
boost::signal< void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDblClick

Detailed Description

Visualizes the kinematic state of an entity by moving a scene object.

Constructor & Destructor Documentation

makVrv::DtEntityKinStateVisualizer::DtEntityKinStateVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		int	modelSet
	)

CTOR.

virtual makVrv::DtEntityKinStateVisualizer::~DtEntityKinStateVisualizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntityKinStateVisualizer::setLocation ( const DtVector &  )

virtual

Call to scene object to set location.

This version will use the DE representation of the current sim time when using dead reckoning

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setLocation ( const DtVector &  , double  time  )

virtual

This version will use the time supplied as the dead reckoned time.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setOrientation ( const DtTaitBryan &  )

virtual

Call to scene object to set orientation.

This version will use the DE representation of the current sim time when using dead reckoning

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setOrientation ( const DtTaitBryan &  , double  time  )

virtual

This version will use the time supplied as the dead reckoned time.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setVelocity ( const DtVector &  )

virtual

Call to scene object to set velocity.

This version will use the DE representation of the current sim time when using dead reckoning

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setVelocity ( const DtVector &  , double  time  )

virtual

This version will use the time supplied as the dead reckoned time.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setAngularVelocity ( const DtVector &  )

virtual

Call to scene object to set angular velocity.

This version will use the DE representation of the current sim time when using dead reckoning

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setAngularVelocity ( const DtVector &  , double  time  )

virtual

This version will use the time supplied as the dead reckoned time.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setAcceleration ( const DtVector &  )

virtual

Call to scene object to set acceleration.

This version will use the DE representation of the current sim time when using dead reckoning

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setAcceleration ( const DtVector &  , double  time  )

virtual

This version will use the time supplied as the dead reckoned time.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setDeadReckoning ( bool  position, bool  velocity, bool  orientation  )

virtual

virtual void makVrv::DtEntityKinStateVisualizer::setEmbarked ( const DtUniqueID &  id )

virtual

Embarks this object on the specified parent object.

virtual void makVrv::DtEntityKinStateVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  visDef )

virtual

Set the visual definition.

Reimplemented from makVrv::DtStateVisualizer.

void makVrv::DtEntityKinStateVisualizer::setSmoothingEnabled

(

bool

enabled

)

Set whether the Entity smooths.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer.

void makVrv::DtEntityKinStateVisualizer::setSmoothingPeriod

(

float

scale

)

Set the period for entity smoothing.

virtual void makVrv::DtEntityKinStateVisualizer::setGroundClampingCullingEnabled ( bool  enabled )

virtual

Ground clamping code.

Set whether ground clamp uses the distance cutoff

virtual void makVrv::DtEntityKinStateVisualizer::setGroundClampingScale ( float  scale )

virtual

Set the scale factor for ground clamping distance culling by radius.

virtual void makVrv::DtEntityKinStateVisualizer::setGroundClamping ( bool  enabled )

virtual

Set ground clamping enabled or not.

virtual void makVrv::DtEntityKinStateVisualizer::setGroundClampingMode ( DtGroundClampingUpdater::GroundClampingMode  mode )

virtual

Set ground clamping mode using bit flags defined in DtGroundClampingUpdater::GroundClampingMode.

virtual void makVrv::DtEntityKinStateVisualizer::setPossibleGroundClampingModes ( DtGroundClampingUpdater::GroundClampingMode  possibleModes )

virtual

Set the flags for all possible modes for this entity.

virtual DtGroundClampingUpdater::GroundClampingMode makVrv::DtEntityKinStateVisualizer::groundClampingMode ( )

virtual

Get the entity's current ground clamping mode.

void makVrv::DtEntityKinStateVisualizer::setAutoEnableGroundClamping ( bool  b )

inline

bool makVrv::DtEntityKinStateVisualizer::autoEnableGroundClamping ( ) const

inline

virtual void makVrv::DtEntityKinStateVisualizer::resetSpatialAttributes ( )

virtual

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

DtEntityStateListener& makVrv::DtEntityKinStateVisualizer::entityStateListener ( )

inline

virtual const DtStateVisualizer::TypeInfo& makVrv::DtEntityKinStateVisualizer::typeInfo ( ) const

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtAggregateKinStateVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::DtEntityKinStateVisualizer::theTypeInfo ( )

static

This class's type info.

Reimplemented in makVrv::DtAggregateKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::createModelAgents ( )

protectedvirtual

Creates the model agent. If already created, makes it visible.

Reimplemented from makVrv::DtSceneObjectVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::destroyModelAgents ( )

protectedvirtual

Model agent is only destroyed in destructor.

Here, it will be hidden (if it has been created)

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

Sets model definition for all the agents that this visualizer might be using.

If model agents are not created, should create them. Should not call this directly, but rather call setModelDefinition

Reimplemented from makVrv::DtSceneObjectVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::embarkedStateChanged ( )

protectedvirtual

virtual void makVrv::DtEntityKinStateVisualizer::createEmbarkedUpdater ( )

protectedvirtual

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::createUpdater ( )

protectedvirtual

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkAggregateKinStateVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityKinStateVisualizer.

virtual void makVrv::DtEntityKinStateVisualizer::initializeObjectAgent ( )

protectedvirtual

Member Data Documentation

DtDeadReckonGroundClampUpdaterAgent* makVrv::DtEntityKinStateVisualizer::myDeadReckonGroundClampUpdaterAgent

protected

DtAttachableDeadReckonUpdaterAgent* makVrv::DtEntityKinStateVisualizer::myEmbarkedUpdaterAgent

protected

bool makVrv::DtEntityKinStateVisualizer::myEmbarkedFlag

protected

DtUniqueID makVrv::DtEntityKinStateVisualizer::myEmbarkedParentID

protected

bool makVrv::DtEntityKinStateVisualizer::myGroundClampingEnabled

protected

Ground clamping members.

float makVrv::DtEntityKinStateVisualizer::myGroundClampingScale

protected

bool makVrv::DtEntityKinStateVisualizer::myAutoEnableGroundClamping

protected

bool makVrv::DtEntityKinStateVisualizer::myGroundClampingCullingEnabled

protected

bool makVrv::DtEntityKinStateVisualizer::mySmoothingEnabled

protected

float makVrv::DtEntityKinStateVisualizer::mySmoothingPeriod

protected

std::string makVrv::DtEntityKinStateVisualizer::myMotionModel

protected

DtGroundClampingUpdater::GroundClampingMode makVrv::DtEntityKinStateVisualizer::myGroundClampingMode

protected

DtGroundClampingUpdater::GroundClampingMode makVrv::DtEntityKinStateVisualizer::myPossibleGroundClampingModes

protected

bool makVrv::DtEntityKinStateVisualizer::myDRPos

protected

bool makVrv::DtEntityKinStateVisualizer::myDRVel

protected

bool makVrv::DtEntityKinStateVisualizer::myDROri

protected

DtEntityStateListener* makVrv::DtEntityKinStateVisualizer::myEntityListener

protected

Same as myListener, but casted for convenience.

---

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

• include/vrvCore/DtEntityKinStateVisualizer.h