SoundSourceWorld Class Reference

Responsible for Sound Sources that can be placed in world space. Go To Scene for creation and destruction. More...

#include <SoundSourceWorld.h>

Public Member Functions
virtual float	GetGain () override
	Returns sound's gain.
virtual void	SetGain (float g) override
	Sets sound's gain.
virtual void	SetSound (SoundManager::Sound s) override
	Sets sound to be played.
Vect	GetPos ()
	Gets Sound Source's postion in the world.
void	SetPos (Vect p)
	Sets Sound Source's position in the world.
Public Member Functions inherited from Reverbable
virtual void	SubmitRegistration ()
	Called when wanting to make a sound have reverb in a ReverbSpace.
virtual void	SubmitDeregistration ()
	Called when no longer wanting to make a sound have reverb in a ReverbSpace.
Public Member Functions inherited from SoundSourceBase
virtual bool	GetLooping ()
	Returns if sound is looping.
virtual void	SetLooping (bool l)
	Sets if sound is looping.
virtual float	GetPitch ()
	Returns sound's pitch.
virtual void	SetPitch (float p)
	Sets sound's pitch.
virtual float	GetOffset ()
	Returns sound's offset.
virtual void	SetOffset (float o)
	Sets sound's offset.
virtual PlayState	GetPlayState ()
	Returns sound's PlayState.
virtual void	Play ()
	Plays a sound starting at it's offset.
virtual void	PlayStart ()
	Plays a sound starting at the beginning.
virtual void	Pause ()
	Pauses a sound.
virtual void	Stop ()
	Fully Stops a sound.
Public Member Functions inherited from OccludableSnd
virtual void	SubmitRegistration ()
	Called when wanting to make a sound be blocked by objects.
virtual void	SubmitDeregistration ()
	Called when no longer wanting to make a sound be blocked by objects.

Additional Inherited Members
Public Types inherited from SoundSourceBase
enum class	PlayState { PLAYING , PAUSED , STOPPED }
	Potential States a source can be in. More...

Detailed Description

Responsible for Sound Sources that can be placed in world space. Go To Scene for creation and destruction.

Check SoundSourceBase for more functions.

Member Function Documentation

GetGain()

float SoundSourceWorld::GetGain ( )

overridevirtual

Returns sound's gain.

Returns

float

Implements SoundSourceBase.

GetPos()

Vect SoundSourceWorld::GetPos

(

)

Gets Sound Source's postion in the world.

Returns

Vect

SetGain()

void SoundSourceWorld::SetGain ( float g )

overridevirtual

Sets sound's gain.

Parameters

g

Implements SoundSourceBase.

SetPos()

void SoundSourceWorld::SetPos

(

Vect

p

)

Sets Sound Source's position in the world.

Parameters

p

SetSound()

void SoundSourceWorld::SetSound ( SoundManager::Sound s )

overridevirtual

Sets sound to be played.

SoundSourceWorld can only be mono.

Parameters

s

Implements SoundSourceBase.