makVrv::DtEntityAudializer Class Reference

DtEntityAudializer manages the sound for an entity. More...

Inheritance diagram for makVrv::DtEntityAudializer:

Public Member Functions
	DtEntityAudializer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...
virtual	~DtEntityAudializer ()
	DTOR. More...
virtual void	createModelAgents ()
	Override to create model agents that will be used to display data from the listener. More...
virtual void	destroyModelAgents ()
	Destroys all currently created definitions. More...
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
	Get the type info. More...
virtual void	setModelDefinitionForAgents ()
	Sets the model definition of the audializer. More...
virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	process the visual definition record More...
virtual void	setEngineRunning (bool running)
	Sets whether the engine is running. More...
virtual void	play ()
	Plays the sound. More...
virtual void	stop ()
	brief Stops the sound. More...
virtual void	setIs3d (bool is3d)
	Sets whether the sound should be played in 3d. More...
virtual bool	is3d ()
	Gets whether the sound should be played in 3d. More...
virtual void	setDecibel (float decibel)
	Sets the decibel of the sound. More...
virtual float	decibel ()
	Gets the decibel of the sound. More...
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, int modelSet)
	CTOR. More...
virtual	~DtStateVisualizer ()
	DTOR. More...
virtual DtObserverMode::ModelSets	modelSet ()
	Return the visualizer's model set enum. More...
virtual void	setParent (DtStateVisualizer *)
	Override to set the parent of this visualizer. More...
virtual const DtStateVisualizer *	parent () const
	Get a const pointer to the parent visualizer 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	setHasMouseCursor (bool)
	Sets the mouse hover state. More...
virtual bool	hasMouseCursor () const
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

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

Protected Attributes
DtSoundModelAgent *	mySoundModelAgent
DtEntitySoundUpdaterAgent *	myEntitySoundUpdaterAgent
bool	myIs3d
float	myDecibel
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	myHasMouseCursor
bool	myPickable
bool	myVisible
DtStateVisualizer *	myParent
DtSceneObjectAgent *	mySceneObjectAgent

Private Member Functions
	DtEntityAudializer ()
	Default Constructor not implemented – default constructor not allowed. More...
	DtEntityAudializer (const DtEntityAudializer &)
	Copy Constructor not implemented – Copy not allowed. More...
DtEntityAudializer &	operator= (const DtEntityAudializer &)
	Assignment Operator not implemented – Copy not allowed. More...

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::signalslib::signal < void(DtStateVisualizer *, DtStateVisualizer *, DtStateVisualizer *)>	signal_reparented
	Signaled when the parent of this item changes, called before destroying any model agents. More...
boost::signalslib::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::signalslib::signal < void(DtMouseState &, const DtUniqueID &, const std::string &, const std::string &, const std::string &, DtStateVisualizer *)>	signal_mouseUp
boost::signalslib::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...
template<typename T , typename C >
void	connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity. More...

Detailed Description

DtEntityAudializer manages the sound for an entity.

The sound will update itself according to the entity's state. It points to a sound model definition, you can configure the filename, decibel,etc.

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtEntityAudializer::~DtEntityAudializer ( )

virtual

DTOR.

makVrv::DtEntityAudializer::DtEntityAudializer ( )

private

Default Constructor not implemented – default constructor not allowed.

makVrv::DtEntityAudializer::DtEntityAudializer ( const DtEntityAudializer &  )

private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

virtual void makVrv::DtEntityAudializer::createModelAgents ( )

virtual

Override to create model agents that will be used to display data from the listener.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityAudializer::destroyModelAgents ( )

virtual

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

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

virtual

Get the type info.

Typically the implementation of this function should call a static function called theTypeInfo.

Implements makVrv::DtStateVisualizer.

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

static

This class's type info.

virtual void makVrv::DtEntityAudializer::setModelDefinitionForAgents ( )

virtual

Sets the model definition of the audializer.

Implements makVrv::DtStateVisualizer.

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

virtual

process the visual definition record

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityAudializer::setEngineRunning ( bool  running )

virtual

Sets whether the engine is running.

virtual void makVrv::DtEntityAudializer::play ( )

virtual

Plays the sound.

virtual void makVrv::DtEntityAudializer::stop ( )

virtual

brief Stops the sound.

virtual void makVrv::DtEntityAudializer::setIs3d ( bool  is3d )

virtual

Sets whether the sound should be played in 3d.

virtual bool makVrv::DtEntityAudializer::is3d ( )

virtual

Gets whether the sound should be played in 3d.

virtual void makVrv::DtEntityAudializer::setDecibel ( float  decibel )

virtual

Sets the decibel of the sound.

virtual float makVrv::DtEntityAudializer::decibel ( )

virtual

Gets the decibel of the sound.

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

private

Assignment Operator not implemented – Copy not allowed.

Member Data Documentation

DtSoundModelAgent* makVrv::DtEntityAudializer::mySoundModelAgent

protected

DtEntitySoundUpdaterAgent* makVrv::DtEntityAudializer::myEntitySoundUpdaterAgent

protected

bool makVrv::DtEntityAudializer::myIs3d

protected

float makVrv::DtEntityAudializer::myDecibel

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvAudio/DtEntityAudializer.h