Torque Game Engine Documentation
TGE Version 1.5.2

AmbientAudioManager Class Reference

#include <ambientAudioManager.h>

Detailed Description

The AmbientAudioManager manages varying the properties of audio emitters based on the player's position.

It not only provides a notion of "outside"-ness and "inside"-ness to Torque's sound library, but it also varies sounds based on the powered status of interiors, and plays the PowerUp/PowerDown sounds as needed.

AudioEmitters automatically add themselves to the AmbientAudioManager, see AudioEmitter::onAdd() and AudioEmitter::onRemove(). update() is called in clientProcess(), and gAmbientAudioManager stores the global reference to the AmbientAudioManager.

Public Member Functions

AmbientAudioManager ()

void addEmitter (AudioEmitter *)

void removeEmitter (AudioEmitter *)

void update ()

Data Fields

SimObjectPtr< AudioProfile > mPowerUpProfile

SimObjectPtr< AudioProfile > mPowerDownProfile

Private Member Functions

bool getOutsideScale (F32 *, InteriorInstance **)

void updateEnvironment ()

void updateEmitter (AudioEmitter *)

void stopInteriorAudio ()

Private Attributes

F32 mOutsideScale

0:inside -> 1:outside

Vector< AudioEmitter * > mEmitters

SimObjectPtr< InteriorInstance > mInteriorInstance

SimObjectPtr< AudioEnvironment > mCurrentEnvironment

F32 mEnvironmentScale

AUDIOHANDLE mInteriorAudioHandle

AUDIOHANDLE mPowerAudioHandle

bool mLastAlarmState

Constructor & Destructor Documentation

AmbientAudioManager::AmbientAudioManager ( )

Member Function Documentation

bool AmbientAudioManager::getOutsideScale	(	F32 *	,
		InteriorInstance **
	)			`[private]`

void AmbientAudioManager::updateEnvironment ( ) [private]

void AmbientAudioManager::updateEmitter ( AudioEmitter * ) [private]

void AmbientAudioManager::stopInteriorAudio ( ) [private]

void AmbientAudioManager::addEmitter ( AudioEmitter * )

void AmbientAudioManager::removeEmitter ( AudioEmitter * )

void AmbientAudioManager::update ( )

Field Documentation

F32 AmbientAudioManager::mOutsideScale [private]

0:inside -> 1:outside

Vector<AudioEmitter*> AmbientAudioManager::mEmitters [private]

SimObjectPtr<InteriorInstance> AmbientAudioManager::mInteriorInstance [private]

SimObjectPtr<AudioEnvironment> AmbientAudioManager::mCurrentEnvironment [private]

F32 AmbientAudioManager::mEnvironmentScale [private]

AUDIOHANDLE AmbientAudioManager::mInteriorAudioHandle [private]

AUDIOHANDLE AmbientAudioManager::mPowerAudioHandle [private]

bool AmbientAudioManager::mLastAlarmState [private]

SimObjectPtr<AudioProfile> AmbientAudioManager::mPowerUpProfile

SimObjectPtr<AudioProfile> AmbientAudioManager::mPowerDownProfile