makVrv::DtEntityDecalEffectVisualizer Class Reference

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

Inheritance diagram for makVrv::DtEntityDecalEffectVisualizer:

Public Member Functions
	DtEntityDecalEffectVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, DtModelSetId modelSet)
virtual	~DtEntityDecalEffectVisualizer ()
	DtEntityDecalEffectVisualizer ()=delete
	DtEntityDecalEffectVisualizer (const DtEntityDecalEffectVisualizer &)=delete
DtEntityDecalEffectVisualizer &	operator= (const DtEntityDecalEffectVisualizer &)=delete
virtual void	initialize () override
virtual void	setDecalEffectEnabled (bool b)
bool	decalEffectEnabled () const
virtual void	setDecalCreationPaused (bool b)
bool	decalCreationPaused () const
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
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 ()

Protected Member Functions
virtual void	createModelAgents ()
virtual void	destroyModelAgents ()
virtual void	setModelDefinitionForAgents ()
void	slot_embarkedStateChanged ()
virtual bool	visible () const
virtual void	connectToListenerSignals () override
virtual void	setInitialValuesFromVisualizerDefinition () override
virtual void	updateDrawState ()
virtual void	slot_wrmStateSet (int stateNumber, int value)
virtual void	toggleEffectByCompareValue (int compareValue)
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
DtDecalModelAgent *	myDecalEffectAgent
bool	myDecalCreationPaused
bool	myEffectEnabled
bool	myEmbarked
DtVector	myPosOffset
DtModelSemanticsMapper::States::Id	myAttributeStateId
std::vector< int >	myAttributeCompareValues
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::DtEntityDecalEffectVisualizer::DtEntityDecalEffectVisualizer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		DtSceneObjectAgent *	sceneObject,
		DtModelSetId	modelSet
	)

CTOR.

virtual makVrv::DtEntityDecalEffectVisualizer::~DtEntityDecalEffectVisualizer ( )

virtual

DTOR.

makVrv::DtEntityDecalEffectVisualizer::DtEntityDecalEffectVisualizer ( )

delete

not allowed - default constructor

makVrv::DtEntityDecalEffectVisualizer::DtEntityDecalEffectVisualizer ( const DtEntityDecalEffectVisualizer &  )

delete

not allowed - copy constructor

Member Function Documentation

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

delete

not allowed - equals operator

virtual void makVrv::DtEntityDecalEffectVisualizer::initialize ( )

overridevirtual

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

Reimplemented from makVrv::DtStateVisualizer.

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

No-op must override pure virtual.

Reimplemented from makVrv::DtEntityStateVisualizer.

virtual void makVrv::DtEntityDecalEffectVisualizer::destroyModelAgents ( )

protectedvirtual

No-op must override pure virtual.

Reimplemented from makVrv::DtEntityStateVisualizer.

virtual void makVrv::DtEntityDecalEffectVisualizer::setModelDefinitionForAgents ( )

protectedvirtual

No-op must override pure virtual.

Reimplemented from makVrv::DtEntityStateVisualizer.

void makVrv::DtEntityDecalEffectVisualizer::slot_embarkedStateChanged ( )

protected

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

protectedvirtual

virtual void makVrv::DtEntityDecalEffectVisualizer::connectToListenerSignals ( )

overrideprotectedvirtual

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

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityDecalEffectVisualizer::setInitialValuesFromVisualizerDefinition ( )

overrideprotectedvirtual

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

Reimplemented from makVrv::DtStateVisualizer.

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.

virtual void makVrv::DtEntityDecalEffectVisualizer::slot_wrmStateSet ( int  stateNumber, int  value  )

protectedvirtual

handles changes to the wrm state from the DtEntityStateListener

virtual void makVrv::DtEntityDecalEffectVisualizer::toggleEffectByCompareValue ( int  compareValue )

protectedvirtual

Toggle the effect based on the attribute compare value.

Member Data Documentation

DtDecalModelAgent* makVrv::DtEntityDecalEffectVisualizer::myDecalEffectAgent

protected

bool makVrv::DtEntityDecalEffectVisualizer::myDecalCreationPaused

protected

bool makVrv::DtEntityDecalEffectVisualizer::myEffectEnabled

protected

bool makVrv::DtEntityDecalEffectVisualizer::myEmbarked

protected

DtVector makVrv::DtEntityDecalEffectVisualizer::myPosOffset

protected

DtModelSemanticsMapper::States::Id makVrv::DtEntityDecalEffectVisualizer::myAttributeStateId

protected

std::vector<int> makVrv::DtEntityDecalEffectVisualizer::myAttributeCompareValues

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrvCore/DtEntityDecalEffectVisualizer.h