omicron::Sound Class Reference

#include <Sound.h>

Public Types
enum	Rolloff { None, Linear, Logarithmic }

Public Member Functions
	Sound ()
	Sound (const String &name)
	Sound (const String &name, float, float, float, float, bool, bool)
void	setDefaultParameters (float, float, float, float, bool, bool)
bool	loadFromFile (const String &name)
bool	loadFromMemory (const void *, size_t)
float	getDuration ()
void	setVolumeScale (float)
float	getVolumeScale ()
int	getBufferID ()
String &	getFilePath ()
String &	getName ()
float	getDefaultVolume ()
float	getDefaultRoomSize ()
float	getDefaultWetness ()
float	getDefaultWidth ()
float	getDefaultPitch ()
bool	isDefaultLooping ()
bool	isEnvironmentSound ()
void	resetToEnvironmentParameters ()
bool	isUsingEnvironmentParameters ()
void	setSoundEnvironment (SoundEnvironment *)
SoundEnvironment *	getSoundEnvironment ()
void	setMaxDistance (float)
float	getMaxDistance ()
void	setMinRolloffDistance (float)
float	getMinRolloffDistance ()
void	setDistanceRange (float, float)
void	setNoRolloff ()
void	setLinearRolloff ()
void	setLogarthmicRolloff ()
Rolloff	getRolloffMode ()
bool	isRolloffEnabled ()
bool	isRolloffLinear ()
bool	isRolloffLogarithmic ()
Public Member Functions inherited from omicron::ReferenceType
	ReferenceType ()
virtual	~ReferenceType ()
void	ref ()
void	unref ()
long	refCount ()

Additional Inherited Members
Static Public Member Functions inherited from omicron::ReferenceType
static void	printObjCounts ()
Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * >	mysObjList

Inheritance diagram for omicron::Sound:

Member Enumeration Documentation

enum omicron::Sound::Rolloff

Enumerator
None
Linear
Logarithmic

Constructor & Destructor Documentation

omicron::Sound::Sound

(

)

omicron::Sound::Sound

(

const String &

name

)

omicron::Sound::Sound	(	const String &	name,
		float	,
		float	,
		float	,
		float	,
		bool	,
		bool
	)

Member Function Documentation

int omicron::Sound::getBufferID

(

)

float omicron::Sound::getDefaultPitch

(

)

float omicron::Sound::getDefaultRoomSize

(

)

float omicron::Sound::getDefaultVolume

(

)

float omicron::Sound::getDefaultWetness

(

)

float omicron::Sound::getDefaultWidth

(

)

float omicron::Sound::getDuration

(

)

String& omicron::Sound::getFilePath

(

)

float omicron::Sound::getMaxDistance

(

)

float omicron::Sound::getMinRolloffDistance

(

)

String& omicron::Sound::getName

(

)

Rolloff omicron::Sound::getRolloffMode

(

)

SoundEnvironment* omicron::Sound::getSoundEnvironment

(

)

float omicron::Sound::getVolumeScale

(

)

bool omicron::Sound::isDefaultLooping

(

)

bool omicron::Sound::isEnvironmentSound

(

)

bool omicron::Sound::isRolloffEnabled

(

)

bool omicron::Sound::isRolloffLinear

(

)

bool omicron::Sound::isRolloffLogarithmic

(

)

bool omicron::Sound::isUsingEnvironmentParameters

(

)

bool omicron::Sound::loadFromFile

(

const String &

name

)

bool omicron::Sound::loadFromMemory	(	const void *	,
		size_t
	)

void omicron::Sound::resetToEnvironmentParameters

(

)

void omicron::Sound::setDefaultParameters	(	float	,
		float	,
		float	,
		float	,
		bool	,
		bool
	)

void omicron::Sound::setDistanceRange	(	float	,
		float
	)

void omicron::Sound::setLinearRolloff

(

)

void omicron::Sound::setLogarthmicRolloff

(

)

void omicron::Sound::setMaxDistance

(

float

)

void omicron::Sound::setMinRolloffDistance

(

float

)

void omicron::Sound::setNoRolloff

(

)

void omicron::Sound::setSoundEnvironment

(

SoundEnvironment *

)

void omicron::Sound::setVolumeScale

(

float

)

---

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

• C:/dev/omegalib/release/src/omicron/include/omicron/Sound.h