#include <LogicalListener.h>

Inherits SoundSceneObjClass.

Public Member Functions
	LogicalListenerClass (void)

virtual	~LogicalListenerClass (void)

virtual void	Set_Type_Mask (uint32 mask=0)

virtual uint32	Get_Type_Mask (void) const

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=true)

virtual void	Remove_From_Scene (void)

virtual void	Set_Scale (float scale=1.0F)

virtual float	Get_Scale (void) const

virtual float	Get_Effective_Scale (void) const

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

uint32	Get_Timestamp (void) const

void	Set_Timestamp (int timestamp)

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 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_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)

Static Public Member Functions
static float	Get_Global_Scale (void)

static void	Set_Global_Scale (float scale)

static uint32	Get_New_Timestamp (void)

static uint32	Get_Newest_Timestamp (void)

static uint32	Get_Oldest_Timestamp (void)

static void	Set_Oldest_Timestamp (uint32 timestamp)

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)

Additional Inherited Members
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 53 of file LogicalListener.h.

Constructor & Destructor Documentation

◆ LogicalListenerClass()

LogicalListenerClass::LogicalListenerClass ( void )

Definition at line 80 of file LogicalListener.cpp.

◆ ~LogicalListenerClass()

LogicalListenerClass::~LogicalListenerClass ( void )

virtual

Definition at line 95 of file LogicalListener.cpp.

Member Function Documentation

◆ Add_To_Scene()

void LogicalListenerClass::Add_To_Scene ( bool = true )

virtual

Implements SoundSceneObjClass.

Definition at line 107 of file LogicalListener.cpp.

◆ Cull_Sound()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 85 of file LogicalListener.h.

◆ Get_DropOff_Radius()

virtual float LogicalListenerClass::Get_DropOff_Radius ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 109 of file LogicalListener.h.

◆ Get_Effective_Scale()

virtual float LogicalListenerClass::Get_Effective_Scale ( void ) const

inlinevirtual

Definition at line 103 of file LogicalListener.h.

◆ Get_Factory()

const PersistFactoryClass & LogicalListenerClass::Get_Factory ( void ) const

virtual

Implements PersistClass.

Definition at line 151 of file LogicalListener.cpp.

◆ Get_Global_Scale()

static float LogicalListenerClass::Get_Global_Scale ( void )

inlinestatic

Definition at line 105 of file LogicalListener.h.

◆ Get_New_Timestamp()

static uint32 LogicalListenerClass::Get_New_Timestamp ( void )

inlinestatic

Definition at line 125 of file LogicalListener.h.

◆ Get_Newest_Timestamp()

static uint32 LogicalListenerClass::Get_Newest_Timestamp ( void )

inlinestatic

Definition at line 126 of file LogicalListener.h.

◆ Get_Oldest_Timestamp()

static uint32 LogicalListenerClass::Get_Oldest_Timestamp ( void )

inlinestatic

Definition at line 128 of file LogicalListener.h.

◆ Get_Position()

virtual Vector3 LogicalListenerClass::Get_Position ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 77 of file LogicalListener.h.

◆ Get_Scale()

virtual float LogicalListenerClass::Get_Scale ( void ) const

inlinevirtual

Definition at line 102 of file LogicalListener.h.

◆ Get_Timestamp()

uint32 LogicalListenerClass::Get_Timestamp ( void ) const

inline

Definition at line 122 of file LogicalListener.h.

◆ Get_Transform()

virtual Matrix3D LogicalListenerClass::Get_Transform ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 80 of file LogicalListener.h.

◆ Get_Type_Mask()

virtual uint32 LogicalListenerClass::Get_Type_Mask ( void ) const

inlinevirtual

Definition at line 71 of file LogicalListener.h.

◆ Is_Sound_Culled()

virtual bool LogicalListenerClass::Is_Sound_Culled ( void ) const

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 86 of file LogicalListener.h.

◆ Load()

bool LogicalListenerClass::Load ( ChunkLoadClass & cload )

virtual

Reimplemented from PersistClass.

Definition at line 186 of file LogicalListener.cpp.

◆ Remove_From_Scene()

void LogicalListenerClass::Remove_From_Scene ( void )

virtual

Implements SoundSceneObjClass.

Definition at line 129 of file LogicalListener.cpp.

◆ Save()

bool LogicalListenerClass::Save ( ChunkSaveClass & csave )

virtual

Reimplemented from PersistClass.

Definition at line 163 of file LogicalListener.cpp.

◆ Set_DropOff_Radius()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 108 of file LogicalListener.h.

◆ Set_Global_Scale()

static void LogicalListenerClass::Set_Global_Scale ( float scale )

inlinestatic

Definition at line 106 of file LogicalListener.h.

◆ Set_Oldest_Timestamp()

static void LogicalListenerClass::Set_Oldest_Timestamp ( uint32 timestamp )

inlinestatic

Definition at line 129 of file LogicalListener.h.

◆ Set_Position()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 76 of file LogicalListener.h.

◆ Set_Scale()

virtual void LogicalListenerClass::Set_Scale ( float scale = 1.0F )

inlinevirtual

Definition at line 101 of file LogicalListener.h.

◆ Set_Timestamp()

void LogicalListenerClass::Set_Timestamp ( int timestamp )

inline

Definition at line 123 of file LogicalListener.h.

◆ Set_Transform()

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

inlinevirtual

Implements SoundSceneObjClass.

Definition at line 79 of file LogicalListener.h.

◆ Set_Type_Mask()

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

inlinevirtual

Definition at line 70 of file LogicalListener.h.

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

Code/Libraries/Source/WWVegas/WWAudio/LogicalListener.h
Code/Libraries/Source/WWVegas/WWAudio/LogicalListener.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LogicalListenerClass()

◆ ~LogicalListenerClass()

Member Function Documentation

◆ Add_To_Scene()

◆ Cull_Sound()

◆ Get_DropOff_Radius()

◆ Get_Effective_Scale()

◆ Get_Factory()

◆ Get_Global_Scale()

◆ Get_New_Timestamp()

◆ Get_Newest_Timestamp()

◆ Get_Oldest_Timestamp()

◆ Get_Position()

◆ Get_Scale()

◆ Get_Timestamp()

◆ Get_Transform()

◆ Get_Type_Mask()

◆ Is_Sound_Culled()

◆ Load()

◆ Remove_From_Scene()

◆ Save()

◆ Set_DropOff_Radius()

◆ Set_Global_Scale()

◆ Set_Oldest_Timestamp()

◆ Set_Position()

◆ Set_Scale()

◆ Set_Timestamp()

◆ Set_Transform()

◆ Set_Type_Mask()