---

SND_SoundObject Class Reference

SND_SoundObject is a class for api independent sounddata storage conected to an actuator. More...

#include <SND_SoundObject.h>

Inheritance diagram for SND_SoundObject:

List of all members.

Public Methods
	SND_SoundObject ()
	~SND_SoundObject ()
void	startSound ()
void	stopSound ()
void	pauseSound ()
void	setSample (CCString pSample)
void	setModified (bool mod)
void	setPitch (MT_Scalar pitch)
void	setGain (MT_Scalar gain)
void	setPosition (const MT_Point3& pos)
void	setVelocity (const MT_Vector3& vel)
void	setOrientation (const MT_Matrix3x3& orient)
void	setLooping (bool isLooping)
void	setPlaystate (int playstate)
const CCString&	getSample ()
bool	isModified () const
	isModified will return true if the scene must update some parameter of the object. More...
float	getGain () const
float	getPitch () const
MT_Point3	getPosition () const
MT_Point3	getVelocity () const
MT_Matrix3x3	getOrientation () const
bool	isLooping () const
int	getPlaystate () const

---

Detailed Description

SND_SoundObject is a class for api independent sounddata storage conected to an actuator.

Definition at line 20 of file SND_SoundObject.h.

---

Constructor & Destructor Documentation

SND_SoundObject::SND_SoundObject ( )

Definition at line 11 of file SND_SoundObject.cpp.

SND_SoundObject::~SND_SoundObject ( )

Definition at line 33 of file SND_SoundObject.cpp.

---

Member Function Documentation

float SND_SoundObject::getGain ( ) const [inline]

Definition at line 44 of file SND_SoundObject.h.

MT_Matrix3x3 SND_SoundObject::getOrientation ( ) const [inline]

Definition at line 48 of file SND_SoundObject.h.

float SND_SoundObject::getPitch ( ) const [inline]

Definition at line 45 of file SND_SoundObject.h. Referenced by KX_SoundActuator::Update().

int SND_SoundObject::getPlaystate ( ) const [inline]

Definition at line 50 of file SND_SoundObject.h. Referenced by KX_SoundActuator::Update().

MT_Point3 SND_SoundObject::getPosition ( ) const [inline]

Definition at line 46 of file SND_SoundObject.h.

const CCString & SND_SoundObject::getSample ( ) [inline]

Definition at line 41 of file SND_SoundObject.h.

MT_Point3 SND_SoundObject::getVelocity ( ) const [inline]

Definition at line 47 of file SND_SoundObject.h.

bool SND_SoundObject::isLooping ( ) const [inline]

Definition at line 49 of file SND_SoundObject.h.

bool SND_SoundObject::isModified ( ) const [inline, virtual]

isModified will return true if the scene must update some parameter of the object. This can be modifications like setting volume, position or start/stop playing. Reimplemented from SND_IObject. Definition at line 42 of file SND_SoundObject.h.

void SND_SoundObject::pauseSound ( )

Definition at line 50 of file SND_SoundObject.cpp.

void SND_SoundObject::setGain ( MT_Scalar gain ) [virtual]

Reimplemented from SND_IObject. Definition at line 56 of file SND_SoundObject.cpp.

void SND_SoundObject::setLooping ( bool isLooping )

Definition at line 86 of file SND_SoundObject.cpp. Referenced by KX_SoundActuator::Update().

void SND_SoundObject::setModified ( bool mod ) [inline, virtual]

Reimplemented from SND_IObject. Definition at line 31 of file SND_SoundObject.h.

void SND_SoundObject::setOrientation ( const MT_Matrix3x3 & orient ) [virtual]

Reimplemented from SND_IObject. Definition at line 80 of file SND_SoundObject.cpp. Referenced by KX_SoundActuator::Update().

void SND_SoundObject::setPitch ( MT_Scalar pitch )

Definition at line 62 of file SND_SoundObject.cpp. Referenced by KX_SoundActuator::Update().

void SND_SoundObject::setPlaystate ( int playstate ) [inline]

Definition at line 39 of file SND_SoundObject.h.

void SND_SoundObject::setPosition ( const MT_Point3 & pos ) [virtual]

Reimplemented from SND_IObject. Definition at line 68 of file SND_SoundObject.cpp. Referenced by KX_SoundActuator::Update().

void SND_SoundObject::setSample ( CCString pSample ) [inline]

Definition at line 30 of file SND_SoundObject.h. Referenced by BL_ConvertActuators(), and CreateSampleLogic().

void SND_SoundObject::setVelocity ( const MT_Vector3 & vel ) [virtual]

Reimplemented from SND_IObject. Definition at line 74 of file SND_SoundObject.cpp.

void SND_SoundObject::startSound ( )

Definition at line 38 of file SND_SoundObject.cpp. Referenced by KX_SoundActuator::Update().

void SND_SoundObject::stopSound ( )

Definition at line 44 of file SND_SoundObject.cpp. Referenced by KX_SoundActuator::Update().

---

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

• SND_SoundObject.h
• SND_SoundObject.cpp

---