makVrv::DtEntityDecalEffectVisualizer Class Reference

Visualizes a textured strip trailing behind an entity, such as a boat's wake. More...

Inheritance diagram for makVrv::DtEntityDecalEffectVisualizer:

Public Member Functions
	DtEntityDecalEffectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtEntityDecalEffectVisualizer ()
	DTOR.
virtual void	setDecalEffectEnabled (bool b)
	Set whether the decal effect is enabled.
bool	decalEffectEnabled () const
	Get whether the decal effect is enabled.
virtual void	setDecalCreationPaused (bool b)
	Set whether the decal effect is paused.
bool	decalCreationPaused () const
	Get whether the decal effect is paused.
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.
virtual void	setState (int stateNumber, int stateValue)
	Override to set the attribute state of agents.
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	slot_listenerGlobalHostIdSet (const std::string &)
void	setEmbarked (bool b)
virtual bool	visible () const
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	Set any other additional visualizer information from the visual record.
virtual void	updateDrawState ()
	Visible means that the model agent is created or destroyed when the model agent is destroyed all particles instantly disappear never to be seen again If the entity stops then the particle system is just stopped but the previously created particles stick around If the effect enabled is set to false then the decal effect is no longer visible and the model agent is destroyed.

Protected Attributes
DtTrailEffect *	myDecalEffect
bool	myDecalCreationPaused
bool	myEffectEnabled
bool	myEmbarked
DtDecalModelAgent *	myDecalEffectAgent
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

Visualizes a textured strip trailing behind an entity, such as a boat's wake.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEntityDecalEffectVisualizer::~DtEntityDecalEffectVisualizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntityDecalEffectVisualizer::setDecalEffectEnabled ( bool  b )

virtual

Set whether the decal effect is enabled.

bool makVrv::DtEntityDecalEffectVisualizer::decalEffectEnabled

(

)

const

Get whether the decal effect is enabled.

virtual void makVrv::DtEntityDecalEffectVisualizer::setDecalCreationPaused ( bool  b )

virtual

Set whether the decal effect is paused.

bool makVrv::DtEntityDecalEffectVisualizer::decalCreationPaused

(

)

const

Get whether the decal effect is paused.

So if it is still visible it will create invisible particles instead of visible ones so it can transition between off and on correctly

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

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

static

This class's type info.

virtual void makVrv::DtEntityDecalEffectVisualizer::createModelAgents ( )

protectedvirtual

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

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityDecalEffectVisualizer::destroyModelAgents ( )

protectedvirtual

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

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

virtual void makVrv::DtEntityDecalEffectVisualizer::slot_listenerGlobalHostIdSet ( const std::string &  )

protectedvirtual

void makVrv::DtEntityDecalEffectVisualizer::setEmbarked ( bool  b )

protected

virtual bool makVrv::DtEntityDecalEffectVisualizer::visible ( ) const

protectedvirtual

virtual void makVrv::DtEntityDecalEffectVisualizer::setVisualizerDefinition ( const DtVisualizerDefinition &  )

protectedvirtual

Set any other additional visualizer information from the visual record.

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityDecalEffectVisualizer.

virtual void makVrv::DtEntityDecalEffectVisualizer::updateDrawState ( )

protectedvirtual

Visible means that the model agent is created or destroyed when the model agent is destroyed all particles instantly disappear never to be seen again If the entity stops then the particle system is just stopped but the previously created particles stick around If the effect enabled is set to false then the decal effect is no longer visible and the model agent is destroyed.

Member Data Documentation

DtTrailEffect* makVrv::DtEntityDecalEffectVisualizer::myDecalEffect

protected

bool makVrv::DtEntityDecalEffectVisualizer::myDecalCreationPaused

protected

bool makVrv::DtEntityDecalEffectVisualizer::myEffectEnabled

protected

bool makVrv::DtEntityDecalEffectVisualizer::myEmbarked

protected

DtDecalModelAgent* makVrv::DtEntityDecalEffectVisualizer::myDecalEffectAgent

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvCore/DtEntityDecalEffectVisualizer.h