Protocol independent emitter volume visualizer.

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

Inheritance diagram for makVrv::DtEntityEmitterVolumeVisualizer:

Public Types
enum	ColoringMode { PulseFrequency, Frequency, Fixed }

Public Types inherited from makVrv::DtStateVisualizer
enum	Type { AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType, AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000 }

Public Member Functions
	DtEntityEmitterVolumeVisualizer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)

	DtEntityEmitterVolumeVisualizer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, int modelSet)

virtual	~DtEntityEmitterVolumeVisualizer ()

virtual void	createModelAgents ()

virtual void	destroyModelAgents ()

virtual void	setModelDefinitionForAgents ()

virtual void	setColoringMode (ColoringMode method)

virtual const ColoringMode	coloringMode () const

virtual const DtStateVisualizer::TypeInfo &	typeInfo () const

Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)

	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObjectAgent, int modelSet)

virtual	~DtStateVisualizer ()

virtual DtObserverMode::ModelSets	modelSet ()

virtual void	setParent (DtStateVisualizer *)

virtual void	setSceneObjectAgent (DtSceneObjectAgent *sceneObject)

virtual const DtStateVisualizer *	parent () const

void	setModelDefinition (const std::string &definition)

const std::string &	modelDefinition () const

virtual void	implementVisibility (bool visible)

virtual void	initialize ()

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 void	setSceneObjectID (DtUniqueID id)

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 DtEntityStateListener &	entityStateListener ()

virtual const DtEntityStateListener &	entityStateListener () const

virtual void	connectToListenerSignals () override

virtual DtModelAgent *	createBeamModel ()

virtual DtModelAgent *	newBeamModel (DtUniqueID &beamUniqueId)

virtual DtModelAgent *	findBeamModel (const DtUniqueID &beamModelId)

virtual bool	setBeamModelVisible (const DtUniqueID &beamModelId, bool visibility)

virtual void	destroyBeamModel (const DtUniqueID &beamModelId)

virtual void	destroyBeamModelInternal (const DtUniqueID &beamModelId)

virtual void	slot_entityEmitterVolumesVisibleChanged (bool visible, bool instanceOnly)

Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void	makeVisible ()

virtual bool	isVisible () const

virtual void	setInitialValuesFromVisualizerDefinition ()

template<typename T , typename C >
void	connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)

Protected Attributes
ColoringMode	myColoringMode

DtEntityStateListener *	myEntityStateListener

Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection &	mySimulation

DtStateListener &	myListener

bool	myDistributeFlag

DtUniqueID	mySceneObjectID

std::string	myName

std::string	myModelDefinition

DtSignalConnectionManager	myConnections

int	myModelSet

int	myVisualizerType

bool	myPickable

bool	myVisible

const DtVisualizerDefinition *	myVisualizerDefinition

DtStateVisualizer *	myParent

DtSceneObjectAgent *	mySceneObjectAgent

bool	myInitialInitializeDone

ShowHideContextVector	myVisualizerShowHideContexts

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

Private Attributes
BeamModelMap	myBeamModels

Additional Inherited Members
Public Attributes inherited from makVrv::DtStateVisualizer
boost::signalslib::signal < void(DtStateVisualizer , DtStateVisualizer , DtStateVisualizer *)>	signal_reparented

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

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

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

CTOR.

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 DtEntityStateListener& makVrv::DtEntityEmitterVolumeVisualizer::entityStateListener ( )

protectedvirtual

virtual const DtEntityStateListener& makVrv::DtEntityEmitterVolumeVisualizer::entityStateListener ( ) const

protectedvirtual

virtual void makVrv::DtEntityEmitterVolumeVisualizer::connectToListenerSignals ( )

overrideprotectedvirtual

Connect the visualizer to the listeners signals.

Reimplemented from makVrv::DtStateVisualizer.

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

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

protectedvirtual

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

virtual void makVrv::DtEntityEmitterVolumeVisualizer::slot_entityEmitterVolumesVisibleChanged	(	bool	visible,
		bool	instanceOnly
	)

protectedvirtual

Member Data Documentation

ColoringMode makVrv::DtEntityEmitterVolumeVisualizer::myColoringMode

protected

DtEntityStateListener* makVrv::DtEntityEmitterVolumeVisualizer::myEntityStateListener

protected

BeamModelMap makVrv::DtEntityEmitterVolumeVisualizer::myBeamModels

private

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-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

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation