CSoundBase Class Reference

#include <CSoundBase.h>

Inheritance diagram for CSoundBase:

Public Member Functions
	CSoundBase ()
virtual	~CSoundBase ()
bool	InitOpenAL ()
void	ResetVars ()
void	EnsurePlay ()
void	SetGain (ALfloat gain)
void	SetRollOff (ALfloat gain)
void	SetPitch (ALfloat pitch)
void	SetDirection (const CVector3D &direction)
void	SetCone (ALfloat innerCone, ALfloat outerCone, ALfloat coneGain)
void	SetLastPlay (bool last)
void	ReleaseOpenAL ()
bool	IsFading ()
bool	Finished ()
void	Play ()
void	PlayAndDelete ()
void	PlayLoop ()
void	Stop ()
void	StopAndDelete ()
void	FadeToIn (ALfloat newVolume, double fadeDuration)
bool	GetLooping ()
bool	IsPlaying ()
void	SetLocation (const CVector3D &position)
void	FadeAndDelete (double fadeTime)
void	FadeAndPause (double fadeTime)
void	Pause ()
void	Resume ()
Path *	GetName ()
virtual void	SetLooping (bool loops)
virtual bool	IdleTask ()
virtual void	Attach (CSoundData *itemData)
Public Member Functions inherited from ISoundItem
virtual	~ISoundItem ()
virtual void	FadeToIn (float newVolume, double fadeDuration)=0
virtual void	SetCone (float innerCone, float outerCone, float coneGain)=0
virtual void	SetPitch (float pitch)=0
virtual void	SetGain (float gain)=0
virtual void	SetRollOff (float gain)=0

Protected Member Functions
void	SetNameFromPath (VfsPath &itemPath)
void	ResetFade ()
bool	HandleFade ()

Protected Attributes
ALuint	m_ALSource
CSoundData *	m_SoundData
bool	m_LastPlay
bool	m_Looping
bool	m_ShouldBePlaying
bool	m_PauseAfterFade
bool	m_IsPaused
double	m_StartFadeTime
double	m_EndFadeTime
ALfloat	m_StartVolume
ALfloat	m_EndVolume
CMutex	m_ItemMutex

Detailed Description

Definition at line 30 of file CSoundBase.h.

Constructor & Destructor Documentation

CSoundBase::CSoundBase

(

)

Definition at line 31 of file CSoundBase.cpp.

CSoundBase::~CSoundBase ( )

virtual

Definition at line 36 of file CSoundBase.cpp.

Member Function Documentation

void CSoundBase::Attach ( CSoundData *  itemData )

virtual

Implements ISoundItem.

Reimplemented in CBufferItem, CStreamItem, and CSoundItem.

Definition at line 62 of file CSoundBase.cpp.

void CSoundBase::EnsurePlay ( )

virtual

Implements ISoundItem.

Definition at line 146 of file CSoundBase.cpp.

void CSoundBase::FadeAndDelete ( double  fadeTime )

virtual

Implements ISoundItem.

Definition at line 310 of file CSoundBase.cpp.

void CSoundBase::FadeAndPause ( double  fadeTime )

virtual

Implements ISoundItem.

Definition at line 304 of file CSoundBase.cpp.

void CSoundBase::FadeToIn	(	ALfloat	newVolume,
		double	fadeDuration
	)

Definition at line 332 of file CSoundBase.cpp.

bool CSoundBase::Finished ( )

virtual

Implements ISoundItem.

Definition at line 91 of file CSoundBase.cpp.

bool CSoundBase::GetLooping ( )

virtual

Implements ISoundItem.

Definition at line 262 of file CSoundBase.cpp.

Path * CSoundBase::GetName ( )

virtual

Implements ISoundItem.

Definition at line 364 of file CSoundBase.cpp.

bool CSoundBase::HandleFade ( )

protected

Definition at line 222 of file CSoundBase.cpp.

bool CSoundBase::IdleTask ( )

virtual

Implements ISoundItem.

Reimplemented in CSoundItem, CStreamItem, and CBufferItem.

Definition at line 207 of file CSoundBase.cpp.

bool CSoundBase::InitOpenAL

(

)

Definition at line 96 of file CSoundBase.cpp.

bool CSoundBase::IsFading ( )

virtual

Implements ISoundItem.

Definition at line 256 of file CSoundBase.cpp.

bool CSoundBase::IsPlaying ( )

virtual

Implements ISoundItem.

Definition at line 188 of file CSoundBase.cpp.

void CSoundBase::Pause ( )

virtual

Implements ISoundItem.

Definition at line 372 of file CSoundBase.cpp.

void CSoundBase::Play ( )

virtual

Implements ISoundItem.

Definition at line 277 of file CSoundBase.cpp.

void CSoundBase::PlayAndDelete ( )

virtual

Implements ISoundItem.

Definition at line 298 of file CSoundBase.cpp.

void CSoundBase::PlayLoop ( )

virtual

Implements ISoundItem.

Definition at line 322 of file CSoundBase.cpp.

void CSoundBase::ReleaseOpenAL

(

)

Definition at line 42 of file CSoundBase.cpp.

void CSoundBase::ResetFade ( )

protected

Definition at line 82 of file CSoundBase.cpp.

void CSoundBase::ResetVars

(

)

Definition at line 67 of file CSoundBase.cpp.

void CSoundBase::Resume ( )

virtual

Implements ISoundItem.

Definition at line 382 of file CSoundBase.cpp.

void CSoundBase::SetCone	(	ALfloat	innerCone,
		ALfloat	outerCone,
		ALfloat	coneGain
	)

Definition at line 152 of file CSoundBase.cpp.

void CSoundBase::SetDirection

(

const CVector3D &

direction

)

Definition at line 177 of file CSoundBase.cpp.

void CSoundBase::SetGain

(

ALfloat

gain

)

Definition at line 120 of file CSoundBase.cpp.

void CSoundBase::SetLastPlay

(

bool

last

)

Definition at line 202 of file CSoundBase.cpp.

void CSoundBase::SetLocation ( const CVector3D &  position )

virtual

Implements ISoundItem.

Definition at line 212 of file CSoundBase.cpp.

void CSoundBase::SetLooping ( bool  loops )

virtual

Implements ISoundItem.

Reimplemented in CStreamItem, and CBufferItem.

Definition at line 267 of file CSoundBase.cpp.

void CSoundBase::SetNameFromPath ( VfsPath &  itemPath )

protected

void CSoundBase::SetPitch

(

ALfloat

pitch

)

Definition at line 167 of file CSoundBase.cpp.

void CSoundBase::SetRollOff

(

ALfloat

gain

)

Definition at line 132 of file CSoundBase.cpp.

void CSoundBase::Stop ( )

virtual

Implements ISoundItem.

Definition at line 349 of file CSoundBase.cpp.

void CSoundBase::StopAndDelete ( )

virtual

Implements ISoundItem.

Definition at line 316 of file CSoundBase.cpp.

Member Data Documentation

ALuint CSoundBase::m_ALSource

protected

Definition at line 34 of file CSoundBase.h.

double CSoundBase::m_EndFadeTime

protected

Definition at line 44 of file CSoundBase.h.

ALfloat CSoundBase::m_EndVolume

protected

Definition at line 47 of file CSoundBase.h.

bool CSoundBase::m_IsPaused

protected

Definition at line 41 of file CSoundBase.h.

CMutex CSoundBase::m_ItemMutex

protected

Definition at line 48 of file CSoundBase.h.

bool CSoundBase::m_LastPlay

protected

Definition at line 37 of file CSoundBase.h.

bool CSoundBase::m_Looping

protected

Definition at line 38 of file CSoundBase.h.

bool CSoundBase::m_PauseAfterFade

protected

Definition at line 40 of file CSoundBase.h.

bool CSoundBase::m_ShouldBePlaying

protected

Definition at line 39 of file CSoundBase.h.

CSoundData* CSoundBase::m_SoundData

protected

Definition at line 35 of file CSoundBase.h.

double CSoundBase::m_StartFadeTime

protected

Definition at line 43 of file CSoundBase.h.

ALfloat CSoundBase::m_StartVolume

protected

Definition at line 46 of file CSoundBase.h.

---

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

• /home/sathyam/0ad.svn/source/soundmanager/items/CSoundBase.h
• /home/sathyam/0ad.svn/source/soundmanager/items/CSoundBase.cpp