AudioEntity Class Reference

Audio entity base class. More...

#include <tdme/audio/AudioEntity.h>

Inheritance diagram for AudioEntity:

Collaboration diagram for AudioEntity:

Public Member Functions
virtual const string &	getId () const
virtual const bool	isLooping () const
virtual void	setLooping (bool looping)
	Set looping. More...
virtual const bool	isFixed () const
virtual void	setFixed (bool fixed)
	Set this entity fixed, means the sound will always played no matter where the position and listener is located. More...
virtual const float	getPitch () const
virtual void	setPitch (float pitch)
	Set up pitch. More...
virtual const float	getGain () const
virtual void	setGain (float gain)
	Set up gain. More...
virtual const Vector3 &	getSourcePosition () const
virtual void	setSourcePosition (const Vector3 &sourcePosition)
	Set source position. More...
virtual const Vector3 &	getSourceDirection () const
virtual void	setSourceDirection (const Vector3 &sourceDirection)
	Set source direction. More...
virtual const Vector3 &	getSourceVelocity () const
virtual void	getSourceVelocity (const Vector3 &sourceVelocity)
	Set source velocity. More...
virtual bool	isPlaying ()=0
virtual void	rewind ()=0
	Rewinds this audio entity. More...
virtual void	play ()=0
	Plays this audio entity. More...
virtual void	pause ()=0
	Pauses this audio entity. More...
virtual void	stop ()=0
	Stops this audio entity. More...

Protected Member Functions
	AudioEntity (const string &id)
	Constructor. More...
virtual	~AudioEntity ()
	Constructor. More...
virtual bool	initialize ()=0
	Initiates this OpenAL entity to OpenAl. More...
virtual void	update ()=0
	Commits properties to OpenAl. More...
virtual void	dispose ()=0
	Dispose this entity from OpenAL. More...

Protected Attributes
string	id
bool	looping
bool	fixed
float	pitch
float	gain
Vector3	sourcePosition
Vector3	sourceDirection
Vector3	sourceVelocity

Friends
class	Audio

Detailed Description

Audio entity base class.

Author

Andreas Drewke

Version

$Id$

Definition at line 19 of file AudioEntity.h.

Constructor & Destructor Documentation

AudioEntity()

AudioEntity ( const string &  id )

protected

Constructor.

Definition at line 13 of file AudioEntity.cpp.

~AudioEntity()

~AudioEntity ( )

protectedvirtual

Constructor.

Definition at line 25 of file AudioEntity.cpp.

Member Function Documentation

dispose()

virtual void dispose ( )

protectedpure virtual

Dispose this entity from OpenAL.

Implemented in AudioStream, Sound, and VorbisAudioStream.

getGain()

virtual const float getGain ( ) const

inlinevirtual

Returns

gain

Definition at line 116 of file AudioEntity.h.

getId()

virtual const string & getId ( ) const

inlinevirtual

Returns

id

Definition at line 64 of file AudioEntity.h.

getPitch()

virtual const float getPitch ( ) const

inlinevirtual

Returns

pitch

Definition at line 101 of file AudioEntity.h.

getSourceDirection()

virtual const Vector3 & getSourceDirection ( ) const

inlinevirtual

Returns

source direction

Definition at line 146 of file AudioEntity.h.

getSourcePosition()

virtual const Vector3 & getSourcePosition ( ) const

inlinevirtual

Returns

source position

Definition at line 131 of file AudioEntity.h.

getSourceVelocity() [1/2]

virtual const Vector3 & getSourceVelocity ( ) const

inlinevirtual

Returns

source velocity

Definition at line 161 of file AudioEntity.h.

getSourceVelocity() [2/2]

virtual void getSourceVelocity ( const Vector3 &  sourceVelocity )

inlinevirtual

Set source velocity.

Parameters

sourceVelocity

source velocity

Definition at line 169 of file AudioEntity.h.

initialize()

virtual bool initialize ( )

protectedpure virtual

Initiates this OpenAL entity to OpenAl.

Implemented in AudioStream, Sound, and VorbisAudioStream.

isFixed()

virtual const bool isFixed ( ) const

inlinevirtual

Returns

fixed, means the sound will always played no matter where the position and listener is located

Definition at line 86 of file AudioEntity.h.

isLooping()

virtual const bool isLooping ( ) const

inlinevirtual

Returns

if sound will be looped

Definition at line 71 of file AudioEntity.h.

isPlaying()

virtual bool isPlaying ( )

pure virtual

Returns

if stream is playing

Implemented in AudioStream, and Sound.

pause()

virtual void pause ( )

pure virtual

Pauses this audio entity.

Implemented in AudioStream, and Sound.

play()

virtual void play ( )

pure virtual

Plays this audio entity.

Implemented in AudioStream, and Sound.

rewind()

virtual void rewind ( )

pure virtual

Rewinds this audio entity.

Implemented in AudioStream, Sound, and VorbisAudioStream.

setFixed()

virtual void setFixed ( bool  fixed )

inlinevirtual

Set this entity fixed, means the sound will always played no matter where the position and listener is located.

Parameters

fixed

fixed

Definition at line 94 of file AudioEntity.h.

setGain()

virtual void setGain ( float  gain )

inlinevirtual

Set up gain.

Parameters

gain

gain

Definition at line 124 of file AudioEntity.h.

setLooping()

virtual void setLooping ( bool  looping )

inlinevirtual

Set looping.

Parameters

looping

if sound will be looped

Definition at line 79 of file AudioEntity.h.

setPitch()

virtual void setPitch ( float  pitch )

inlinevirtual

Set up pitch.

Parameters

pitch

pitch

Definition at line 109 of file AudioEntity.h.

setSourceDirection()

virtual void setSourceDirection ( const Vector3 &  sourceDirection )

inlinevirtual

Set source direction.

Parameters

sourceDirection

source direction

Definition at line 154 of file AudioEntity.h.

setSourcePosition()

virtual void setSourcePosition ( const Vector3 &  sourcePosition )

inlinevirtual

Set source position.

Returns

source position

Definition at line 139 of file AudioEntity.h.

stop()

virtual void stop ( )

pure virtual

Stops this audio entity.

Implemented in AudioStream, and Sound.

update()

virtual void update ( )

protectedpure virtual

Commits properties to OpenAl.

Implemented in AudioStream, and Sound.

Friends And Related Function Documentation

Audio

friend class Audio

friend

Definition at line 21 of file AudioEntity.h.

Member Data Documentation

fixed

bool fixed

protected

Definition at line 26 of file AudioEntity.h.

gain

float gain

protected

Definition at line 28 of file AudioEntity.h.

id

string id

protected

Definition at line 24 of file AudioEntity.h.

looping

bool looping

protected

Definition at line 25 of file AudioEntity.h.

pitch

float pitch

protected

Definition at line 27 of file AudioEntity.h.

sourceDirection

Vector3 sourceDirection

protected

Definition at line 30 of file AudioEntity.h.

sourcePosition

Vector3 sourcePosition

protected

Definition at line 29 of file AudioEntity.h.

sourceVelocity

Vector3 sourceVelocity

protected

Definition at line 31 of file AudioEntity.h.

---

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

• /home/andreas/Development/drewke.net/tdme2/src/tdme/audio/AudioEntity.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/audio/AudioEntity.cpp