makVrv::DtEntityAudializer Class Reference

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.

Inheritance diagram for makVrv::DtEntityAudializer:

Public Member Functions
	DtEntityAudializer (DtBaseConnection &simulation, DtStateListener &listener, DtSceneObjectAgent *sceneObject, DtModelSetId modelSet)
virtual	~DtEntityAudializer ()
	DtEntityAudializer ()=delete
	DtEntityAudializer (const DtEntityAudializer &)=delete
DtEntityAudializer &	operator= (const DtEntityAudializer &)=delete
virtual void	initialize () override
virtual void	createModelAgents ()
virtual void	destroyModelAgents ()
virtual const DtStateVisualizer::TypeInfo &	typeInfo () const
virtual void	setModelDefinitionForAgents ()
virtual void	setPowerPlantOn (bool on)
virtual void	setDamageState (EntityStateListener::DamageState damageState)
virtual bool	destroyed () const
virtual void	setEngineRunning (bool running)
virtual void	play ()
virtual void	stop ()
virtual void	setIs3d (bool is3d)
virtual bool	is3d ()
virtual void	setDecibel (float decibel)
virtual float	decibel ()
DtEntityStateListener &	entityStateListener ()
const DtEntityStateListener &	entityStateListener () const
Public Member Functions inherited from makVrv::DtStateVisualizer
	DtStateVisualizer (DtBaseConnection &connection, DtStateListener &listener, DtSceneObjectAgent *sceneObjectAgent, DtModelSetId modelSet)
virtual	~DtStateVisualizer ()
virtual DtModelSetId	modelSet ()
virtual void	setSceneObjectAgent (DtSceneObjectAgent *sceneObject)
void	setModelDefinition (const std::string &definition)
const std::string &	modelDefinition () const
virtual void	implementVisibility (bool visible)
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 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	isVisible () const
virtual bool	setVisualizerIsVisible (bool vis, DtVisualizerShowHideContext::VisualizerShowHideContext context)

Static Public Member Functions
static const DtStateVisualizer::TypeInfo &	theTypeInfo ()

Protected Member Functions
virtual void	setInitialValuesFromVisualizerDefinition () override
virtual void	connectToListenerSignals () override
Protected Member Functions inherited from makVrv::DtStateVisualizer
virtual void	makeVisible ()
template<typename T , typename C >
void	connectAndUpdate (boost::signalslib::signal< void(T)> &sig, void(C::*fp)(T), T val)

Protected Attributes
DtSoundModelAgent *	mySoundModelAgent
DtEntitySoundUpdaterAgent *	myEntitySoundUpdaterAgent
bool	myIs3d
float	myDecibel
EntityStateListener::DamageState	myDamageState
bool	myPowerPlantOn
DtEntityStateListener *	myEntityListener
Protected Attributes inherited from makVrv::DtStateVisualizer
DtBaseConnection &	mySimulation
DtStateListener &	myListener
bool	myDistributeFlag
DtUniqueID	mySceneObjectID
std::string	myName
std::string	myModelDefinition
DtSignalConnectionManager	myConnections
DtModelSetId	myModelSet
int	myVisualizerType
bool	myPickable
bool	myVisible
const DtVisualizerDefinition *	myVisualizerDefinition
DtSceneObjectAgent *	mySceneObjectAgent
bool	myInitialInitializeDone
ShowHideContextVector	myVisualizerShowHideContexts

Additional Inherited Members
Public Types inherited from makVrv::DtStateVisualizer
enum	Type {   AllVisualizerTypes = 0, EntityVisualizerType = 1, EnvironmentalVisualizerType, InteractionVisualizerType,   AggregateVisualizerType, IntervisibilityVisualizerType, TacticalSmokeVisualizerType, UserType = 10000 }
Protected Types inherited from makVrv::DtStateVisualizer
typedef std::vector < DtVisualizerShowHideContext::VisualizerShowHideContext >	ShowHideContextVector

Constructor & Destructor Documentation

makVrv::DtEntityAudializer::DtEntityAudializer	(	DtBaseConnection &	simulation,
		DtStateListener &	listener,
		DtSceneObjectAgent *	sceneObject,
		DtModelSetId	modelSet
	)

CTOR.

virtual makVrv::DtEntityAudializer::~DtEntityAudializer ( )

virtual

DTOR.

makVrv::DtEntityAudializer::DtEntityAudializer ( )

delete

not allowed - default constructor

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

delete

not allowed - copy constructor

Member Function Documentation

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

delete

not allowed - equals operator

virtual void makVrv::DtEntityAudializer::initialize ( )

overridevirtual

called soon after construction to initialize the signals/state from the listener

Reimplemented from makVrv::DtStateVisualizer.

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::setPowerPlantOn ( bool  on )

virtual

Gets whether the powerplant of the entity is on. It will only sound when the powerplant is on and the entity is not desctoryed.

virtual void makVrv::DtEntityAudializer::setDamageState ( EntityStateListener::DamageState  damageState )

virtual

Sets the damage state for the entity.

virtual bool makVrv::DtEntityAudializer::destroyed ( ) const

virtual

Gets whether the entity is destroyed. It will stop playing sound if it's destroyed.

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

virtual

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.

DtEntityStateListener& makVrv::DtEntityAudializer::entityStateListener

(

)

Get the entity state listener.

const DtEntityStateListener& makVrv::DtEntityAudializer::entityStateListener

(

)

const

virtual void makVrv::DtEntityAudializer::setInitialValuesFromVisualizerDefinition ( )

overrideprotectedvirtual

Sets member variables from the visualizer definition if they exist Should not call this directly. Called by DtStateVisualizer::initialize.

Reimplemented from makVrv::DtStateVisualizer.

virtual void makVrv::DtEntityAudializer::connectToListenerSignals ( )

overrideprotectedvirtual

Connect the visualizer to the listeners signals Called by DtStateVisualizer::initialize()

Reimplemented from makVrv::DtStateVisualizer.

Member Data Documentation

DtSoundModelAgent* makVrv::DtEntityAudializer::mySoundModelAgent

protected

DtEntitySoundUpdaterAgent* makVrv::DtEntityAudializer::myEntitySoundUpdaterAgent

protected

bool makVrv::DtEntityAudializer::myIs3d

protected

float makVrv::DtEntityAudializer::myDecibel

protected

EntityStateListener::DamageState makVrv::DtEntityAudializer::myDamageState

protected

bool makVrv::DtEntityAudializer::myPowerPlantOn

protected

DtEntityStateListener* makVrv::DtEntityAudializer::myEntityListener

protected

Same as myListener, but casted for convenience.

---

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

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