DtInteractionAudializer manages the sound for an interaction. More...

Inheritance diagram for makVrv::DtInteractionAudializer:

Public Member Functions
	DtInteractionAudializer (DtBaseConnection &simulation, DtStateListener &listener, int modelSet)
	CTOR. More...

virtual	~DtInteractionAudializer ()
	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 void	setModelDefinitionForAgents ()
	Sets the model definition for the agent. More...

virtual void	setVisualizerDefinition (const DtVisualizerDefinition &visDef)
	process the visual definition record More...

virtual void	setInteractionLocation (DtVector location)
	Sets the local location of the interaction. More...

virtual DtVector	interactionLocation ()
	Gets the local location of the interaction. More...

virtual void	setDecibel (float decibel)
	Sets the decibel of the sound. More...

virtual float	decibel ()
	Gets the decibel of the sound. More...

virtual void	setDeleteDelay (float delay)
	Sets the deletion delay of the interacion sound in seconds, default is 60 seconds. More...

virtual float	deleteDelay ()
	Gets the deletion delay of the interacion sound in seconds, default is 60 seconds. More...

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

virtual	~DtStateVisualizer ()
	DTOR. More...

virtual const TypeInfo &	typeInfo () const =0
	Get the type info. More...

virtual void	setParent (DtStateVisualizer *)
	Override to set the parent 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	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

Protected Attributes
DtSoundModelAgent *	mySoundModelAgent

float	myDecibel

DtVector	myInteractionLocation

float	myDeleteDelay

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 Member Functions
	DtInteractionAudializer ()
	Default Constructor not implemented � default constructor not allowed. More...

	DtInteractionAudializer (const DtInteractionAudializer &)
	Copy Constructor not implemented � Copy not allowed. More...

DtInteractionAudializer &	operator= (const DtInteractionAudializer &)
	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::signal< void(DtStateVisualizer , DtStateVisualizer , DtStateVisualizer *)>	signal_reparented
	Signaled when the parent of this item changes, called before destroying any model agents. More...

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. More...

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

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::signal< void(T)> &sig, void(C::*fp)(T), T val)
	Connect a signal and update the entity. More...

Detailed Description

DtInteractionAudializer manages the sound for an interaction.

The sound will only play one time, it has delay due to the doppler effect. It points to a sound model definition, you can configure the filename, decibel,etc. It's the base class for DtFireInteractionAudializer and DtDetonationAudializer. You cannot create an instance of this class(typeInfo not implemented).

Constructor & Destructor Documentation

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

CTOR.

virtual makVrv::DtInteractionAudializer::~DtInteractionAudializer ( )

virtual

DTOR.

makVrv::DtInteractionAudializer::DtInteractionAudializer ( )

private

Default Constructor not implemented � default constructor not allowed.

makVrv::DtInteractionAudializer::DtInteractionAudializer ( const DtInteractionAudializer & )

private

Copy Constructor not implemented � Copy not allowed.

Member Function Documentation

virtual void makVrv::DtInteractionAudializer::createModelAgents ( )

virtual

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

Implements makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtDetonationAudializer.

virtual void makVrv::DtInteractionAudializer::destroyModelAgents ( )

virtual

Destroys all currently created definitions.

Implements makVrv::DtStateVisualizer.

virtual void makVrv::DtInteractionAudializer::setModelDefinitionForAgents ( )

virtual

Sets the model definition for the agent.

Implements makVrv::DtStateVisualizer.

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

virtual

process the visual definition record

Reimplemented from makVrv::DtStateVisualizer.

Reimplemented in makVrv::DtDetonationAudializer.

virtual void makVrv::DtInteractionAudializer::setInteractionLocation ( DtVector location )

virtual

Sets the local location of the interaction.

virtual DtVector makVrv::DtInteractionAudializer::interactionLocation ( )

virtual

Gets the local location of the interaction.

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

virtual

Sets the decibel of the sound.

virtual float makVrv::DtInteractionAudializer::decibel ( )

virtual

Gets the decibel of the sound.

virtual void makVrv::DtInteractionAudializer::setDeleteDelay ( float delay )

virtual

Sets the deletion delay of the interacion sound in seconds, default is 60 seconds.

This will allow a sound to be heard up to ~12 miles away. It's used to handle the deletion of the agent class. Increase this if you want to hear the sound further away.

virtual float makVrv::DtInteractionAudializer::deleteDelay ( )

virtual

Gets the deletion delay of the interacion sound in seconds, default is 60 seconds.

This will allow a sound to be heard up to ~12 miles away. It's used to handle the deletion of the agent class. Increase this if you want to hear the sound further away.

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

private

Assignment Operator not implemented � Copy not allowed.

Member Data Documentation

DtSoundModelAgent* makVrv::DtInteractionAudializer::mySoundModelAgent

protected

float makVrv::DtInteractionAudializer::myDecibel

protected

DtVector makVrv::DtInteractionAudializer::myInteractionLocation

protected

float makVrv::DtInteractionAudializer::myDeleteDelay

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrvAudio/DtInteractionAudializer.h

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation