SoundSource Class Reference

#include <SoundSource.h>

List of all members.

Public Member Functions
virtual	~SoundSource ()
void	play (SoundBuffer *buffer, bool repeat=false)
void	simulate (bool repeat=false)
void	stop ()
bool	getPlaying ()
void	setRelative (bool relative)
void	setPosition (Vector &position)
void	setVelocity (Vector &velocity)
void	setReferenceDistance (float refDist)
void	setRolloff (float rolloff)
void	setGain (float gain)
Protected Member Functions
	SoundSource ()
bool	create ()
void	destroy ()
Protected Attributes
unsigned int	source_
SoundBufferSourceInstance *	buffer_
Friends
class	Sound

---

Detailed Description

Definition at line 29 of file SoundSource.h.

---

Constructor & Destructor Documentation

SoundSource::~SoundSource

(

)

[virtual]

Definition at line 34 of file SoundSource.cpp.

References buffer_, and destroy().

SoundSource::SoundSource

(

)

[protected]

Definition at line 29 of file SoundSource.cpp.

---

Member Function Documentation

void SoundSource::play	(	SoundBuffer *	buffer,
		bool	repeat = false
	)

Definition at line 85 of file SoundSource.cpp.

References buffer_, SoundBuffer::createSourceInstance(), SoundBufferSourceInstance::play(), source_, and stop().

Referenced by VirtualSoundSource::actualPlay().

void SoundSource::simulate

(

bool

repeat = false

)

Definition at line 96 of file SoundSource.cpp.

References buffer_, SoundBufferSourceInstance::simulate(), and source_.

Referenced by Sound::simulate().

void SoundSource::stop

(

)

Definition at line 103 of file SoundSource.cpp.

References buffer_, getPlaying(), source_, and SoundBufferSourceInstance::stop().

Referenced by destroy(), play(), and Sound::updateSources().

bool SoundSource::getPlaying

(

)

Definition at line 41 of file SoundSource.cpp.

References source_.

Referenced by VirtualSoundSource::getPlaying(), Sound::simulate(), stop(), and Sound::updateSources().

void SoundSource::setRelative

(

bool

relative

)

Definition at line 49 of file SoundSource.cpp.

References source_.

Referenced by VirtualSoundSource::actualPlay(), and VirtualSoundSource::setRelative().

void SoundSource::setPosition

(

Vector &

position

)

Definition at line 55 of file SoundSource.cpp.

References source_.

Referenced by VirtualSoundSource::actualPlay(), and VirtualSoundSource::setPosition().

void SoundSource::setVelocity

(

Vector &

velocity

)

Definition at line 61 of file SoundSource.cpp.

References source_.

Referenced by VirtualSoundSource::actualPlay(), and VirtualSoundSource::setVelocity().

void SoundSource::setReferenceDistance

(

float

refDist

)

Definition at line 73 of file SoundSource.cpp.

References source_.

Referenced by VirtualSoundSource::actualPlay(), and VirtualSoundSource::setReferenceDistance().

void SoundSource::setRolloff

(

float

rolloff

)

Definition at line 79 of file SoundSource.cpp.

References source_.

Referenced by VirtualSoundSource::actualPlay(), and VirtualSoundSource::setRolloff().

void SoundSource::setGain

(

float

gain

)

Definition at line 67 of file SoundSource.cpp.

References source_.

Referenced by VirtualSoundSource::actualPlay(), and VirtualSoundSource::setGain().

bool SoundSource::create

(

)

[protected]

Definition at line 123 of file SoundSource.cpp.

References error(), and source_.

Referenced by Sound::init().

void SoundSource::destroy

(

)

[protected]

Definition at line 115 of file SoundSource.cpp.

References source_, and stop().

Referenced by ~SoundSource().

---

Friends And Related Function Documentation

friend class Sound [friend]

Definition at line 48 of file SoundSource.h.

---

Member Data Documentation

unsigned int SoundSource::source_ [protected]

Definition at line 49 of file SoundSource.h.

Referenced by create(), destroy(), getPlaying(), play(), setGain(), setPosition(), setReferenceDistance(), setRelative(), setRolloff(), setVelocity(), simulate(), and stop().

SoundBufferSourceInstance* SoundSource::buffer_ [protected]

Definition at line 50 of file SoundSource.h.

Referenced by play(), simulate(), stop(), and ~SoundSource().

---

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

• src/client/sound/SoundSource.h
• src/client/sound/SoundSource.cpp

---