Protocol independent sensor volume visualizer. More...

Inheritance diagram for makVrv::DtEntitySensorVolumeVisualizer:

Public Types
enum	ColoringMode { PulseFrequency, Frequency, Fixed }
	Enumeration of the coloring modes for coloring sensor volumes. More...
Public Member Functions
	DtEntitySensorVolumeVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR Instantiates a new sensor volume visualizer.
virtual	~DtEntitySensorVolumeVisualizer ()
	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 sensor volume Sets the mode to use for coloring the sensor volumes.
virtual const ColoringMode	coloringMode () const
	Gets the method used to color the sensor volume Gets the mode used for coloring the sensor volumes.
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	The instance's type info.
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 Attributes
ColoringMode	myColoringMode
Private Types
typedef boost::unordered_map < DtUniqueID, DtModelAgent * >	BeamModelMap
Private Attributes
BeamModelMap	myBeamModels

Detailed Description

Protocol independent sensor volume visualizer.

Member Typedef Documentation

typedef boost::unordered_map<DtUniqueID,DtModelAgent*> makVrv::DtEntitySensorVolumeVisualizer::BeamModelMap [private]

Member Enumeration Documentation

enum makVrv::DtEntitySensorVolumeVisualizer::ColoringMode

Enumeration of the coloring modes for coloring sensor volumes.

Enumerator:

PulseFrequency
Frequency
Fixed

Constructor & Destructor Documentation

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

CTOR Instantiates a new sensor 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::DtEntitySensorVolumeVisualizer::~DtEntitySensorVolumeVisualizer ( ) [virtual]

DTOR Cleans up the model agents associated with this visualizer.

Member Function Documentation

virtual void makVrv::DtEntitySensorVolumeVisualizer::createModelAgents ( ) [virtual]

(no-op)

See also:: DtStateVisualizer::createModelAgents()

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkEntitySensorVolumeVisualizer.

virtual void makVrv::DtEntitySensorVolumeVisualizer::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::DtVrlinkEntitySensorVolumeVisualizer.

virtual void makVrv::DtEntitySensorVolumeVisualizer::setModelDefinitionForAgents ( ) [virtual]

Sets the model definition on all instantiated beam model agents.

See also:: DtStateVisualizer::setModelDefinitionForAgents()

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntitySensorVolumeVisualizer::setColoringMode ( ColoringMode method ) [virtual]

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

Parameters:

mode	the coloring mode to use

See also:: makVrv::Dt2DEntitySensorVolumeVisualizer::ColoringMode

virtual const ColoringMode makVrv::DtEntitySensorVolumeVisualizer::coloringMode ( ) const [virtual]

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

Returns:: the ColoringMode used for coloring the sensor volumes

See also:: makVrv::Dt2DEntitySensorVolumeVisualizer::ColoringMode

virtual const DtStateVisualizer::TypeInfo& makVrv::DtEntitySensorVolumeVisualizer::typeInfo ( ) const [virtual]

The instance's type info.

Implements makVrv::DtStateVisualizer.

static const DtStateVisualizer::TypeInfo& makVrv::DtEntitySensorVolumeVisualizer::theTypeInfo ( ) [static]

This class's type info.

virtual DtModelAgent* makVrv::DtEntitySensorVolumeVisualizer::createBeamModel ( ) [protected, virtual]

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::DtEntitySensorVolumeVisualizer::newBeamModel ( DtUniqueID & beamUniqueId ) [protected, virtual]

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::Dt2DEntitySensorVolumeVisualizer::createBeamModel()

virtual DtModelAgent* makVrv::DtEntitySensorVolumeVisualizer::findBeamModel ( const DtUniqueID & beamModelId ) [protected, virtual]

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::DtEntitySensorVolumeVisualizer::setBeamModelVisible	(	const DtUniqueID &	beamModelId,
		bool	visibility
	)		`[protected, virtual]`

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::DtEntitySensorVolumeVisualizer::destroyBeamModel ( const DtUniqueID & beamModelId ) [protected, virtual]

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::DtEntitySensorVolumeVisualizer::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