makVrv::DtEntityArticulatedStateModelVisualizer Class Reference

State visualizer for entities with articulated models. More...

Inheritance diagram for makVrv::DtEntityArticulatedStateModelVisualizer:

Public Member Functions
	DtEntityArticulatedStateModelVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEntityArticulatedStateModelVisualizer ()
	DTOR.
virtual void	setAutoSendMovingState (bool)
	Set to false to not automatically set moving state.
bool	autoSendMovingState () const
virtual void	setState (int stateNumber, int stateValue)
	Sets the state of the articulated model.
virtual void	setMarkingDecal (const std::string &linkageName, const std::string &configName)
	Sets the marking decal of the articulated model.
virtual void	setDynamicRegion (const std::string &regionName, int stateValue)
	Sets the state of an active region on a sensorized model.
virtual void	weaponFired (const DtUnicode &munitionModelDefName)
	Tell the model that it fired a weapon.
virtual void	addMovingDynamicRegion (const std::string &regionName)
	Specify an active region that should be activated/deactivated when moving.
virtual const std::list < std::string > &	movingDynamicRegions () const
	Get the list of dynamic regions to use when moving.
virtual void	addPowerPlantDynamicRegion (const std::string &regionName)
	Specify an active region that should be activated/deactivated with the power plant state.
virtual const std::list < std::string > &	powerPlantDynamicRegions () const
	Get the list of dynamic regions to control with powerPlant status.
virtual void	addWeaponFireDynamicRegion (const std::string &regionName)
	Specify an active region that should be activated/deactivated when a weapon fires.
virtual const std::list < std::string > &	weaponFireDynamicRegions () const
	Get the list of dynamic regions to control with weapon fire.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	process the visual definition record
virtual void	setColorizedColor (float r, float g, float b, float alpha)
	Set the color of the model.
virtual void	setDisableModelScaling (bool b)
	Set whether model scaling is disabled (false by default)
virtual void	setLocalModelScalingEnabled (bool enabled)
	Set whether local model scaling is enabled ( false by default )
virtual void	setLocalModelScalingAmount (float localScl)
	Set the amount of local scaling to apply ( when enabled ).
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
Public Member Functions inherited from makVrv::DtEntityStateVisualizer
	DtEntityStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEntityStateVisualizer ()
	DTOR.
DtEntityStateListener &	entityStateListener ()
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
virtual void	setParent (DtStateVisualizer *)
	Override to set the parent of this visualizer.
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)
DtUniqueID	uniqueID () const
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 ()
	Override to create model agents that will be used to display data from the listener.
virtual void	destroyModelAgents ()
	Destroys all currently created definitions.
virtual void	setModelDefinitionForAgents ()
	Sets model definition for all the agents that this visualizer might be using.
virtual void	updateColorBlending ()
virtual void	setPartTranslation (int partNumber, const DtVector &transform, const DtVector &velocity)
	Update the part translation.
virtual void	setPartOrientation (int partNumber, const DtTaitBryan &orientation, const DtVector &rotationalVelocity)
	Rotate the part.
virtual void	setVelocity (const DtVector32 &v)
	Checks to see whether or not to set moving bit.
virtual void	processModelDefinition (const DtModelDefinition *definition)
virtual void	discoverDynamicRegions (const DtModelDefinition *definition)
	search the model definition for moving and powerPlant dynamic regions
void	updateMoving (bool moving)
virtual void	setRelativeVelocity (const DtVector32 &v)

Protected Attributes
DtArticulatedModelAgent *	myArticulatedModelAgent
bool	myAutoSendMovingState
bool	myMovingFlag
bool	myAffectsBounds
bool	myColorized
float	myColorizedRed
float	myColorizedGreen
float	myColorizedBlue
float	myColorizedAlpha
bool	myDisableModelScaling
bool	myEnableLocalModelScaling
float	myLocalModelScalingAmount
std::list< std::string >	myMovingDynamicRegions
std::list< std::string >	myPowerPlantDynamicRegions
std::list< std::string >	myWeaponFireDynamicRegions
Protected Attributes inherited from makVrv::DtEntityStateVisualizer
DtEntityStateListener *	myEntityListener
	Same as myListener, but casted for convenience.
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

State visualizer for entities with articulated models.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEntityArticulatedStateModelVisualizer::~DtEntityArticulatedStateModelVisualizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setAutoSendMovingState ( bool  )

virtual

Set to false to not automatically set moving state.

bool makVrv::DtEntityArticulatedStateModelVisualizer::autoSendMovingState ( ) const

inline

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setState ( int  stateNumber, int  stateValue  )

virtual

Sets the state of the articulated model.

Reimplemented from makVrv::DtEntityStateVisualizer.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrlinkAggregateArticulatedStateModelVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityArticulatedStateModelVisualizer.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setMarkingDecal ( const std::string &  linkageName, const std::string &  configName  )

virtual

Sets the marking decal of the articulated model.

See DtOsgArticulatedModel::setLinkageConfigPair() for additional information.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setDynamicRegion ( const std::string &  regionName, int  stateValue  )

virtual

Sets the state of an active region on a sensorized model.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::weaponFired ( const DtUnicode &  munitionModelDefName )

virtual

Tell the model that it fired a weapon.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::addMovingDynamicRegion ( const std::string &  regionName )

virtual

Specify an active region that should be activated/deactivated when moving.

Multiple regions are supported.

virtual const std::list<std::string>& makVrv::DtEntityArticulatedStateModelVisualizer::movingDynamicRegions ( ) const

virtual

Get the list of dynamic regions to use when moving.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::addPowerPlantDynamicRegion ( const std::string &  regionName )

virtual

Specify an active region that should be activated/deactivated with the power plant state.

Multiple regions are supported.

virtual const std::list<std::string>& makVrv::DtEntityArticulatedStateModelVisualizer::powerPlantDynamicRegions ( ) const

virtual

Get the list of dynamic regions to control with powerPlant status.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::addWeaponFireDynamicRegion ( const std::string &  regionName )

virtual

Specify an active region that should be activated/deactivated when a weapon fires.

Multiple regions are supported.

virtual const std::list<std::string>& makVrv::DtEntityArticulatedStateModelVisualizer::weaponFireDynamicRegions ( ) const

virtual

Get the list of dynamic regions to control with weapon fire.

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

virtual

process the visual definition record

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setColorizedColor ( float  r, float  g, float  b, float  alpha  )

virtual

Set the color of the model.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setDisableModelScaling ( bool  b )

virtual

Set whether model scaling is disabled (false by default)

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setLocalModelScalingEnabled ( bool  enabled )

virtual

Set whether local model scaling is enabled ( false by default )

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setLocalModelScalingAmount ( float  localScl )

virtual

Set the amount of local scaling to apply ( when enabled ).

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrlinkAggregateArticulatedStateModelVisualizer, and makVrf::DtAggregateArticulatedStateModelVisualizer.

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

static

This class's type info.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrlinkAggregateArticulatedStateModelVisualizer, and makVrf::DtAggregateArticulatedStateModelVisualizer.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::createModelAgents ( )

protectedvirtual

Override to create model agents that will be used to display data from the listener.

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfVrlinkEntityArticulatedStateModelVisualizer, makVrf::VRF_PROTOCOL_NAMESPACE::DtVrlinkAggregateArticulatedStateModelVisualizer, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityArticulatedStateModelVisualizer, and makVrf::DtVrfEntityArticulatedStateModelVisualizer.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::destroyModelAgents ( )

protectedvirtual

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::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

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrf::VRF_PROTOCOL_NAMESPACE::DtVrlinkAggregateArticulatedStateModelVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityArticulatedStateModelVisualizer.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::updateColorBlending ( )

protectedvirtual

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setPartTranslation ( int  partNumber, const DtVector &  transform, const DtVector &  velocity  )

protectedvirtual

Update the part translation.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setPartOrientation ( int  partNumber, const DtTaitBryan &  orientation, const DtVector &  rotationalVelocity  )

protectedvirtual

Rotate the part.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setVelocity ( const DtVector32 &  v )

protectedvirtual

Checks to see whether or not to set moving bit.

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::processModelDefinition ( const DtModelDefinition *  definition )

protectedvirtual

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::discoverDynamicRegions ( const DtModelDefinition *  definition )

protectedvirtual

search the model definition for moving and powerPlant dynamic regions

void makVrv::DtEntityArticulatedStateModelVisualizer::updateMoving ( bool  moving )

protected

virtual void makVrv::DtEntityArticulatedStateModelVisualizer::setRelativeVelocity ( const DtVector32 &  v )

protectedvirtual

Member Data Documentation

DtArticulatedModelAgent* makVrv::DtEntityArticulatedStateModelVisualizer::myArticulatedModelAgent

protected

bool makVrv::DtEntityArticulatedStateModelVisualizer::myAutoSendMovingState

protected

bool makVrv::DtEntityArticulatedStateModelVisualizer::myMovingFlag

protected

bool makVrv::DtEntityArticulatedStateModelVisualizer::myAffectsBounds

protected

bool makVrv::DtEntityArticulatedStateModelVisualizer::myColorized

protected

float makVrv::DtEntityArticulatedStateModelVisualizer::myColorizedRed

protected

float makVrv::DtEntityArticulatedStateModelVisualizer::myColorizedGreen

protected

float makVrv::DtEntityArticulatedStateModelVisualizer::myColorizedBlue

protected

float makVrv::DtEntityArticulatedStateModelVisualizer::myColorizedAlpha

protected

bool makVrv::DtEntityArticulatedStateModelVisualizer::myDisableModelScaling

protected

bool makVrv::DtEntityArticulatedStateModelVisualizer::myEnableLocalModelScaling

protected

float makVrv::DtEntityArticulatedStateModelVisualizer::myLocalModelScalingAmount

protected

std::list<std::string> makVrv::DtEntityArticulatedStateModelVisualizer::myMovingDynamicRegions

protected

std::list<std::string> makVrv::DtEntityArticulatedStateModelVisualizer::myPowerPlantDynamicRegions

protected

std::list<std::string> makVrv::DtEntityArticulatedStateModelVisualizer::myWeaponFireDynamicRegions

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvCore/DtEntityArticulatedStateModelVisualizer.h