CSoundBase Class Reference

#include <CSoundBase.h>

Inheritance diagram for CSoundBase:

Collaboration diagram for CSoundBase:

Public Member Functions
	CSoundBase ()
virtual	~CSoundBase ()
bool	InitOpenAL ()
void	ResetVars ()
void	EnsurePlay ()
void	SetGain (ALfloat gain)
void	SetRollOff (ALfloat gain, float minDist, float maxDist)
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 ()
const Path	GetName ()
virtual void	SetLooping (bool loops)
virtual bool	IdleTask ()
virtual void	Attach (CSoundData *itemData)
Public Member Functions inherited from ISoundItem
virtual	~ISoundItem ()
virtual bool	GetLooping ()=0
virtual void	SetLooping (bool loop)=0
virtual bool	IsPlaying ()=0
virtual const Path	GetName ()=0
virtual bool	IdleTask ()=0
virtual bool	IsFading ()=0
virtual bool	Finished ()=0
virtual void	Play ()=0
virtual void	Stop ()=0
virtual void	Attach (CSoundData *itemData)=0
virtual void	EnsurePlay ()=0
virtual void	PlayAndDelete ()=0
virtual void	StopAndDelete ()=0
virtual void	FadeToIn (float newVolume, double fadeDuration)=0
virtual void	FadeAndDelete (double fadeTime)=0
virtual void	FadeAndPause (double fadeTime)=0
virtual void	PlayLoop ()=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	SetLocation (const CVector3D &position)=0
virtual void	SetRollOff (float gain, float minDist, float maxDist)=0
virtual void	Pause ()=0
virtual void	Resume ()=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
std::mutex	m_ItemMutex

Constructor & Destructor Documentation

CSoundBase()

CSoundBase::CSoundBase

(

)

~CSoundBase()

CSoundBase::~CSoundBase ( )

virtual

Member Function Documentation

Attach()

void CSoundBase::Attach ( CSoundData *  itemData )

virtual

Implements ISoundItem.

Reimplemented in CBufferItem, CSoundItem, and CStreamItem.

EnsurePlay()

void CSoundBase::EnsurePlay ( )

virtual

Implements ISoundItem.

FadeAndDelete()

void CSoundBase::FadeAndDelete ( double  fadeTime )

virtual

Implements ISoundItem.

FadeAndPause()

void CSoundBase::FadeAndPause ( double  fadeTime )

virtual

Implements ISoundItem.

FadeToIn()

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

Finished()

bool CSoundBase::Finished ( )

virtual

Implements ISoundItem.

GetLooping()

bool CSoundBase::GetLooping ( )

virtual

Implements ISoundItem.

GetName()

const Path CSoundBase::GetName ( )

virtual

Implements ISoundItem.

HandleFade()

bool CSoundBase::HandleFade ( )

protected

IdleTask()

bool CSoundBase::IdleTask ( )

virtual

Implements ISoundItem.

Reimplemented in CBufferItem, CSoundItem, and CStreamItem.

InitOpenAL()

bool CSoundBase::InitOpenAL

(

)

IsFading()

bool CSoundBase::IsFading ( )

virtual

Implements ISoundItem.

IsPlaying()

bool CSoundBase::IsPlaying ( )

virtual

Implements ISoundItem.

Pause()

void CSoundBase::Pause ( )

virtual

Implements ISoundItem.

Play()

void CSoundBase::Play ( )

virtual

Implements ISoundItem.

PlayAndDelete()

void CSoundBase::PlayAndDelete ( )

virtual

Implements ISoundItem.

PlayLoop()

void CSoundBase::PlayLoop ( )

virtual

Implements ISoundItem.

ReleaseOpenAL()

void CSoundBase::ReleaseOpenAL

(

)

ResetFade()

void CSoundBase::ResetFade ( )

protected

ResetVars()

void CSoundBase::ResetVars

(

)

Resume()

void CSoundBase::Resume ( )

virtual

Implements ISoundItem.

SetCone()

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

SetDirection()

void CSoundBase::SetDirection

(

const CVector3D &

direction

)

SetGain()

void CSoundBase::SetGain

(

ALfloat

gain

)

SetLastPlay()

void CSoundBase::SetLastPlay

(

bool

last

)

SetLocation()

void CSoundBase::SetLocation ( const CVector3D &  position )

virtual

Implements ISoundItem.

SetLooping()

void CSoundBase::SetLooping ( bool  loops )

virtual

Implements ISoundItem.

Reimplemented in CBufferItem, and CStreamItem.

SetNameFromPath()

void CSoundBase::SetNameFromPath ( VfsPath &  itemPath )

protected

SetPitch()

void CSoundBase::SetPitch

(

ALfloat

pitch

)

SetRollOff()

void CSoundBase::SetRollOff	(	ALfloat	gain,
		float	minDist,
		float	maxDist
	)

Stop()

void CSoundBase::Stop ( )

virtual

Implements ISoundItem.

StopAndDelete()

void CSoundBase::StopAndDelete ( )

virtual

Implements ISoundItem.

Member Data Documentation

m_ALSource

ALuint CSoundBase::m_ALSource

protected

m_EndFadeTime

double CSoundBase::m_EndFadeTime

protected

m_EndVolume

ALfloat CSoundBase::m_EndVolume

protected

m_IsPaused

bool CSoundBase::m_IsPaused

protected

m_ItemMutex

std::mutex CSoundBase::m_ItemMutex

protected

m_LastPlay

bool CSoundBase::m_LastPlay

protected

m_Looping

bool CSoundBase::m_Looping

protected

m_PauseAfterFade

bool CSoundBase::m_PauseAfterFade

protected

m_ShouldBePlaying

bool CSoundBase::m_ShouldBePlaying

protected

m_SoundData

CSoundData* CSoundBase::m_SoundData

protected

m_StartFadeTime

double CSoundBase::m_StartFadeTime

protected

m_StartVolume

ALfloat CSoundBase::m_StartVolume

protected

---

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

• /home/docker/jenkins/workspace/technical-docs/source/soundmanager/items/CSoundBase.h
• /home/docker/jenkins/workspace/technical-docs/source/soundmanager/items/CSoundBase.cpp