makVrv::DtNetSoundPlayer Class Reference

Instances of DtNetSoundPlayer add a vrlink connection. More...

Inheritance diagram for makVrv::DtNetSoundPlayer:

Public Member Functions
	DtNetSoundPlayer (DtExerciseConn *exConn)
	Initialization CTOR.
virtual	~DtNetSoundPlayer ()
	Virtual DTOR.
virtual void	tick (DtConstVector viewPosition, DtConstVector viewVelocity, const DtTaitBryan &viewAngle)
	Overridden tick(..) Each call to tick updates the listener's position and orientation and manages starting, stopping and cleanup of sounds each frame.
void	setExerciseConn (DtExerciseConn *exConn)
	Set a new exercise connection.
void	registerSignalCallbacks ()
	Register a signal interaction callback with the exercise connection.
void	unregisterSignalCallbacks ()
	Unregister the signal interaction callback from the exercise connection.
virtual void	setProcessSignalInteractions (bool)
	Change setting to process signal callbacks.
virtual bool	processSignalInteractions () const
	Get the current setting to process signal callbacks.

Protected Member Functions
virtual bool	addBufferSource (DtBufferSource *bs)
	Add a buffer source to the signal list.

Static Protected Member Functions
static void	signalInteractionCb (DtSignalInteraction *sound, void *caller)
	Called on a signaled interaction.
static int	processEncodingType (DtSignalInteraction *sound)
	Translate the OpenAL encoding type based on the signal interaction encoding type.
static bool	canProcessEncodingClass (DtSignalInteraction *sound)
	Check for a valid encoding class.

Protected Attributes
DtExerciseConn *	myExConn
bool	myProcessSignalInteractions

Static Protected Attributes
static DtList *	mySignalList

Private Member Functions
	DtNetSoundPlayer (const DtNetSoundPlayer &orig)
	Copy CTOR.
DtNetSoundPlayer &	operator= (const DtNetSoundPlayer &orig)
	Assignment operator.

Detailed Description

Instances of DtNetSoundPlayer add a vrlink connection.

Constructor & Destructor Documentation

makVrv::DtNetSoundPlayer::DtNetSoundPlayer

(

DtExerciseConn *

exConn

)

Initialization CTOR.

Parameters

[in]

exConn

is a pointer to an exercise connection.

virtual makVrv::DtNetSoundPlayer::~DtNetSoundPlayer ( )

virtual

Virtual DTOR.

makVrv::DtNetSoundPlayer::DtNetSoundPlayer ( const DtNetSoundPlayer &  orig )

private

Copy CTOR.

Note

not implemented.

Member Function Documentation

virtual void makVrv::DtNetSoundPlayer::tick ( DtConstVector  viewPosition, DtConstVector  viewVelocity, const DtTaitBryan &  viewAngle  )

virtual

Overridden tick(..) Each call to tick updates the listener's position and orientation and manages starting, stopping and cleanup of sounds each frame.

Parameters

[in]	viewPosition	is the location of the listener.
[in]	viewVelocity	is the moving velocity of the listener.
[in]	viewAngle	is the orientation of the listener.

Reimplemented in makVrv::DtExerciseSoundPlayer.

void makVrv::DtNetSoundPlayer::setExerciseConn

(

DtExerciseConn *

exConn

)

Set a new exercise connection.

Note

Registered callbacks for previous exercise connection are unregistered. User must call register callbacks after setting a new exercise connection.

void makVrv::DtNetSoundPlayer::registerSignalCallbacks

(

)

Register a signal interaction callback with the exercise connection.

void makVrv::DtNetSoundPlayer::unregisterSignalCallbacks

(

)

Unregister the signal interaction callback from the exercise connection.

virtual void makVrv::DtNetSoundPlayer::setProcessSignalInteractions ( bool  )

virtual

Change setting to process signal callbacks.

virtual bool makVrv::DtNetSoundPlayer::processSignalInteractions ( ) const

virtual

Get the current setting to process signal callbacks.

virtual bool makVrv::DtNetSoundPlayer::addBufferSource ( DtBufferSource *  bs )

protectedvirtual

Add a buffer source to the signal list.

Parameters

[in]

bs

is the buffer source to add.

Return values

true	on success.
false	otherwise.

static void makVrv::DtNetSoundPlayer::signalInteractionCb ( DtSignalInteraction *  sound, void *  caller  )

staticprotected

Called on a signaled interaction.

Parameters

[in]	sound	is the signal interaction.
[in]	caller	is the instance of the caller (this object).

static int makVrv::DtNetSoundPlayer::processEncodingType ( DtSignalInteraction *  sound )

staticprotected

Translate the OpenAL encoding type based on the signal interaction encoding type.

Parameters

[in]

sound

is the signal interaction.

Returns

The OpenAL encoding type.

static bool makVrv::DtNetSoundPlayer::canProcessEncodingClass ( DtSignalInteraction *  sound )

staticprotected

Check for a valid encoding class.

Parameters

[in]

sound

is the signal interaction.

Return values

true	if the encoding class is valid.
false	otherwise.

DtNetSoundPlayer& makVrv::DtNetSoundPlayer::operator= ( const DtNetSoundPlayer &  orig )

private

Assignment operator.

Note

not implemented.

Member Data Documentation

DtExerciseConn* makVrv::DtNetSoundPlayer::myExConn

protected

bool makVrv::DtNetSoundPlayer::myProcessSignalInteractions

protected

DtList* makVrv::DtNetSoundPlayer::mySignalList

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvAudioVrlink/netSoundPlayer.h