Z2SoundObjBase Class Reference

#include <Z2SoundObject.h>

Inheritance diagram for Z2SoundObjBase:

Collaboration diagram for Z2SoundObjBase:

Public Member Functions
	Z2SoundObjBase ()
	~Z2SoundObjBase ()
void	deleteObject ()
Z2SoundHandlePool *	startCollisionSE (u32 hitID, u32 mapinfo, Z2SoundObjBase *other)
bool	isAlive ()
void	setSoundStarter (Z2SoundStarter *soundStarter)
virtual void	framework (u32 mapinfo, s8 reverb)
virtual void	dispose ()
virtual bool	stopOK (Z2SoundHandlePool &handlePool)
virtual void	init (Vec *posPtr, u8 handleNum)
virtual Z2SoundHandlePool *	startSound (JAISoundID soundID, u32 mapinfo, s8 reverb)
virtual Z2SoundHandlePool *	startLevelSound (JAISoundID soundID, u32 mapinfo, s8 reverb)
Public Member Functions inherited from Z2SoundHandles
	Z2SoundHandles ()
	~Z2SoundHandles ()
void	initHandlesPool (u8 handleNum)
void	deleteHandlesPool ()
Z2SoundHandlePool *	getFreeHandle ()
Z2SoundHandlePool *	getLowPrioSound (JAISoundID soundID)
bool	isActive () const
Z2SoundHandlePool *	getHandleSoundID (JAISoundID soundID)
Z2SoundHandlePool *	getHandleUserData (u32 userData)
void	stopAllSounds (u32 fadeTime)
void	stopSound (JAISoundID soundID, u32 fadeTime)
void	setPos (const JGeometry::TVec3< f32 > &pos)
int	getNumHandles () const
Z2SoundHandlePool *	getHandle (int index)
Public Member Functions inherited from JSULink< Z2SoundObjBase >
	JSULink (Z2SoundObjBase *object)
Z2SoundObjBase *	getObject () const
JSUList< Z2SoundObjBase > *	getSupervisor () const
JSULink< Z2SoundObjBase > *	getNext () const
JSULink< Z2SoundObjBase > *	getPrev () const
Public Member Functions inherited from JSUPtrLink
	JSUPtrLink (void *object)
	~JSUPtrLink ()
void *	getObjectPtr () const
JSUPtrList *	getList () const
JSUPtrLink *	getNext () const
JSUPtrLink *	getPrev () const

Public Attributes
Z2SoundStarter *	soundStarter_
JGeometry::TVec3< f32 > *	pos_
u16	field_0x1c
s8	reverb_
bool	alive_
Public Attributes inherited from JSUPtrLink
void *	mObject
JSUPtrList *	mList
JSUPtrLink *	mPrev
JSUPtrLink *	mNext

Additional Inherited Members
Protected Member Functions inherited from JSUList< Z2SoundHandlePool >
	JSUList ()
	JSUList (bool init)
	~JSUList ()
bool	append (JSULink< Z2SoundHandlePool > *link)
bool	prepend (JSULink< Z2SoundHandlePool > *link)
bool	insert (JSULink< Z2SoundHandlePool > *before, JSULink< Z2SoundHandlePool > *link)
bool	remove (JSULink< Z2SoundHandlePool > *link)
JSULink< Z2SoundHandlePool > *	getFirst () const
JSULink< Z2SoundHandlePool > *	getLast () const
JSULink< Z2SoundHandlePool > *	getNth (u32 index) const
JSULink< Z2SoundHandlePool > *	getEnd () const
u32	getNumLinks () const
Protected Member Functions inherited from JSUPtrList
	JSUPtrList ()
	JSUPtrList (bool init)
	~JSUPtrList ()
void	initiate ()
void	setFirst (JSUPtrLink *first)
bool	append (JSUPtrLink *ptr)
bool	prepend (JSUPtrLink *ptr)
bool	insert (JSUPtrLink *before, JSUPtrLink *ptr)
bool	remove (JSUPtrLink *ptr)
JSUPtrLink *	getNthLink (u32 i) const
JSUPtrLink *	getFirstLink () const
JSUPtrLink *	getLastLink () const
u32	getNumLinks () const
Protected Attributes inherited from JSUPtrList
JSUPtrLink *	mHead
JSUPtrLink *	mTail
u32	mLength

Constructor & Destructor Documentation

Z2SoundObjBase()

Z2SoundObjBase::Z2SoundObjBase

(

)

~Z2SoundObjBase()

Z2SoundObjBase::~Z2SoundObjBase

(

)

Member Function Documentation

deleteObject()

void Z2SoundObjBase::deleteObject

(

)

dispose()

void Z2SoundObjBase::dispose ( )

virtual

framework()

void Z2SoundObjBase::framework ( u32 mapinfo, s8 reverb )

virtual

Reimplemented in Z2DopplerSoundObjBase.

init()

void Z2SoundObjBase::init ( Vec * posPtr, u8 handleNum )

virtual

Reimplemented in Z2DopplerSoundObjBase, Z2SoundObjAnime, Z2SoundObjArrow, Z2SoundObjBeeGroup, Z2SoundObjCoach, and Z2SoundObjSimple.

isAlive()

bool Z2SoundObjBase::isAlive ( )

inline

setSoundStarter()

void Z2SoundObjBase::setSoundStarter ( Z2SoundStarter * soundStarter )

inline

startCollisionSE()

Z2SoundHandlePool * Z2SoundObjBase::startCollisionSE	(	u32	hitID,
		u32	mapinfo,
		Z2SoundObjBase *	other )

startLevelSound()

Z2SoundHandlePool * Z2SoundObjBase::startLevelSound ( JAISoundID soundID, u32 mapinfo, s8 reverb )

virtual

Reimplemented in Z2DopplerSoundObjBase, and Z2SoundObjSimple.

startSound()

Z2SoundHandlePool * Z2SoundObjBase::startSound ( JAISoundID soundID, u32 mapinfo, s8 reverb )

virtual

Reimplemented in Z2DopplerSoundObjBase, Z2SoundObjCoach, and Z2SoundObjSimple.

stopOK()

bool Z2SoundObjBase::stopOK ( Z2SoundHandlePool & handlePool )

virtual

Member Data Documentation

alive_

bool Z2SoundObjBase::alive_

field_0x1c

u16 Z2SoundObjBase::field_0x1c

pos_

JGeometry::TVec3<f32>* Z2SoundObjBase::pos_

reverb_

s8 Z2SoundObjBase::reverb_

soundStarter_

Z2SoundStarter* Z2SoundObjBase::soundStarter_

---

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

• include/Z2AudioLib/Z2SoundObject.h
• src/Z2AudioLib/Z2SoundObject.cpp