Visualizer for entity trailing effects, e.g. dust clouds or contrails. This class visualizes a particle system based on the following criteria:

Whether or not the entity is moving (velocity is non-zero)
If attributecontrolname and attributecomparevalue are defined in the visual definition, then the particle system is shown/hidden based on the value of a state attribute for an entity.

Inheritance diagram for makVrv::DtEntityTrailEffectVisualizer:

[legend]

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

	DtEntityTrailEffectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)

virtual	~DtEntityTrailEffectVisualizer ()

	DtEntityTrailEffectVisualizer ()=delete

	DtEntityTrailEffectVisualizer (const DtEntityTrailEffectVisualizer &)=delete

DtEntityTrailEffectVisualizer &	operator= (const DtEntityTrailEffectVisualizer &)=delete

virtual void	initialize () override

virtual void	setTrailEffectEnabled (bool)

virtual bool	trailEffectEnabled () const

virtual void	setTrailEffectPaused (bool b)

virtual bool	trailEffectPaused () const

virtual const DtStateVisualizer::TypeInfo &	typeInfo () const

Public Member Functions inherited from makVrv::DtEntityParticleSystemVisualizer
	DtEntityParticleSystemVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)

	DtEntityParticleSystemVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)

	~DtEntityParticleSystemVisualizer ()

	DtEntityParticleSystemVisualizer ()=delete

	DtEntityParticleSystemVisualizer (const DtEntityParticleSystemVisualizer &)=delete

DtEntityParticleSystemVisualizer &	operator= (const DtEntityParticleSystemVisualizer &)=delete

virtual void	setOffset (const DtVector &offset)

virtual void	setArtPart (int artPart)

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

	DtEntityStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)

virtual	~DtEntityStateVisualizer ()

virtual void	setState (int stateNumber, int stateValue)

DtEntityStateListener &	entityStateListener ()

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

	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObjectAgent, int modelSet)

virtual	~DtStateVisualizer ()

virtual DtObserverMode::ModelSets	modelSet ()

virtual void	setParent (DtStateVisualizer *)

virtual void	setSceneObjectAgent (DtSceneObjectAgent *sceneObject)

virtual const DtStateVisualizer *	parent () const

void	setModelDefinition (const std::string &definition)

const std::string &	modelDefinition () const

virtual void	implementVisibility (bool visible)

virtual void	slot_setSelected (bool b)

void	setName (const std::string &)

const std::string &	name () const

virtual void	setPickable (bool)

virtual bool	pickable () const

virtual void	setSceneObjectID (DtUniqueID id)

virtual DtUniqueID	sceneObjectID () const

int	visualizerType () const

virtual void	setVisualizerDefinition (const DtVisualizerDefinition &)

DtStateListener &	listener ()

const DtStateListener &	listener () const

DtBaseConnection &	simulation ()

void	setDistribute (bool b)

bool	distribute () const

virtual bool	setVisualizerIsVisible (bool vis, DtVisualizerShowHideContext::VisualizerShowHideContext context)

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()

Static Public Member Functions inherited from makVrv::DtEntityParticleSystemVisualizer
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()

Protected Member Functions
virtual void	createModelAgents ()

virtual void	destroyModelAgents ()

virtual void	setModelDefinitionForAgents ()

virtual void	setVelocity (const DtVector32 &)

virtual void	setRelativeVelocity (const DtVector32 &v)

virtual void	setEmbarkedOn (const std::string &)

virtual bool	visible () const

virtual void	setIsFrozen (bool isFrozen)

virtual void	connectToListenerSignals () override

virtual void	setInitialValuesFromVisualizerDefinition () override

virtual void	updateDrawState ()

virtual void	slot_wrmStateSet (int stateNumber, int stateValue)

Protected Member Functions inherited from makVrv::DtEntityParticleSystemVisualizer
virtual void	createParticleEffect ()

Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void	makeVisible ()

virtual bool	isVisible () const

template<typename T , typename C >
void	connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)

Protected Attributes
bool	myParticleSystemStarted

bool	myParticleSystemIsFrozen

bool	myEffectEnabled

bool	myMoving

bool	myTrailEffectPaused

DtModelSemanticsMapper::States::Id	myAttributeStateId

int	myAttributeCompareValue

Protected Attributes inherited from makVrv::DtEntityParticleSystemVisualizer
DtParticleSystemModelAgent *	myEffectAgent

DtVector	myOffset

int	myArtPart

bool	myIsFrozen

Protected Attributes inherited from makVrv::DtEntityStateVisualizer
DtEntityStateListener *	myEntityListener

Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection &	mySimulation

DtStateListener &	myListener

bool	myDistributeFlag

DtUniqueID	mySceneObjectID

std::string	myName

std::string	myModelDefinition

DtSignalConnectionManager	myConnections

int	myModelSet

int	myVisualizerType

bool	myPickable

bool	myVisible

const DtVisualizerDefinition *	myVisualizerDefinition

DtStateVisualizer *	myParent

DtSceneObjectAgent *	mySceneObjectAgent

bool	myInitialInitializeDone

ShowHideContextVector	myVisualizerShowHideContexts

Additional Inherited Members
Public Types inherited from makVrv::DtStateVisualizer
enum	Type { AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType, AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000 }

Public Attributes inherited from makVrv::DtStateVisualizer
boost::signalslib::signal < void(DtStateVisualizer , DtStateVisualizer , DtStateVisualizer *)>	signal_reparented

Protected Types inherited from makVrv::DtStateVisualizer
typedef std::vector < DtVisualizerShowHideContext::VisualizerShowHideContext >	ShowHideContextVector

Constructor & Destructor Documentation

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

CTOR.

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

CTOR.

virtual makVrv::DtEntityTrailEffectVisualizer::~DtEntityTrailEffectVisualizer ( )

virtual

DTOR.

makVrv::DtEntityTrailEffectVisualizer::DtEntityTrailEffectVisualizer ( )

delete

not allowed - default constructor

makVrv::DtEntityTrailEffectVisualizer::DtEntityTrailEffectVisualizer ( const DtEntityTrailEffectVisualizer & )

delete

not allowed - copy constructor

Member Function Documentation

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

delete

not allowed - equals operator

virtual void makVrv::DtEntityTrailEffectVisualizer::initialize ( )

overridevirtual

called soon after construction to initialize the signals/state from the listener

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

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

virtual

Set whether the trail effect is enabled. A trail effect that is not enabled is never visualized.

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.

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

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

static

This class's type info.

virtual void makVrv::DtEntityTrailEffectVisualizer::createModelAgents ( )

protectedvirtual

create the model agents for this visualizer

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::destroyModelAgents ( )

protectedvirtual

deletes the model agents

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

setup the model definition for the agents

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::setVelocity ( const DtVector32 & )

protectedvirtual

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

protectedvirtual

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

protectedvirtual

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

protectedvirtual

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

protectedvirtual

Whether or not the entity, that this particle system visualizer belongs to, is frozen.

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::connectToListenerSignals ( )

overrideprotectedvirtual

Connect the visualizer to the listeners signals Called by DtStateVisualizer::initialize()

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityTrailEffectVisualizer::setInitialValuesFromVisualizerDefinition ( )

overrideprotectedvirtual

Sets member variables from the visualizer definition if they exist Should not call this directly. Called by DtStateVisualizer::initialize.

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

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.

virtual void makVrv::DtEntityTrailEffectVisualizer::slot_wrmStateSet	(	int	stateNumber,
		int	stateValue
	)

protectedvirtual

handles changes to the wrm state from the DtEntityStateListener

Member Data Documentation

bool makVrv::DtEntityTrailEffectVisualizer::myParticleSystemStarted

protected

Flag indicating whether the particle system has been started or not.

bool makVrv::DtEntityTrailEffectVisualizer::myParticleSystemIsFrozen

protected

Flag indicating whether the particle system has been frozen or not.

bool makVrv::DtEntityTrailEffectVisualizer::myEffectEnabled

protected

Flag indicating whether the trail effect is enabled or not. If not enabled, the trail effect is never visualized.

bool makVrv::DtEntityTrailEffectVisualizer::myMoving

protected

Flag indicating whether the entity is moving or not. The trail effect is NOT visualized if the entity is NOT moving.

bool makVrv::DtEntityTrailEffectVisualizer::myTrailEffectPaused

protected

Flag indicating whether or not the trail effect should be visualized based on myAttributeStateId and myAttributeCompareValue, if set.

DtModelSemanticsMapper::States::Id makVrv::DtEntityTrailEffectVisualizer::myAttributeStateId

protected

int makVrv::DtEntityTrailEffectVisualizer::myAttributeCompareValue

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtEntityTrailEffectVisualizer.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