LogicalSoundClass Class Reference

#include <LogicalSound.h>

Inherits SoundSceneObjClass.

Public Member Functions
	LogicalSoundClass (void)
virtual	~LogicalSoundClass (void)
virtual bool	Is_Single_Shot (void) const
virtual void	Set_Single_Shot (bool single_shot)
virtual void	Set_Type_Mask (uint32 mask=0)
virtual uint32	Get_Type_Mask (void) const
virtual float	Get_Notify_Delay (void) const
virtual void	Set_Notify_Delay (float secs)
virtual bool	Allow_Notify (uint32 timestamp)
virtual uint32	Get_Listener_Timestamp (void) const
virtual void	Set_Listener_Timestamp (int timestamp)
virtual bool	On_Frame_Update (unsigned int milliseconds=0)
virtual void	Set_Position (const Vector3 &position)
virtual Vector3	Get_Position (void) const
virtual void	Set_Transform (const Matrix3D &transform)
virtual Matrix3D	Get_Transform (void) const
virtual void	Cull_Sound (bool culled=true)
virtual bool	Is_Sound_Culled (void) const
virtual void	Add_To_Scene (bool start_playing=true)
virtual void	Remove_From_Scene (void)
virtual void	Set_DropOff_Radius (float radius=1)
virtual float	Get_DropOff_Radius (void) const
bool	Save (ChunkSaveClass &csave)
bool	Load (ChunkLoadClass &cload)
const PersistFactoryClass &	Get_Factory (void) const
Public Member Functions inherited from SoundSceneObjClass
	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 void	On_Event (AudioCallbackClass::EVENTS event, uint32 param1=0, uint32 param2=0)
virtual void	Register_Callback (AudioCallbackClass::EVENTS events, AudioCallbackClass *callback)
virtual void	Set_Listener_Transform (const Matrix3D &tm)
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 bool	Is_In_Scene (void) const
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 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)

Friends
class	SoundSceneClass

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
Protected Member Functions inherited from SoundSceneObjClass
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 inherited from SoundSceneObjClass
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 inherited from SoundSceneObjClass
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 inherited from SoundSceneObjClass
static DynamicVectorClass< SoundSceneObjClass * >	m_GlobalSoundList
static uint32	m_NextAvailableID = SOUND_OBJ_START_ID
static CriticalSectionClass	m_IDListMutex

Detailed Description

Definition at line 52 of file LogicalSound.h.

Constructor & Destructor Documentation

LogicalSoundClass()

LogicalSoundClass::LogicalSoundClass

(

void

)

Definition at line 73 of file LogicalSound.cpp.

~LogicalSoundClass()

LogicalSoundClass::~LogicalSoundClass ( void )

virtual

Definition at line 92 of file LogicalSound.cpp.

Member Function Documentation

Add_To_Scene()

void LogicalSoundClass::Add_To_Scene ( bool start_playing = true )

virtual

Implements SoundSceneObjClass.

Definition at line 104 of file LogicalSound.cpp.

Allow_Notify()

bool LogicalSoundClass::Allow_Notify ( uint32 timestamp )

virtual

Definition at line 149 of file LogicalSound.cpp.

Cull_Sound()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 104 of file LogicalSound.h.

Get_DropOff_Radius()

virtual float LogicalSoundClass::Get_DropOff_Radius ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 121 of file LogicalSound.h.

Get_Factory()

const PersistFactoryClass & LogicalSoundClass::Get_Factory ( void ) const

virtual

Implements PersistClass.

Definition at line 184 of file LogicalSound.cpp.

Get_Listener_Timestamp()

virtual uint32 LogicalSoundClass::Get_Listener_Timestamp ( void ) const

inlinevirtual

Definition at line 84 of file LogicalSound.h.

Get_Notify_Delay()

virtual float LogicalSoundClass::Get_Notify_Delay ( void ) const

inlinevirtual

Definition at line 80 of file LogicalSound.h.

Get_Position()

virtual Vector3 LogicalSoundClass::Get_Position ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 96 of file LogicalSound.h.

Get_Transform()

virtual Matrix3D LogicalSoundClass::Get_Transform ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 99 of file LogicalSound.h.

Get_Type_Mask()

virtual uint32 LogicalSoundClass::Get_Type_Mask ( void ) const

inlinevirtual

Definition at line 78 of file LogicalSound.h.

Is_Single_Shot()

virtual bool LogicalSoundClass::Is_Single_Shot ( void ) const

inlinevirtual

Definition at line 74 of file LogicalSound.h.

Is_Sound_Culled()

virtual bool LogicalSoundClass::Is_Sound_Culled ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 105 of file LogicalSound.h.

Load()

bool LogicalSoundClass::Load ( ChunkLoadClass & cload )

virtual

Reimplemented from PersistClass.

Definition at line 223 of file LogicalSound.cpp.

On_Frame_Update()

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

virtual

Reimplemented from SoundSceneObjClass.

Definition at line 168 of file LogicalSound.cpp.

Remove_From_Scene()

void LogicalSoundClass::Remove_From_Scene ( void )

virtual

Implements SoundSceneObjClass.

Definition at line 126 of file LogicalSound.cpp.

Save()

bool LogicalSoundClass::Save ( ChunkSaveClass & csave )

virtual

Reimplemented from PersistClass.

Definition at line 196 of file LogicalSound.cpp.

Set_DropOff_Radius()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 120 of file LogicalSound.h.

Set_Listener_Timestamp()

virtual void LogicalSoundClass::Set_Listener_Timestamp ( int timestamp )

inlinevirtual

Definition at line 85 of file LogicalSound.h.

Set_Notify_Delay()

virtual void LogicalSoundClass::Set_Notify_Delay ( float secs )

inlinevirtual

Definition at line 81 of file LogicalSound.h.

Set_Position()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 95 of file LogicalSound.h.

Set_Single_Shot()

virtual void LogicalSoundClass::Set_Single_Shot ( bool single_shot )

inlinevirtual

Definition at line 75 of file LogicalSound.h.

Set_Transform()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 98 of file LogicalSound.h.

Set_Type_Mask()

virtual void LogicalSoundClass::Set_Type_Mask ( uint32 mask = 0 )

inlinevirtual

Definition at line 77 of file LogicalSound.h.

Friends And Related Symbol Documentation

SoundSceneClass

friend class SoundSceneClass

friend

Definition at line 59 of file LogicalSound.h.

---

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

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