makVrv::DtEntitySoundUpdater Class Reference

DtEntitySoundUpdater updates the sound with it's associated entity. More...

Inheritance diagram for makVrv::DtEntitySoundUpdater:

Public Member Functions
	DtEntitySoundUpdater (DtDe &de, DtUniqueID id)
	CTOR. More...
virtual	~DtEntitySoundUpdater ()
	DTOR. More...
virtual void	update (DtTime tNow)
	update per tick. More...
virtual void	setSoundModel (DtSoundModel *soundModel)
	Sets the sound model that will get updated. More...
virtual void	setAttachedSceneObjectId (DtUniqueID sceneObjectId)
	Sets the scend id of the entity the sound attached. More...
Public Member Functions inherited from makVrv::DtTickable
virtual bool	needsUpdate (DtTime tNow)
	The check function called by DtTickableManager to verify if an update is required. More...
virtual bool	updateIfNeeded (DtTime tNow)
	Calls needsUpdate(), and then calls update() if needsUpdate() is true. More...
virtual	~DtTickable ()
	Virtual DTOR. More...
virtual void	setIsThreadSafe (bool safe)
	Get/set whether this tickable can be updated in parallel with other tickables. More...
virtual bool	isThreadSafe () const
virtual void	setTickableListState (TickableListState safeList)
	Track which tickable list (if any) this tickable is on Since the tickable constructor puts ALL tickables on the main (unThreadSafe) to start we need a way to check which list a tickable is on (and this way we can request removals from the correct list instead of having to call DtTickableManager::removeTickableObject(), which tries both lists). More...
virtual TickableListState	tickableListState () const
virtual void	setUpdatePeriod (unsigned int period)
	Specify how often (in # of frames) this tickable should call update. More...
virtual unsigned int	updatePeriod () const
virtual bool	lodSystemEnabled () const
	is the update LOD system enabled, overridden by subclasses More...

Protected Attributes
DtDe &	myDe
DtUniqueID	myUniqueId
DtSoundModel *	mySoundModel
DtUniqueID	mySceneObjectId
DtDeadReckonUpdater *	myDeadReckonUpdater
DtSceneObject *	mySceneObject
Protected Attributes inherited from makVrv::DtTickable
DtTickableManagerInterface *	myManager
	Pointer to manager for removal during destruction. More...
DtSignalConnectionManager	myConnections
unsigned int	myFrameCounter
unsigned int	myFrameToUpdate
unsigned int	myUpdatePeriod
DtTime	myLastUpdateTime
bool	myIsThreadSafe
TickableListState	myTickableListState

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

Additional Inherited Members
Public Types inherited from makVrv::DtTickable
enum	TickableListState { TickableNotOnList, TickableOnMainList, TickableOnThreadSafeList }
	Enumeration used to indicate which DtTickableManager's tickable list the tickable is on, if any. More...
Protected Member Functions inherited from makVrv::DtTickable
	DtTickable (DtTickableManagerInterface *manager)
	CTOR. More...
	DtTickable ()
	Unimplemented default CTOR. More...
virtual void	slot_managerAboutToBeDeleted ()

Detailed Description

DtEntitySoundUpdater updates the sound with it's associated entity.

syncs the position and velocity of the sound with the entity it attached.

Constructor & Destructor Documentation

makVrv::DtEntitySoundUpdater::DtEntitySoundUpdater	(	DtDe &	de,
		DtUniqueID	id
	)

CTOR.

virtual makVrv::DtEntitySoundUpdater::~DtEntitySoundUpdater ( )

virtual

DTOR.

makVrv::DtEntitySoundUpdater::DtEntitySoundUpdater ( )

private

Default Constructor not implemented – default constructor not allowed.

makVrv::DtEntitySoundUpdater::DtEntitySoundUpdater ( const DtEntitySoundUpdater &  )

private

Copy Constructor not implemented – Copy not allowed.

Member Function Documentation

virtual void makVrv::DtEntitySoundUpdater::update ( DtTime  tNow )

virtual

update per tick.

See Also

DtTickable::update.

Implements makVrv::DtTickable.

Reimplemented in makVrf::DtVrfEntitySoundUpdater.

virtual void makVrv::DtEntitySoundUpdater::setSoundModel ( DtSoundModel *  soundModel )

virtual

Sets the sound model that will get updated.

virtual void makVrv::DtEntitySoundUpdater::setAttachedSceneObjectId ( DtUniqueID  sceneObjectId )

virtual

Sets the scend id of the entity the sound attached.

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

private

Assignment Operator not implemented – Copy not allowed.

Member Data Documentation

DtDe& makVrv::DtEntitySoundUpdater::myDe

protected

DtUniqueID makVrv::DtEntitySoundUpdater::myUniqueId

protected

DtSoundModel* makVrv::DtEntitySoundUpdater::mySoundModel

protected

DtUniqueID makVrv::DtEntitySoundUpdater::mySceneObjectId

protected

DtDeadReckonUpdater* makVrv::DtEntitySoundUpdater::myDeadReckonUpdater

protected

DtSceneObject* makVrv::DtEntitySoundUpdater::mySceneObject

protected

---

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

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