makVrv::DtEntityEffectStateVisualizer Class Reference

class provides general effect visualizer base class More...

Inheritance diagram for makVrv::DtEntityEffectStateVisualizer:

Public Member Functions
	DtEntityEffectStateVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...
virtual void	createParticleEffect ()
virtual void	destroyModelAgents ()
	deletes the model agents More...
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	loads the element definition data for offset and art part More...
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 void	createModelAgents ()=0
	Override to create model agents that will be used to display data from the listener. More...
virtual const TypeInfo &	typeInfo () const =0
	Get the type info. More...
virtual void	setParent (DtStateVisualizer *)
	Override to set the parent 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	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

Protected Attributes
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	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. More...
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. More...
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
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...
virtual void	setModelDefinitionForAgents ()=0
	Sets model definition for all the agents that this visualizer might be using. More...
template<typename T , typename C >
void	connectAndUpdate (boost::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity. More...

Detailed Description

class provides general effect visualizer base class

Constructor & Destructor Documentation

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

inline

CTOR.

Member Function Documentation

virtual void makVrv::DtEntityEffectStateVisualizer::createParticleEffect ( )

virtual

virtual void makVrv::DtEntityEffectStateVisualizer::destroyModelAgents ( )

virtual

deletes the model agents

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEntityTrailEffectVisualizer.

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

virtual

loads the element definition data for offset and art part

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtEntityTrailEffectVisualizer, makVrv::DtEntitySmokePlumeVisualizer, makVrv::DtEntityFlamesVisualizer, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityTrailEffectVisualizer.

virtual void makVrv::DtEntityEffectStateVisualizer::setOffset ( const DtVector &  offset )

virtual

offset for particle system

virtual void makVrv::DtEntityEffectStateVisualizer::setArtPart ( int  artPar )

virtual

artPart for particle system

Member Data Documentation

DtTrailEffect* makVrv::DtEntityEffectStateVisualizer::myTrailEffect

protected

DtVector makVrv::DtEntityEffectStateVisualizer::myOffset

protected

int makVrv::DtEntityEffectStateVisualizer::myArtPart

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvCore/DtEntityEffectStateVisualizer.h