SoundManager Class Reference

#include <GameSounds.h>

Inherits SubsystemInterface.

Public Member Functions
	SoundManager ()
virtual	~SoundManager ()
virtual void	init (void)
	Initializes the sounds system.
virtual void	postProcessLoad ()
virtual void	update (void)
	Services sounds tasks. Called by AudioInterface.
virtual void	reset (void)
	Reset the sounds system.
virtual void	loseFocus (void)
	Called when application loses focus.
virtual void	regainFocus (void)
	Called when application regains focus.
virtual void	setListenerPosition (const Coord3D *position)
	Set the listener position for map3DSound() calculations.
virtual void	setViewRadius (Real viewRadius)
	Sets the radius of the view from the center of the screen in world coordinate units.
virtual void	setCameraAudibleDistance (Real audibleDistance)
virtual Real	getCameraAudibleDistance (void)
virtual void	addAudioEvent (AudioEventRTS *eventToAdd)
virtual void	notifyOf2DSampleStart (void)
virtual void	notifyOf3DSampleStart (void)
virtual void	notifyOf2DSampleCompletion (void)
virtual void	notifyOf3DSampleCompletion (void)
virtual Int	getAvailableSamples (void)
virtual Int	getAvailable3DSamples (void)
virtual AsciiString	getFilenameForPlayFromAudioEvent (const AudioEventRTS *eventToGetFrom)
virtual Bool	canPlayNow (AudioEventRTS *event)
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Protected Member Functions
virtual Bool	violatesVoice (AudioEventRTS *event)
virtual Bool	isInterrupting (AudioEventRTS *event)

Protected Attributes
UnsignedInt	m_num2DSamples
UnsignedInt	m_num3DSamples
UnsignedInt	m_numPlaying2DSamples
UnsignedInt	m_numPlaying3DSamples
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 53 of file GameSounds.h.

Constructor & Destructor Documentation

SoundManager()

SoundManager::SoundManager

(

)

Definition at line 65 of file GameSounds.cpp.

~SoundManager()

SoundManager::~SoundManager ( )

virtual

Definition at line 71 of file GameSounds.cpp.

Member Function Documentation

addAudioEvent()

void SoundManager::addAudioEvent ( AudioEventRTS * eventToAdd )

virtual

Definition at line 139 of file GameSounds.cpp.

canPlayNow()

Bool SoundManager::canPlayNow ( AudioEventRTS * event )

virtual

Definition at line 206 of file GameSounds.cpp.

getAvailable3DSamples()

Int SoundManager::getAvailable3DSamples ( void )

virtual

Definition at line 194 of file GameSounds.cpp.

getAvailableSamples()

Int SoundManager::getAvailableSamples ( void )

virtual

Definition at line 188 of file GameSounds.cpp.

getCameraAudibleDistance()

Real SoundManager::getCameraAudibleDistance ( void )

virtual

Definition at line 133 of file GameSounds.cpp.

getFilenameForPlayFromAudioEvent()

AsciiString SoundManager::getFilenameForPlayFromAudioEvent ( const AudioEventRTS * eventToGetFrom )

virtual

Definition at line 200 of file GameSounds.cpp.

init()

void SoundManager::init ( void )

virtual

Initializes the sounds system.

Implements SubsystemInterface.

Definition at line 77 of file GameSounds.cpp.

isInterrupting()

Bool SoundManager::isInterrupting ( AudioEventRTS * event )

protectedvirtual

Definition at line 330 of file GameSounds.cpp.

loseFocus()

void SoundManager::loseFocus ( void )

virtual

Called when application loses focus.

Definition at line 103 of file GameSounds.cpp.

notifyOf2DSampleCompletion()

void SoundManager::notifyOf2DSampleCompletion ( void )

virtual

Definition at line 172 of file GameSounds.cpp.

notifyOf2DSampleStart()

void SoundManager::notifyOf2DSampleStart ( void )

virtual

Definition at line 160 of file GameSounds.cpp.

notifyOf3DSampleCompletion()

void SoundManager::notifyOf3DSampleCompletion ( void )

virtual

Definition at line 180 of file GameSounds.cpp.

notifyOf3DSampleStart()

void SoundManager::notifyOf3DSampleStart ( void )

virtual

Definition at line 166 of file GameSounds.cpp.

postProcessLoad()

void SoundManager::postProcessLoad ( void )

virtual

• Called for all subsystems after all other Subsystems are inited. (allows for initializing inter-system dependencies)

Reimplemented from SubsystemInterface.

Definition at line 83 of file GameSounds.cpp.

regainFocus()

void SoundManager::regainFocus ( void )

virtual

Called when application regains focus.

Definition at line 109 of file GameSounds.cpp.

reset()

void SoundManager::reset ( void )

virtual

Reset the sounds system.

Implements SubsystemInterface.

Definition at line 96 of file GameSounds.cpp.

setCameraAudibleDistance()

void SoundManager::setCameraAudibleDistance ( Real audibleDistance )

virtual

Definition at line 127 of file GameSounds.cpp.

setListenerPosition()

void SoundManager::setListenerPosition ( const Coord3D * position )

virtual

Set the listener position for map3DSound() calculations.

Definition at line 115 of file GameSounds.cpp.

setViewRadius()

void SoundManager::setViewRadius ( Real viewRadius )

virtual

Sets the radius of the view from the center of the screen in world coordinate units.

Definition at line 121 of file GameSounds.cpp.

update()

void SoundManager::update ( void )

virtual

Services sounds tasks. Called by AudioInterface.

Implements SubsystemInterface.

Definition at line 90 of file GameSounds.cpp.

violatesVoice()

Bool SoundManager::violatesVoice ( AudioEventRTS * event )

protectedvirtual

Definition at line 321 of file GameSounds.cpp.

Member Data Documentation

m_num2DSamples

UnsignedInt SoundManager::m_num2DSamples

protected

Definition at line 95 of file GameSounds.h.

m_num3DSamples

UnsignedInt SoundManager::m_num3DSamples

protected

Definition at line 96 of file GameSounds.h.

m_numPlaying2DSamples

UnsignedInt SoundManager::m_numPlaying2DSamples

protected

Definition at line 98 of file GameSounds.h.

m_numPlaying3DSamples

UnsignedInt SoundManager::m_numPlaying3DSamples

protected

Definition at line 99 of file GameSounds.h.

---

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

• Code/GameEngine/Include/Common/GameSounds.h
• Code/GameEngine/Source/Common/Audio/GameSounds.cpp