SoundManager Class Reference

Implement iSoundManager. More...

#include <soundmanager.h>

List of all members.

Public Member Functions
virtual void	AddObjectEntity (iMeshWrapper *mesh, const char *meshName)
virtual bool	AddSndQueue (int queueID, SndCtrlID sndCtrlID)
	CS_EVENTHANDLER_NAMES ("crystalspace.planeshift.sound") virtual const csHandlerID *GenericPrec(csRef< iEventHandlerRegistry > &ehr
virtual const csHandlerID *	GenericSucc (csRef< iEventHandlerRegistry > &ehr, csRef< iEventNameRegistry > &enr, csEventID id) const
virtual int	GetCombatStance () const
virtual csVector3	GetPosition () const
virtual iSoundControl *	GetSndCtrl (SndCtrlID sndCtrlID)
virtual bool	HandleEvent (iEvent &e)
virtual bool	Initialize (iObjectRegistry *objReg)
virtual CS_EVENTHANDLER_DEFAULT_INSTANCE_CONSTRAINTS bool	InitializeSectors ()
virtual bool	IsChatToggleOn ()
virtual bool	IsCombatMusicToggleOn ()
virtual bool	IsListenerOnCameraToggleOn ()
virtual bool	IsLoopBGMToggleOn ()
virtual bool	IsSoundActive (SndCtrlID sndCtrlID)
virtual bool	IsSoundValid (uint soundID) const
virtual bool	LoadActiveSector (const char *sectorName)
virtual uint	PlaySong (csRef< iDocument > musicalSheet, const char *instrument, SndCtrlID sndCtrlID, csVector3 pos, csVector3 dir)
virtual uint	PlaySound (const char *fileName, bool loop, SndCtrlID sndCtrlID)
virtual uint	PlaySound (const char *fileName, bool loop, SndCtrlID sndCtrlID, csVector3 pos, csVector3 dir, float minDist, float maxDist)
virtual bool	PushQueueItem (int queueID, const char *fileName)
virtual bool	ReloadSectors ()
virtual void	RemoveObjectEntity (iMeshWrapper *mesh, const char *meshName)
virtual void	RemoveSndQueue (int queueID)
virtual void	SetChatToggle (bool toggle)
virtual void	SetCombatMusicToggle (bool toggle)
virtual void	SetCombatStance (int newCombatStance)
virtual void	SetEntityState (int state, iMeshWrapper *mesh, const char *meshName, bool forceChange)
virtual void	SetListenerOnCameraToggle (bool toggle)
virtual void	SetLoopBGMToggle (bool toggle)
virtual void	SetPlayerMovement (csVector3 playerPosition, csVector3 playerVelocity)
virtual bool	SetSoundSource (uint soundID, csVector3 position)
virtual void	SetTimeOfDay (int newTimeOfDay)
virtual void	SetWeather (int newWeather)
	SoundManager (iBase *parent)
virtual bool	StopSound (uint soundID)
virtual void	Update ()
virtual void	UpdateListener (iView *view)
virtual void	UpdateObjectEntity (iMeshWrapper *mesh, const char *meshName)
virtual	~SoundManager ()
Public Attributes
csRef< iEventNameRegistry > csEventID id	const
csRef< iEventNameRegistry > &	enr
Static Public Attributes
static csRandomGen	randomGen
	random number generator.
static uint	updateTime
	update throttle in milliseconds.

---

Detailed Description

Implement iSoundManager.

See also:

iSoundManager

Definition at line 53 of file soundmanager.h.

---

Constructor & Destructor Documentation

SoundManager::SoundManager

(

iBase *

parent

)

virtual SoundManager::~SoundManager

(

)

[virtual]

---

Member Function Documentation

virtual void SoundManager::AddObjectEntity	(	iMeshWrapper *	mesh,
		const char *	meshName
	)		[virtual]

virtual bool SoundManager::AddSndQueue	(	int	queueID,
		SndCtrlID	sndCtrlID
	)		[virtual]

SoundManager::CS_EVENTHANDLER_NAMES

(

"crystalspace.planeshift.sound"

)

const

virtual const csHandlerID* SoundManager::GenericSucc	(	csRef< iEventHandlerRegistry > &	ehr,
		csRef< iEventNameRegistry > &	enr,
		csEventID	id
	)		const [inline, virtual]

Definition at line 71 of file soundmanager.h.

virtual int SoundManager::GetCombatStance

(

)

const [virtual]

virtual csVector3 SoundManager::GetPosition

(

)

const [virtual]

virtual iSoundControl* SoundManager::GetSndCtrl

(

SndCtrlID

sndCtrlID

)

[virtual]

virtual bool SoundManager::HandleEvent

(

iEvent &

e

)

[virtual]

virtual bool SoundManager::Initialize

(

iObjectRegistry *

objReg

)

[virtual]

virtual CS_EVENTHANDLER_DEFAULT_INSTANCE_CONSTRAINTS bool SoundManager::InitializeSectors

(

)

[virtual]

virtual bool SoundManager::IsChatToggleOn

(

)

[virtual]

virtual bool SoundManager::IsCombatMusicToggleOn

(

)

[virtual]

virtual bool SoundManager::IsListenerOnCameraToggleOn

(

)

[virtual]

virtual bool SoundManager::IsLoopBGMToggleOn

(

)

[virtual]

virtual bool SoundManager::IsSoundActive

(

SndCtrlID

sndCtrlID

)

[virtual]

virtual bool SoundManager::IsSoundValid

(

uint

soundID

)

const [virtual]

virtual bool SoundManager::LoadActiveSector

(

const char *

sectorName

)

[virtual]

virtual uint SoundManager::PlaySong	(	csRef< iDocument >	musicalSheet,
		const char *	instrument,
		SndCtrlID	sndCtrlID,
		csVector3	pos,
		csVector3	dir
	)		[virtual]

virtual uint SoundManager::PlaySound	(	const char *	fileName,
		bool	loop,
		SndCtrlID	sndCtrlID,
		csVector3	pos,
		csVector3	dir,
		float	minDist,
		float	maxDist
	)		[virtual]

virtual uint SoundManager::PlaySound	(	const char *	fileName,
		bool	loop,
		SndCtrlID	sndCtrlID
	)		[virtual]

virtual bool SoundManager::PushQueueItem	(	int	queueID,
		const char *	fileName
	)		[virtual]

virtual bool SoundManager::ReloadSectors

(

)

[virtual]

virtual void SoundManager::RemoveObjectEntity	(	iMeshWrapper *	mesh,
		const char *	meshName
	)		[virtual]

virtual void SoundManager::RemoveSndQueue

(

int

queueID

)

[virtual]

virtual void SoundManager::SetChatToggle

(

bool

toggle

)

[virtual]

virtual void SoundManager::SetCombatMusicToggle

(

bool

toggle

)

[virtual]

virtual void SoundManager::SetCombatStance

(

int

newCombatStance

)

[virtual]

virtual void SoundManager::SetEntityState	(	int	state,
		iMeshWrapper *	mesh,
		const char *	meshName,
		bool	forceChange
	)		[virtual]

virtual void SoundManager::SetListenerOnCameraToggle

(

bool

toggle

)

[virtual]

virtual void SoundManager::SetLoopBGMToggle

(

bool

toggle

)

[virtual]

virtual void SoundManager::SetPlayerMovement	(	csVector3	playerPosition,
		csVector3	playerVelocity
	)		[virtual]

virtual bool SoundManager::SetSoundSource	(	uint	soundID,
		csVector3	position
	)		[virtual]

virtual void SoundManager::SetTimeOfDay

(

int

newTimeOfDay

)

[virtual]

virtual void SoundManager::SetWeather

(

int

newWeather

)

[virtual]

virtual bool SoundManager::StopSound

(

uint

soundID

)

[virtual]

virtual void SoundManager::Update

(

)

[virtual]

virtual void SoundManager::UpdateListener

(

iView *

view

)

[virtual]

virtual void SoundManager::UpdateObjectEntity	(	iMeshWrapper *	mesh,
		const char *	meshName
	)		[virtual]

---

Member Data Documentation

csRef<iEventNameRegistry> csEventID id SoundManager::const

Definition at line 70 of file soundmanager.h.

csRef<iEventNameRegistry>& SoundManager::enr

Definition at line 70 of file soundmanager.h.

csRandomGen SoundManager::randomGen [static]

random number generator.

Definition at line 58 of file soundmanager.h.

uint SoundManager::updateTime [static]

update throttle in milliseconds.

Definition at line 57 of file soundmanager.h.

---

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

• plugins/common/soundmanager/soundmanager.h