Protocol independent emitter volume visualizer. More...

Inheritance diagram for makVrv::DtEntityEmitterVolumeVisualizer:

Public Types
enum	ColoringMode { PulseFrequency, Frequency, Fixed }
	Enumeration of the coloring modes for coloring emitter volumes. More...
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 Member Functions
	DtEntityEmitterVolumeVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR Instantiates a new emitter volume visualizer.
virtual	~DtEntityEmitterVolumeVisualizer ()
	DTOR Cleans up the model agents associated with this visualizer.
virtual void	createModelAgents ()
	(no-op)
virtual void	destroyModelAgents ()
	Detaches all beam model agents from the scene object agent and deletes them.
virtual void	setModelDefinitionForAgents ()
	Sets the model definition on all instantiated beam model agents.
virtual void	setColoringMode (ColoringMode method)
	Sets the method used to color the emitter volume Sets the mode to use for coloring the emitter volumes.
virtual const ColoringMode	coloringMode () const
	Gets the method used to color the emitter volume Gets the mode used for coloring the emitter volumes.
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR.
virtual	~DtStateVisualizer ()
	DTOR.
virtual void	setParent (DtStateVisualizer *)
	Override to set the parent of this visualizer.
void	setModelDefinition (const std::string &definition)
	Sets the model definition and creates agent(s) based on that definition.
const std::string &	modelDefinition () const
	Gets the current model definition.
virtual bool	setVisible (bool visible, int context)
	Returns true if this context wants to show or hide the item.
virtual void	initialize ()
	Initialize the visualizer.
virtual bool	isVisible () const
	Returns true if visible.
virtual void	setSelected (bool)
	Sets selected state.
virtual bool	selected () const
void	setName (const std::string &)
	Internal name of state visualizer.
const std::string &	name () const
virtual void	setPickable (bool)
	Sets pickable state.
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.
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &)
	Set any other additional visualizer information from the visual record.
DtStateListener &	listener ()
DtBaseConnection &	simulation ()
	Get the connection for this visualizer.
void	setDistribute (bool b)
	Whether or not to distribute over the network.
bool	distribute () const

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

Protected Member Functions
virtual DtModelAgent *	createBeamModel ()
	Creates a new beam model agent Instantiates a DtOverlayEllipseArcModelAgent that will be used for visualizing a beam Extending classes should override this method to use a different beam model.
virtual DtModelAgent *	newBeamModel (DtUniqueID &beamUniqueId)
	Creates a beam model and stores the new model's unique id in beamUniqueId Creates a new model agent for visualizing the beam.
virtual DtModelAgent *	findBeamModel (const DtUniqueID &beamModelId)
	Beam model accessor Gets the beam model with the given beamModelId.
virtual bool	setBeamModelVisible (const DtUniqueID &beamModelId, bool visibility)
	Shows or hides the given beam model This method will return false if an invalid beam model is passed to the method or if mySceneObjectAgent has not yet been initialized.
virtual void	destroyBeamModel (const DtUniqueID &beamModelId)
	Destroys the beam model with the given id Removes the indicated beam model from the scene, deletes it, and removes it from the local beam model listing.
void	destroyBeamModelInternal (const DtUniqueID &beamModelId)
	Nonvirtual work function to destroy the beam model with the given id Removes the indicated beam model from the scene, deletes it, and removes it from the local beam model listing.
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.
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.
virtual bool	show (int context)
	Will call createModelAgents(), if, when context is removed from myShowHideContexts, the list size is zero.
virtual bool	supportsShowHideContext (int) const
	Default returns true.
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.

Protected Attributes
ColoringMode	myColoringMode
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

Private Types
typedef boost::unordered_map < DtUniqueID, DtModelAgent * >	BeamModelMap

Private Attributes
BeamModelMap	myBeamModels

Additional Inherited Members
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.
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.
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

Detailed Description

Protocol independent emitter volume visualizer.

Note: Formerly named DtEntitySensorVolumeVisualizer, yet is still initialized via a DtEntitySensorVolumeSchema for backward compatibility.

Member Typedef Documentation

typedef boost::unordered_map<DtUniqueID,DtModelAgent*> makVrv::DtEntityEmitterVolumeVisualizer::BeamModelMap

private

Member Enumeration Documentation

enum makVrv::DtEntityEmitterVolumeVisualizer::ColoringMode

Enumeration of the coloring modes for coloring emitter volumes.

Enumerator:

PulseFrequency
Frequency
Fixed

Constructor & Destructor Documentation

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

CTOR Instantiates a new emitter volume visualizer.

Parameters

simulation	the DtBaseConnection this visualizer will use
listener	the DtEntityStateListener for this visualizer's entity
modelSet	the model set this visualizer belongs to

virtual makVrv::DtEntityEmitterVolumeVisualizer::~DtEntityEmitterVolumeVisualizer ( )

virtual

DTOR Cleans up the model agents associated with this visualizer.

Member Function Documentation

virtual void makVrv::DtEntityEmitterVolumeVisualizer::createModelAgents ( )

virtual

(no-op)

See Also: DtStateVisualizer::createModelAgents()

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityEmitterVolumeVisualizer.

virtual void makVrv::DtEntityEmitterVolumeVisualizer::destroyModelAgents ( )

virtual

Detaches all beam model agents from the scene object agent and deletes them.

See Also: makVrv::DtStateVisualizer::destroyModelAgents()

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntityEmitterVolumeVisualizer.

virtual void makVrv::DtEntityEmitterVolumeVisualizer::setModelDefinitionForAgents ( )

virtual

Sets the model definition on all instantiated beam model agents.

See Also: DtStateVisualizer::setModelDefinitionForAgents()

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityEmitterVolumeVisualizer::setColoringMode ( ColoringMode method )

virtual

Sets the method used to color the emitter volume Sets the mode to use for coloring the emitter volumes.

Parameters

mode	the coloring mode to use

See Also: makVrv::Dt2DEntityEmitterVolumeVisualizer::ColoringMode

virtual const ColoringMode makVrv::DtEntityEmitterVolumeVisualizer::coloringMode ( ) const

virtual

Gets the method used to color the emitter volume Gets the mode used for coloring the emitter volumes.

Returns: the ColoringMode used for coloring the emitter volumes

See Also: makVrv::Dt2DEntityEmitterVolumeVisualizer::ColoringMode

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

virtual

The instance's type info.

Implements makVrv::DtStateVisualizer.

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

static

This class's type info.

virtual DtModelAgent* makVrv::DtEntityEmitterVolumeVisualizer::createBeamModel ( )

protectedvirtual

Creates a new beam model agent Instantiates a DtOverlayEllipseArcModelAgent that will be used for visualizing a beam Extending classes should override this method to use a different beam model.

Returns: the newly created beam model

virtual DtModelAgent* makVrv::DtEntityEmitterVolumeVisualizer::newBeamModel ( DtUniqueID & beamUniqueId )

protectedvirtual

Creates a beam model and stores the new model's unique id in beamUniqueId Creates a new model agent for visualizing the beam.

Parameters

beamUniqueId reference to a DtUniqueID object where the new model's ID will be stored upon creation

Returns: the newly created beam model

See Also: makVrv::Dt2DEntityEmitterVolumeVisualizer::createBeamModel()

virtual DtModelAgent* makVrv::DtEntityEmitterVolumeVisualizer::findBeamModel ( const DtUniqueID & beamModelId )

protectedvirtual

Beam model accessor Gets the beam model with the given beamModelId.

Parameters

beamModelId the unique beam model ID

Returns: the beam model with the given ID, or NULL if there isn't one.

virtual bool makVrv::DtEntityEmitterVolumeVisualizer::setBeamModelVisible	(	const DtUniqueID &	beamModelId,
		bool	visibility
	)

protectedvirtual

Shows or hides the given beam model This method will return false if an invalid beam model is passed to the method or if mySceneObjectAgent has not yet been initialized.

Parameters

beamModelId	the unique beam model ID
visibility	whether to show or hide the beam model

Returns: true if the beam model was shown or hidden, false otherwise

virtual void makVrv::DtEntityEmitterVolumeVisualizer::destroyBeamModel ( const DtUniqueID & beamModelId )

protectedvirtual

Destroys the beam model with the given id Removes the indicated beam model from the scene, deletes it, and removes it from the local beam model listing.

Parameters

beamModelId the unique ID of the beam model to destroy

void makVrv::DtEntityEmitterVolumeVisualizer::destroyBeamModelInternal ( const DtUniqueID & beamModelId )

protected

Nonvirtual work function to destroy the beam model with the given id Removes the indicated beam model from the scene, deletes it, and removes it from the local beam model listing.

Parameters

beamModelId the unique ID of the beam model to destroy

Member Data Documentation

ColoringMode makVrv::DtEntityEmitterVolumeVisualizer::myColoringMode

protected

BeamModelMap makVrv::DtEntityEmitterVolumeVisualizer::myBeamModels

private

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrvCore/DtEntityEmitterVolumeVisualizer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation