#include <SoundData.h>

Inheritance diagram for sound::SoundData:

Public Member Functions
f32	getGain () const
	Returns the gain.
f32	getInnerConeAngle () const
	Return the innerConeAngle.
f32	getMaxDistance () const
	Returns the max distance.
f32	getMinDistance () const
	Returns the min distance.
f32	getOuterConeAngle () const
	Returns the outerConeAngle.
f32	getOuterConeGain () const
	Returns the outerConeGain.
f32	getPitch () const
	Returns the pitch multiplier.
void	setConeSettings (f32 innerConeAngle, f32 outerConeAngle, f32 outerConeGain)
void	setDistanceValues (f32 minDistance, f32 maxDistance)
void	setGain (f32 gain)
	Sets the gain.
void	setInnerConeAngle (f32 innerConeAngle)
	Sets the inner angle of the sound cone for a directional sound.
void	setMaxDistance (f32 maxDistance)
	Sets the Max Distance.
void	setMinDistance (f32 minDistance)
	Sets the Min Distance.
void	setOuterConeAngle (f32 outerConeAngle)
	Sets the outer angle of the sound cone for a directional sound.
void	setOuterConeGain (f32 outerConeGain)
	Sets the gain outside the sound cone of a directional sound.
void	setPitch (f32 pitch)
	Sets the pitch multiplier.
	SoundData (const std::string &name, resource::Serializer *serializer)
virtual	~SoundData ()
Protected Member Functions
void	initProperties ()
virtual void	unloadImpl ()
Protected Attributes
f32	mGain
f32	mInnerConeAngle
f32	mMaxDistance
f32	mMinDistance
f32	mOuterConeAngle
f32	mOuterConeGain
f32	mPitch

Detailed Description

Defines a sound data resource. Author: Kat'Oun version: 1.0

Constructor & Destructor Documentation

sound::SoundData::SoundData	(	const std::string &	name,
		resource::Serializer *	serializer
	)

References initProperties(), resource::Resource::mResourceType, and resource::RT_RESOURCE_SOUND_DATA.

sound::SoundData::~SoundData ( ) [virtual]

Member Function Documentation

f32 sound::SoundData::getGain ( ) const

Returns the gain.

References mGain.

Referenced by sound::Sound::resourceLoaded().

f32 sound::SoundData::getInnerConeAngle ( ) const

Return the innerConeAngle.

References mInnerConeAngle.

Referenced by sound::Sound::resourceLoaded().

f32 sound::SoundData::getMaxDistance ( ) const

Returns the max distance.

References mMaxDistance.

Referenced by sound::Sound::resourceLoaded().

f32 sound::SoundData::getMinDistance ( ) const

Returns the min distance.

References mMinDistance.

Referenced by sound::Sound::resourceLoaded().

f32 sound::SoundData::getOuterConeAngle ( ) const

Returns the outerConeAngle.

References mOuterConeAngle.

Referenced by sound::Sound::resourceLoaded().

f32 sound::SoundData::getOuterConeGain ( ) const

Returns the outerConeGain.

References mOuterConeGain.

Referenced by sound::Sound::resourceLoaded().

f32 sound::SoundData::getPitch ( ) const

Returns the pitch multiplier.

References mPitch.

Referenced by sound::Sound::resourceLoaded().

void sound::SoundData::initProperties ( ) [protected]

Reimplemented from resource::Resource.

References ENGINE_UNIT, mGain, mInnerConeAngle, mMaxDistance, mMinDistance, mOuterConeAngle, mOuterConeGain, and mPitch.

Referenced by SoundData().

void sound::SoundData::setConeSettings	(	f32	innerConeAngle,
		f32	outerConeAngle,
		f32	outerConeGain
	)

Sets the variables used in the sound projection cone.

Parameters:

innerConeAngle,:	The inside cone angle.
outerConeAngle,:	The outside cone angle.
outerConeGain,:	The outer cone gain.

References setInnerConeAngle(), setOuterConeAngle(), and setOuterConeGain().

void sound::SoundData::setDistanceValues	(	f32	minDistance,
		f32	maxDistance
	)

Sets the variables used in the distance attenuation calculation.

Parameters:

minDistance,:	The min distance that the sound emitter will cease to continue growing louder at (as it approaches the listener).
maxDistance,:	The max distance a sound stops attenuating at.

References setMaxDistance(), and setMinDistance().

void sound::SoundData::setGain ( f32 gain )

Sets the gain.

References mGain.

void sound::SoundData::setInnerConeAngle ( f32 innerConeAngle )

Sets the inner angle of the sound cone for a directional sound.

References mInnerConeAngle.

Referenced by setConeSettings().

void sound::SoundData::setMaxDistance ( f32 maxDistance )

Sets the Max Distance.

References mMaxDistance.

Referenced by setDistanceValues().