Visualizer for entity trail state; draws trailing effects such as dust clouds or contrails behind entities. More...

Inheritance diagram for makVrv::DtEntityTrailEffectVisualizer:

Public Member Functions
	DtEntityTrailEffectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual	~DtEntityTrailEffectVisualizer ()
	DTOR. More...

virtual void	setTrailEffectEnabled (bool)
	Set whether the trail effect is enabled. More...

virtual bool	trailEffectEnabled () const
	Get whether the trail effect is enabled. More...

virtual void	setTrailEffectPaused (bool b)
	If the trail is not paused it will create new particles. More...

virtual bool	trailEffectPaused () const

virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info. More...

Public Member Functions inherited from makVrv::DtEntityEffectStateVisualizer
	DtEntityEffectStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual void	createParticleEffect ()

virtual void	setOffset (const DtVector &offset)
	offset for particle system More...

virtual void	setArtPart (int artPar)
	artPart for particle system More...

Public Member Functions inherited from makVrv::DtEntityStateVisualizer
	DtEntityStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual	~DtEntityStateVisualizer ()
	DTOR. More...

virtual void	setState (int stateNumber, int stateValue)
	Override to set the attribute state of agents. More...

DtEntityStateListener &	entityStateListener ()

Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual	~DtStateVisualizer ()
	DTOR. More...

virtual DtObserverMode::ModelSets	modelSet ()
	Return the visualizer's model set enum. More...

virtual void	setParent (DtStateVisualizer *)
	Override to set the parent of this visualizer. More...

virtual const DtStateVisualizer *	parent () const
	Get a const pointer to the parent visualizer of this visualizer. More...

void	setModelDefinition (const std::string &definition)
	Sets the model definition and creates agent(s) based on that definition. More...

const std::string &	modelDefinition () const
	Gets the current model definition. More...

virtual void	implementVisibility (bool visible)
	Wrap some of the show/hide functionality so that it can be overloaded (ex. More...

virtual bool	setVisible (bool visible, int context)
	Returns true if this context wants to show or hide the item. More...

virtual void	initialize ()
	Initialize the visualizer. More...

virtual bool	isVisible () const
	Returns true if visible. More...

virtual void	setHasMouseCursor (bool)
	Sets the mouse hover state. More...

virtual bool	hasMouseCursor () const

virtual void	setSelected (bool)
	Sets selected state. More...

virtual bool	selected () const

void	setName (const std::string &)
	Internal name of state visualizer. More...

const std::string &	name () const

virtual void	setPickable (bool)
	Sets pickable state. More...

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. More...

DtStateListener &	listener ()

DtBaseConnection &	simulation ()
	Get the connection for this visualizer. More...

void	setDistribute (bool b)
	Whether or not to distribute over the network. More...

bool	distribute () const

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

Protected Member Functions
virtual void	createModelAgents ()
	Override to create model agents that will be used to display data from the listener. More...

virtual void	destroyModelAgents ()
	deletes the model agents More...

virtual void	setModelDefinitionForAgents ()
	Sets model definition for all the agents that this visualizer might be using. More...

virtual void	setVelocity (const DtVector32 &)

virtual void	setRelativeVelocity (const DtVector32 &v)

virtual void	setIsFrozen (bool frozen)

virtual void	setEmbarkedOn (const std::string &)

virtual bool	visible () const

virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	loads the element definition data for offset and art part More...

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 paused is set to true then it also just stops the particle system but leave previously created particles. More...

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. More...

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	hide (int context)
	Will call destroyModelAgents(), if, when the context is added, it is the first context in the list. More...

virtual bool	show (int context)
	Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero. More...

virtual bool	supportsShowHideContext (int) const
	Default returns true. More...

template<typename T , typename C >
void	connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity. More...

Protected Attributes
bool	myEffectEnabled

bool	myMoving

bool	myIsFrozen

DtParticleSystemModelAgent *	myParticleSystemAgent

bool	myParticleSystemStarted

bool	myTrailEffectPaused

Protected Attributes inherited from makVrv::DtEntityEffectStateVisualizer
DtTrailEffect *	myTrailEffect

DtVector	myOffset

int	myArtPart

Protected Attributes inherited from makVrv::DtEntityStateVisualizer
DtEntityStateListener *	myEntityListener
	Same as myListener, but casted for convenience. More...

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	myHasMouseCursor

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::signalslib::signal < void(DtStateVisualizer , DtStateVisualizer , DtStateVisualizer *)>	signal_reparented
	Signaled when the parent of this item changes, called before destroying any model agents. More...

boost::signalslib::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. More...

boost::signalslib::signal < void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseUp

boost::signalslib::signal < void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseDblClick

Detailed Description

Visualizer for entity trail state; draws trailing effects such as dust clouds or contrails behind entities.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEntityTrailEffectVisualizer::~DtEntityTrailEffectVisualizer ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtEntityTrailEffectVisualizer::setTrailEffectEnabled ( bool )

virtual

Set whether the trail effect is enabled.

virtual bool makVrv::DtEntityTrailEffectVisualizer::trailEffectEnabled ( ) const

virtual

Get whether the trail effect is enabled.

virtual void makVrv::DtEntityTrailEffectVisualizer::setTrailEffectPaused ( bool b )

virtual

If the trail is not paused it will create new particles.

If it is paused it will leave all old particles still there but stop any new ones from being created

virtual bool makVrv::DtEntityTrailEffectVisualizer::trailEffectPaused ( ) const

virtual

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

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

static

This class's type info.

virtual void makVrv::DtEntityTrailEffectVisualizer::createModelAgents ( )

protectedvirtual

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

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::destroyModelAgents ( )

protectedvirtual

deletes the model agents

Reimplemented from makVrv::DtEntityEffectStateVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::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::DtEntityTrailEffectVisualizer::setVelocity ( const DtVector32 & )

protectedvirtual

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

protectedvirtual

virtual void makVrv::DtEntityTrailEffectVisualizer::setIsFrozen ( bool frozen )

protectedvirtual

virtual void makVrv::DtEntityTrailEffectVisualizer::setEmbarkedOn ( const std::string & )

protectedvirtual

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

protectedvirtual

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

protectedvirtual

loads the element definition data for offset and art part

Reimplemented from makVrv::DtEntityEffectStateVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityTrailEffectVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::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 paused is set to true then it also just stops the particle system but leave previously created particles.

Member Data Documentation

bool makVrv::DtEntityTrailEffectVisualizer::myEffectEnabled

protected

bool makVrv::DtEntityTrailEffectVisualizer::myMoving

protected

bool makVrv::DtEntityTrailEffectVisualizer::myIsFrozen

protected

DtParticleSystemModelAgent* makVrv::DtEntityTrailEffectVisualizer::myParticleSystemAgent

protected

bool makVrv::DtEntityTrailEffectVisualizer::myParticleSystemStarted

protected

bool makVrv::DtEntityTrailEffectVisualizer::myTrailEffectPaused

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtEntityTrailEffectVisualizer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation