Visualizer for conditional particle systems. A conditional particle system is one that is visualized if some defined criteria is met.

The criteria can consist of one or more of the following conditions: 1) Visualize the particle system based on whether or not the entity is moving, i.e. velocity is non-zero (see isMoving). 2) Visualize the particle system based on whether some state attribute matches some value (see attributecontrolname and attributecomparevalue).

Inheritance diagram for makVrv::DtEntityConditionalParticleSystemVisualizer:

[legend]

Public Member Functions
	DtEntityConditionalParticleSystemVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, DtModelSetId modelSet)

virtual	~DtEntityConditionalParticleSystemVisualizer ()

	DtEntityConditionalParticleSystemVisualizer ()=delete

	DtEntityConditionalParticleSystemVisualizer (const DtEntityConditionalParticleSystemVisualizer &)=delete

DtEntityConditionalParticleSystemVisualizer &	operator= (const DtEntityConditionalParticleSystemVisualizer &)=delete

virtual void	initialize () override

virtual void	setIsEnabled (bool)

virtual bool	isEnabled () const

virtual const DtStateVisualizer::TypeInfo &	typeInfo () const

Public Member Functions inherited from makVrv::DtEntityParticleSystemVisualizer
	DtEntityParticleSystemVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, DtModelSetId 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, DtSceneObjectAgent *sceneObject, DtModelSetId modelSet)

virtual	~DtEntityStateVisualizer ()

virtual void	setState (int stateNumber, int stateValue)

DtEntityStateListener &	entityStateListener ()

Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObjectAgent, DtModelSetId modelSet)

virtual	~DtStateVisualizer ()

virtual DtModelSetId	modelSet ()

virtual void	setSceneObjectAgent (DtSceneObjectAgent *sceneObject)

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 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 &velocity)

virtual void	setRelativeVelocity (const DtVector32 &v)

virtual void	slot_embarkedStateChanged ()

virtual bool	visible () const

virtual bool	visualizationCriteriaIsMet () 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

DtVisualizationCriteria	myVisualizationCriteria

bool	myIsMoving

bool	myDoesStateAttributeValueMatch

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

DtModelSetId	myModelSet

int	myVisualizerType

bool	myPickable

bool	myVisible

const DtVisualizerDefinition *	myVisualizerDefinition

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 }

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

Constructor & Destructor Documentation

makVrv::DtEntityConditionalParticleSystemVisualizer::DtEntityConditionalParticleSystemVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		DtSceneObjectAgent *	sceneObject,
		DtModelSetId	modelSet
	)

CTOR.

virtual makVrv::DtEntityConditionalParticleSystemVisualizer::~DtEntityConditionalParticleSystemVisualizer ( )

virtual

DTOR.

makVrv::DtEntityConditionalParticleSystemVisualizer::DtEntityConditionalParticleSystemVisualizer ( )

delete

not allowed - default constructor

makVrv::DtEntityConditionalParticleSystemVisualizer::DtEntityConditionalParticleSystemVisualizer ( const DtEntityConditionalParticleSystemVisualizer & )

delete

not allowed - copy constructor

Member Function Documentation

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

delete

not allowed - equals operator

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::initialize ( )

overridevirtual

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

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::setIsEnabled ( bool )

virtual

Set whether the visualizer is enabled. If false, then this visualizer won't visualize anything. Default is true.

virtual bool makVrv::DtEntityConditionalParticleSystemVisualizer::isEnabled ( ) const

virtual

Get whether the visualizer is enabled.

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

virtual

The instance's type info.

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

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

static

This class's type info.

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::createModelAgents ( )

protectedvirtual

create the model agents for this visualizer

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::destroyModelAgents ( )

protectedvirtual

deletes the model agents

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

setup the model definition for the agents

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::setVelocity ( const DtVector32 & velocity )

protectedvirtual

Set the velocity used to determine if the entity is moving or not. If the magnitude of the passed in velocity is 0, then the entity is considered to be not moving. This information is needed if the criteria for this visualizer considers entity movement.

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

protectedvirtual

Set the relative velocity used to determine if the entity is moving or not. If the magnitude of the passed in velocity is 0, then the entity is considered to be not moving. This information is needed if the criteria for this visualizer considers entity movement. The entity must be embarked for this function to be used - if the entity is not embarked, this function does nothing.

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::slot_embarkedStateChanged ( )

protectedvirtual

Slot function for DtEntityStateListener::signal_parentSet. Updates whether velocity or relative velocity is used when determining if the entity is moving. If embarked, then relative velocity is used. If not embarked, then the entity's local velocity is used. This information is needed if the criteria for this visualizer considers entity movement.

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

protectedvirtual

virtual bool makVrv::DtEntityConditionalParticleSystemVisualizer::visualizationCriteriaIsMet ( ) const

protectedvirtual

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::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::DtEntityConditionalParticleSystemVisualizer::connectToListenerSignals ( )

overrideprotectedvirtual

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

Reimplemented from makVrv::DtEntityParticleSystemVisualizer.

virtual void makVrv::DtEntityConditionalParticleSystemVisualizer::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::DtEntityConditionalParticleSystemVisualizer::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::DtEntityConditionalParticleSystemVisualizer::slot_wrmStateSet	(	int	stateNumber,
		int	stateValue
	)

protectedvirtual

Slot function for DtEntityStateListener::signal_wrmStateSet. handles changes to the wrm state from the DtEntityStateListener.

Member Data Documentation

bool makVrv::DtEntityConditionalParticleSystemVisualizer::myParticleSystemStarted

protected

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

bool makVrv::DtEntityConditionalParticleSystemVisualizer::myParticleSystemIsFrozen

protected

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

bool makVrv::DtEntityConditionalParticleSystemVisualizer::myEffectEnabled

protected

Flag indicating whether the visualizer is enabled or not. If not enabled, no particle systems are visualized.

DtVisualizationCriteria makVrv::DtEntityConditionalParticleSystemVisualizer::myVisualizationCriteria

protected

Contains the criteria which must be met in order to visualize the particle system.

bool makVrv::DtEntityConditionalParticleSystemVisualizer::myIsMoving

protected

Flag indicating whether the entity is moving or not. Used for the DtVisualizationCriteria::myIsMovementRequired condition.

bool makVrv::DtEntityConditionalParticleSystemVisualizer::myDoesStateAttributeValueMatch

protected

Flag indicating whether the state attribute matches the value we care about. Used for the DtVisualizationCriteria::myIsStateValueRequired condition.

DtModelSemanticsMapper::States::Id makVrv::DtEntityConditionalParticleSystemVisualizer::myAttributeStateId

protected

The id for the state attribute whose value will be matched against. Used for the DtVisualizationCriteria::myIsStateValueRequired condition.

int makVrv::DtEntityConditionalParticleSystemVisualizer::myAttributeCompareValue

protected

The value that will be matched against the state attribute's value. Used for the DtVisualizationCriteria::myIsStateValueRequired condition.

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

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