SoundSceneObjClass Class Reference

#include <SoundSceneObj.h>

Inherits MultiListObjectClass, PersistClass, and RefCountClass.

Inherited by AudibleSoundClass, LogicalListenerClass, and LogicalSoundClass.

Public Member Functions
	SoundSceneObjClass (void)
	SoundSceneObjClass (const SoundSceneObjClass &src)
virtual	~SoundSceneObjClass (void)
const SoundSceneObjClass &	operator= (const SoundSceneObjClass &src)
virtual Sound3DClass *	As_Sound3DClass (void)
virtual SoundPseudo3DClass *	As_SoundPseudo3DClass (void)
virtual FilteredSoundClass *	As_FilteredSoundClass (void)
virtual Listener3DClass *	As_Listener3DClass (void)
virtual AudibleSoundClass *	As_AudibleSoundClass (void)
virtual uint32	Get_ID (void) const
virtual void	Set_ID (uint32 id)
virtual bool	On_Frame_Update (unsigned int milliseconds=0)
virtual void	On_Event (AudioCallbackClass::EVENTS event, uint32 param1=0, uint32 param2=0)
virtual void	Register_Callback (AudioCallbackClass::EVENTS events, AudioCallbackClass *callback)
virtual void	Set_Position (const Vector3 &position)=0
virtual Vector3	Get_Position (void) const =0
virtual void	Set_Listener_Transform (const Matrix3D &tm)
virtual void	Set_Transform (const Matrix3D &transform)=0
virtual Matrix3D	Get_Transform (void) const =0
virtual void	Cull_Sound (bool culled=true)=0
virtual bool	Is_Sound_Culled (void) const =0
virtual void	Set_User_Data (RefCountClass *user_obj=NULL, uint32 user=0)
virtual uint32	Get_User_Data (void) const
virtual RefCountClass *	Peek_User_Obj (void) const
virtual void	Attach_To_Object (RenderObjClass *render_obj, int bone_index=-1)
virtual void	Attach_To_Object (RenderObjClass *render_obj, const char *bone_name)
virtual RenderObjClass *	Peek_Parent_Object (void)
virtual int	Get_Parent_Bone (void)
virtual void	Apply_Auto_Position (void)
virtual void	Add_To_Scene (bool start_playing=true)=0
virtual void	Remove_From_Scene (void)=0
virtual bool	Is_In_Scene (void) const
virtual void	Set_DropOff_Radius (float radius=1)=0
virtual float	Get_DropOff_Radius (void) const =0
bool	Save (ChunkSaveClass &csave)
bool	Load (ChunkLoadClass &cload)
Public Member Functions inherited from MultiListObjectClass
	MultiListObjectClass (void)
virtual	~MultiListObjectClass (void)
MultiListNodeClass *	Get_List_Node () const
void	Set_List_Node (MultiListNodeClass *node)
Public Member Functions inherited from PersistClass
virtual const PersistFactoryClass &	Get_Factory (void) const =0
Public Member Functions inherited from PostLoadableClass
	PostLoadableClass (void)
virtual	~PostLoadableClass (void)
virtual void	On_Post_Load (void)
bool	Is_Post_Load_Registered (void)
void	Set_Post_Load_Registered (bool onoff)
Public Member Functions inherited from RefCountClass
	RefCountClass (void)
	RefCountClass (const RefCountClass &)
void	Add_Ref (void) const
WWINLINE void	Release_Ref (void) const
int	Num_Refs (void) const
virtual void	Delete_This (void)

Protected Member Functions
virtual SoundCullObjClass *	Peek_Cullable_Wrapper (void) const
virtual void	Set_Cullable_Wrapper (SoundCullObjClass *obj)
Protected Member Functions inherited from RefCountClass
virtual	~RefCountClass (void)

Static Protected Member Functions
static void	Register_Sound_Object (SoundSceneObjClass *sound_obj)
static void	Unregister_Sound_Object (SoundSceneObjClass *sound_obj)
static bool	Find_Sound_Object (uint32 id_to_find, int *index)

Protected Attributes
SoundSceneClass *	m_Scene
SoundCullObjClass *	m_PhysWrapper
AudioCallbackClass *	m_pCallback
AudioCallbackClass::EVENTS	m_RegisteredEvents
uint32	m_ID
RenderObjClass *	m_AttachedObject
int	m_AttachedBone
uint32	m_UserData
RefCountClass *	m_UserObj

Static Protected Attributes
static DynamicVectorClass< SoundSceneObjClass * >	m_GlobalSoundList
static uint32	m_NextAvailableID = SOUND_OBJ_START_ID
static CriticalSectionClass	m_IDListMutex

Friends
class	SoundSceneClass
class	WWAudioClass
class	HandleMgrClass

Additional Inherited Members
Static Public Member Functions inherited from RefCountClass
static int	Total_Refs (void)
static RefCountClass *	Add_Active_Ref (RefCountClass *obj)
static RefCountClass *	Set_Ref_Owner (RefCountClass *obj, char *file, int line)
static void	Remove_Active_Ref (RefCountClass *obj)
static bool	Validate_Active_Ref (RefCountClass *obj)
Public Attributes inherited from RefCountClass
RefCountNodeClass	ActiveRefNode
ActiveRefStruct	ActiveRefInfo
Static Public Attributes inherited from RefCountClass
static RefCountListClass	ActiveRefList

Detailed Description

Definition at line 81 of file SoundSceneObj.h.

Constructor & Destructor Documentation

SoundSceneObjClass() [1/2]

SoundSceneObjClass::SoundSceneObjClass

(

void

)

Definition at line 91 of file SoundSceneObj.cpp.

SoundSceneObjClass() [2/2]

SoundSceneObjClass::SoundSceneObjClass

(

const SoundSceneObjClass &

src

)

Definition at line 113 of file SoundSceneObj.cpp.

~SoundSceneObjClass()

SoundSceneObjClass::~SoundSceneObjClass ( void )

virtual

Definition at line 136 of file SoundSceneObj.cpp.

Member Function Documentation

Add_To_Scene()

virtual void SoundSceneObjClass::Add_To_Scene ( bool start_playing = true )

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, LogicalSoundClass, and Sound3DClass.

Apply_Auto_Position()

void SoundSceneObjClass::Apply_Auto_Position ( void )

virtual

Definition at line 224 of file SoundSceneObj.cpp.

As_AudibleSoundClass()

virtual AudibleSoundClass * SoundSceneObjClass::As_AudibleSoundClass ( void )

inlinevirtual

Reimplemented in AudibleSoundClass.

Definition at line 115 of file SoundSceneObj.h.

As_FilteredSoundClass()

virtual FilteredSoundClass * SoundSceneObjClass::As_FilteredSoundClass ( void )

inlinevirtual

Reimplemented in FilteredSoundClass.

Definition at line 113 of file SoundSceneObj.h.

As_Listener3DClass()

virtual Listener3DClass * SoundSceneObjClass::As_Listener3DClass ( void )

inlinevirtual

Reimplemented in Listener3DClass.

Definition at line 114 of file SoundSceneObj.h.

As_Sound3DClass()

virtual Sound3DClass * SoundSceneObjClass::As_Sound3DClass ( void )

inlinevirtual

Reimplemented in Sound3DClass.

Definition at line 111 of file SoundSceneObj.h.

As_SoundPseudo3DClass()

virtual SoundPseudo3DClass * SoundSceneObjClass::As_SoundPseudo3DClass ( void )

inlinevirtual

Reimplemented in SoundPseudo3DClass.

Definition at line 112 of file SoundSceneObj.h.

Attach_To_Object() [1/2]

void SoundSceneObjClass::Attach_To_Object ( RenderObjClass * render_obj, const char * bone_name )

virtual

Definition at line 170 of file SoundSceneObj.cpp.

Attach_To_Object() [2/2]

void SoundSceneObjClass::Attach_To_Object ( RenderObjClass * render_obj, int bone_index = -1 )

virtual

Definition at line 194 of file SoundSceneObj.cpp.

Cull_Sound()

virtual void SoundSceneObjClass::Cull_Sound ( bool culled = true )

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, and LogicalSoundClass.

Find_Sound_Object()

bool SoundSceneObjClass::Find_Sound_Object ( uint32 id_to_find, int * index )

staticprotected

Definition at line 453 of file SoundSceneObj.cpp.

Get_DropOff_Radius()

virtual float SoundSceneObjClass::Get_DropOff_Radius ( void ) const

pure virtual

Implemented in AudibleSoundClass, Listener3DClass, LogicalListenerClass, LogicalSoundClass, and SoundPseudo3DClass.

Get_ID()

virtual uint32 SoundSceneObjClass::Get_ID ( void ) const

inlinevirtual

Definition at line 120 of file SoundSceneObj.h.

Get_Parent_Bone()

virtual int SoundSceneObjClass::Get_Parent_Bone ( void )

inlinevirtual

Definition at line 163 of file SoundSceneObj.h.

Get_Position()

virtual Vector3 SoundSceneObjClass::Get_Position ( void ) const

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, LogicalSoundClass, and Sound3DClass.

Get_Transform()

virtual Matrix3D SoundSceneObjClass::Get_Transform ( void ) const

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, LogicalSoundClass, and Sound3DClass.

Get_User_Data()

virtual uint32 SoundSceneObjClass::Get_User_Data ( void ) const

inlinevirtual

Definition at line 154 of file SoundSceneObj.h.

Is_In_Scene()

virtual bool SoundSceneObjClass::Is_In_Scene ( void ) const

inlinevirtual

Definition at line 171 of file SoundSceneObj.h.

Is_Sound_Culled()

virtual bool SoundSceneObjClass::Is_Sound_Culled ( void ) const

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, and LogicalSoundClass.

Load()

bool SoundSceneObjClass::Load ( ChunkLoadClass & cload )

virtual

Reimplemented from PersistClass.

Definition at line 287 of file SoundSceneObj.cpp.

On_Event()

__inline void SoundSceneObjClass::On_Event ( AudioCallbackClass::EVENTS event, uint32 param1 = 0, uint32 param2 = 0 )

virtual

Definition at line 230 of file SoundSceneObj.h.

On_Frame_Update()

bool SoundSceneObjClass::On_Frame_Update ( unsigned int milliseconds = 0 )

virtual

Reimplemented in AudibleSoundClass, LogicalSoundClass, Sound3DClass, and SoundPseudo3DClass.

Definition at line 353 of file SoundSceneObj.cpp.

operator=()

const SoundSceneObjClass & SoundSceneObjClass::operator=

(

const SoundSceneObjClass &

src

)

Definition at line 151 of file SoundSceneObj.cpp.

Peek_Cullable_Wrapper()

virtual SoundCullObjClass * SoundSceneObjClass::Peek_Cullable_Wrapper ( void ) const

inlineprotectedvirtual

Reimplemented in Sound3DClass.

Definition at line 194 of file SoundSceneObj.h.

Peek_Parent_Object()

virtual RenderObjClass * SoundSceneObjClass::Peek_Parent_Object ( void )

inlinevirtual

Definition at line 162 of file SoundSceneObj.h.

Peek_User_Obj()

virtual RefCountClass * SoundSceneObjClass::Peek_User_Obj ( void ) const

inlinevirtual

Definition at line 155 of file SoundSceneObj.h.

Register_Callback()

__inline void SoundSceneObjClass::Register_Callback ( AudioCallbackClass::EVENTS events, AudioCallbackClass * callback )

virtual

Definition at line 265 of file SoundSceneObj.h.

Register_Sound_Object()

void SoundSceneObjClass::Register_Sound_Object ( SoundSceneObjClass * sound_obj )

staticprotected

Definition at line 392 of file SoundSceneObj.cpp.

Remove_From_Scene()

virtual void SoundSceneObjClass::Remove_From_Scene ( void )

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, LogicalSoundClass, and Sound3DClass.

Save()

bool SoundSceneObjClass::Save ( ChunkSaveClass & csave )

virtual

Reimplemented from PersistClass.

Definition at line 264 of file SoundSceneObj.cpp.

Set_Cullable_Wrapper()

virtual void SoundSceneObjClass::Set_Cullable_Wrapper ( SoundCullObjClass * obj )

inlineprotectedvirtual

Reimplemented in Sound3DClass.

Definition at line 195 of file SoundSceneObj.h.

Set_DropOff_Radius()

virtual void SoundSceneObjClass::Set_DropOff_Radius ( float radius = 1 )

pure virtual

Implemented in AudibleSoundClass, Listener3DClass, LogicalListenerClass, LogicalSoundClass, Sound3DClass, and SoundPseudo3DClass.

Set_ID()

void SoundSceneObjClass::Set_ID ( uint32 id )

virtual

Definition at line 366 of file SoundSceneObj.cpp.

Set_Listener_Transform()

virtual void SoundSceneObjClass::Set_Listener_Transform ( const Matrix3D & tm )

inlinevirtual

Reimplemented in AudibleSoundClass, Sound3DClass, and SoundPseudo3DClass.

Definition at line 140 of file SoundSceneObj.h.

Set_Position()

virtual void SoundSceneObjClass::Set_Position ( const Vector3 & position )

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, LogicalSoundClass, Sound3DClass, and SoundPseudo3DClass.

Set_Transform()

virtual void SoundSceneObjClass::Set_Transform ( const Matrix3D & transform )

pure virtual

Implemented in AudibleSoundClass, LogicalListenerClass, LogicalSoundClass, Sound3DClass, and SoundPseudo3DClass.

Set_User_Data()

virtual void SoundSceneObjClass::Set_User_Data ( RefCountClass * user_obj = NULL, uint32 user = 0 )

inlinevirtual

Definition at line 153 of file SoundSceneObj.h.

Unregister_Sound_Object()

void SoundSceneObjClass::Unregister_Sound_Object ( SoundSceneObjClass * sound_obj )

staticprotected

Definition at line 427 of file SoundSceneObj.cpp.

Friends And Related Symbol Documentation

HandleMgrClass

friend class HandleMgrClass

friend

Definition at line 90 of file SoundSceneObj.h.

SoundSceneClass

friend class SoundSceneClass

friend

Definition at line 88 of file SoundSceneObj.h.

WWAudioClass

friend class WWAudioClass

friend

Definition at line 89 of file SoundSceneObj.h.

Member Data Documentation

m_AttachedBone

int SoundSceneObjClass::m_AttachedBone

protected

Definition at line 214 of file SoundSceneObj.h.

m_AttachedObject

RenderObjClass* SoundSceneObjClass::m_AttachedObject

protected

Definition at line 213 of file SoundSceneObj.h.

m_GlobalSoundList

DynamicVectorClass< SoundSceneObjClass * > SoundSceneObjClass::m_GlobalSoundList

staticprotected

Definition at line 218 of file SoundSceneObj.h.

m_ID

uint32 SoundSceneObjClass::m_ID

protected

Definition at line 211 of file SoundSceneObj.h.

m_IDListMutex

CriticalSectionClass SoundSceneObjClass::m_IDListMutex

staticprotected

Definition at line 220 of file SoundSceneObj.h.

m_NextAvailableID

uint32 SoundSceneObjClass::m_NextAvailableID = SOUND_OBJ_START_ID

staticprotected

Definition at line 219 of file SoundSceneObj.h.

m_pCallback

AudioCallbackClass* SoundSceneObjClass::m_pCallback

protected

Definition at line 209 of file SoundSceneObj.h.

m_PhysWrapper

SoundCullObjClass* SoundSceneObjClass::m_PhysWrapper

protected

Definition at line 208 of file SoundSceneObj.h.

m_RegisteredEvents

AudioCallbackClass::EVENTS SoundSceneObjClass::m_RegisteredEvents

protected

Definition at line 210 of file SoundSceneObj.h.

m_Scene

SoundSceneClass* SoundSceneObjClass::m_Scene

protected

Definition at line 207 of file SoundSceneObj.h.

m_UserData

uint32 SoundSceneObjClass::m_UserData

protected

Definition at line 215 of file SoundSceneObj.h.

m_UserObj

RefCountClass* SoundSceneObjClass::m_UserObj

protected

Definition at line 216 of file SoundSceneObj.h.

---

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

• Code/Libraries/Source/WWVegas/WWAudio/SoundSceneObj.h
• Code/Libraries/Source/WWVegas/WWAudio/SoundSceneObj.cpp