Listener3DClass Class Reference

#include <Listener.h>

Inherits Sound3DClass.

Public Member Functions
	Listener3DClass (void)
virtual	~Listener3DClass (void)
virtual SOUND_CLASSID	Get_Class_ID (void) const
virtual Listener3DClass *	As_Listener3DClass (void)
virtual void	On_Added_To_Scene (void)
virtual void	On_Removed_From_Scene (void)
virtual bool	Pause (void)
virtual bool	Resume (void)
virtual bool	Stop (bool)
virtual void	Seek (unsigned long milliseconds)
virtual SOUND_STATE	Get_State (void) const
virtual void	Set_Max_Vol_Radius (float radius=0)
virtual float	Get_Max_Vol_Radius (void) const
virtual void	Set_DropOff_Radius (float radius=1)
virtual float	Get_DropOff_Radius (void) const
virtual void	Set_Velocity (const Vector3 &velocity)
Public Member Functions inherited from Sound3DClass
	Sound3DClass (const Sound3DClass &src)
	Sound3DClass (void)
virtual	~Sound3DClass (void)
const Sound3DClass &	operator= (const Sound3DClass &src)
virtual void	Make_Static (bool is_static=true)
virtual bool	Is_Static (void) const
virtual Sound3DClass *	As_Sound3DClass (void)
virtual bool	Play (bool alloc_handle=true)
virtual float	Get_Priority (void) const
virtual void	Add_To_Scene (bool start_playing=true)
virtual void	Remove_From_Scene (void)
virtual void	Set_Position (const Vector3 &position)
virtual Vector3	Get_Position (void) const
virtual void	Set_Listener_Transform (const Matrix3D &tm)
virtual void	Set_Transform (const Matrix3D &transform)
virtual Matrix3D	Get_Transform (void) const
void	Update_Miles_Transform (void)
virtual Vector3	Get_Velocity (void) const
virtual void	Get_Velocity (Vector3 &velocity) const
virtual void	Auto_Calc_Velocity (bool autocalc=true)
virtual bool	Is_Auto_Calc_Velocity_On (void) const
const PersistFactoryClass &	Get_Factory (void) const
virtual bool	Save (ChunkSaveClass &csave)
virtual bool	Load (ChunkLoadClass &cload)
Public Member Functions inherited from AudibleSoundClass
	AudibleSoundClass (const AudibleSoundClass &src)
	AudibleSoundClass (void)
virtual	~AudibleSoundClass (void)
const AudibleSoundClass &	operator= (const AudibleSoundClass &src)
virtual SOUND_TYPE	Get_Type (void) const
virtual void	Set_Type (SOUND_TYPE type)
virtual AudibleSoundClass *	As_AudibleSoundClass (void)
virtual unsigned long	Get_Timestamp (void) const
virtual LPCTSTR	Get_Filename (void) const
virtual bool	Is_Playing (void) const
virtual float	Get_Pan (void)
virtual void	Set_Pan (float pan=0.5F)
virtual float	Get_Volume (void)
virtual void	Set_Volume (float volume=1.0F)
virtual void	Update_Volume (void)
virtual int	Get_Loop_Count (void) const
virtual int	Get_Loops_Left (void) const
virtual void	Set_Loop_Count (int count=1)
virtual float	Peek_Priority (void) const
virtual void	Set_Priority (float priority=0.5F)
virtual float	Get_Runtime_Priority (void) const
virtual void	Set_Runtime_Priority (float priority)
virtual int	Get_Playback_Rate (void)
virtual void	Set_Playback_Rate (int rate_in_hz)
virtual float	Get_Pitch_Factor (void)
virtual void	Set_Pitch_Factor (float factor)
virtual unsigned long	Get_Duration (void) const
virtual unsigned long	Get_Play_Position (void) const
virtual void	Set_Play_Position (float position)
virtual void	Set_Play_Position (unsigned long milliseconds)
virtual void	Set_Start_Offset (float offset)
virtual float	Get_Start_Offset (void) const
virtual void	Cull_Sound (bool culled=true)
virtual bool	Is_Sound_Culled (void) const
virtual void	Set_Dirty (bool dirty=true)
virtual bool	Is_Dirty (void) const
virtual void	Set_Definition (AudibleSoundDefinitionClass *def)
virtual AudibleSoundDefinitionClass *	Get_Definition (void)
virtual void	Re_Sync (AudibleSoundClass &src)
virtual void	Free_Conversion (void)
virtual void	Convert_To_Filtered (void)
virtual AudibleSoundClass *	As_Converted_Format (void)
Public Member Functions inherited from SoundSceneObjClass
	SoundSceneObjClass (void)
	SoundSceneObjClass (const SoundSceneObjClass &src)
virtual	~SoundSceneObjClass (void)
const SoundSceneObjClass &	operator= (const SoundSceneObjClass &src)
virtual SoundPseudo3DClass *	As_SoundPseudo3DClass (void)
virtual FilteredSoundClass *	As_FilteredSoundClass (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_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)

Protected Member Functions
virtual void	Start_Sample (void)
virtual void	Stop_Sample (void)
virtual void	Resume_Sample (void)
virtual void	End_Sample (void)
virtual void	Set_Sample_Volume (S32 volume)
virtual S32	Get_Sample_Volume (void)
virtual void	Set_Sample_Pan (S32 pan)
virtual S32	Get_Sample_Pan (void)
virtual void	Set_Sample_Loop_Count (U32 count)
virtual U32	Get_Sample_Loop_Count (void)
virtual void	Set_Sample_MS_Position (U32 ms)
virtual void	Get_Sample_MS_Position (S32 *len, S32 *pos)
virtual S32	Get_Sample_Playback_Rate (void)
virtual void	Set_Sample_Playback_Rate (S32 rate)
virtual void	Initialize_Miles_Handle (void)
virtual void	Allocate_Miles_Handle (void)
virtual void	Free_Miles_Handle (void)
Protected Member Functions inherited from Sound3DClass
virtual SoundCullObjClass *	Peek_Cullable_Wrapper (void) const
virtual void	Set_Cullable_Wrapper (SoundCullObjClass *obj)
virtual bool	On_Frame_Update (unsigned int milliseconds=0)
virtual void	Set_Miles_Handle (MILES_HANDLE handle)
virtual void	On_Loop_End (void)
Protected Member Functions inherited from AudibleSoundClass
virtual float	Determine_Real_Volume (void) const
virtual SoundHandleClass *	Get_Miles_Handle (void) const
virtual SoundBufferClass *	Get_Buffer (void) const
virtual SoundBufferClass *	Peek_Buffer (void) const
virtual void	Set_Buffer (SoundBufferClass *buffer)
virtual void	Restart_Loop (void)
virtual void	Update_Play_Position (void)
Protected Member Functions inherited from RefCountClass
virtual	~RefCountClass (void)

Friends
class	SoundSceneClass

Additional Inherited Members
Public Types inherited from AudibleSoundClass
enum	SOUND_TYPE { TYPE_MUSIC = 0 , TYPE_SOUND_EFFECT , TYPE_COUNT }
enum	SOUND_STATE { STATE_STOPPED = 0 , STATE_PLAYING , STATE_PAUSED , STATE_COUNT }
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
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 Sound3DClass
bool	m_IsTransformInitted
bool	m_bAutoCalcVel
Vector3	m_CurrentVelocity
float	m_MaxVolRadius
bool	m_IsStatic
unsigned int	m_LastUpdate
Protected Attributes inherited from AudibleSoundClass
SoundHandleClass *	m_SoundHandle
unsigned long	m_Timestamp
SOUND_STATE	m_State
SOUND_TYPE	m_Type
SoundBufferClass *	m_Buffer
float	m_RuntimePriority
float	m_Priority
float	m_Volume
float	m_Pan
int	m_LoopCount
int	m_LoopsLeft
unsigned long	m_Length
unsigned long	m_CurrentPosition
float	m_StartOffset
float	m_PitchFactor
Matrix3D	m_ListenerTransform
Matrix3D	m_Transform
Matrix3D	m_PrevTransform
bool	m_IsCulled
bool	m_bDirty
float	m_DropOffRadius
AudibleSoundClass *	m_pConvertedFormat
AudibleSoundDefinitionClass *	m_Definition
LogicalSoundClass *	m_LogicalSound
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 56 of file Listener.h.

Constructor & Destructor Documentation

Listener3DClass()

Listener3DClass::Listener3DClass

(

void

)

Definition at line 49 of file Listener.cpp.

~Listener3DClass()

Listener3DClass::~Listener3DClass ( void )

virtual

Definition at line 60 of file Listener.cpp.

Member Function Documentation

Allocate_Miles_Handle()

void Listener3DClass::Allocate_Miles_Handle ( void )

protectedvirtual

Reimplemented from Sound3DClass.

Definition at line 100 of file Listener.cpp.

As_Listener3DClass()

virtual Listener3DClass * Listener3DClass::As_Listener3DClass ( void )

inlinevirtual

Reimplemented from SoundSceneObjClass.

Definition at line 79 of file Listener.h.

End_Sample()

virtual void Listener3DClass::End_Sample ( void )

inlineprotectedvirtual

Definition at line 120 of file Listener.h.

Free_Miles_Handle()

void Listener3DClass::Free_Miles_Handle ( void )

protectedvirtual

Reimplemented from AudibleSoundClass.

Definition at line 112 of file Listener.cpp.

Get_Class_ID()

virtual SOUND_CLASSID Listener3DClass::Get_Class_ID ( void ) const

inlinevirtual

Reimplemented from Sound3DClass.

Definition at line 74 of file Listener.h.

Get_DropOff_Radius()

virtual float Listener3DClass::Get_DropOff_Radius ( void ) const

inlinevirtual

Reimplemented from Sound3DClass.

Definition at line 104 of file Listener.h.

Get_Max_Vol_Radius()

virtual float Listener3DClass::Get_Max_Vol_Radius ( void ) const

inlinevirtual

Reimplemented from Sound3DClass.

Definition at line 102 of file Listener.h.

Get_Sample_Loop_Count()

virtual U32 Listener3DClass::Get_Sample_Loop_Count ( void )

inlineprotectedvirtual

Definition at line 126 of file Listener.h.

Get_Sample_MS_Position()

virtual void Listener3DClass::Get_Sample_MS_Position ( S32 * len, S32 * pos )

inlineprotectedvirtual

Definition at line 128 of file Listener.h.

Get_Sample_Pan()

virtual S32 Listener3DClass::Get_Sample_Pan ( void )

inlineprotectedvirtual

Definition at line 124 of file Listener.h.

Get_Sample_Playback_Rate()

virtual S32 Listener3DClass::Get_Sample_Playback_Rate ( void )

inlineprotectedvirtual

Definition at line 129 of file Listener.h.

Get_Sample_Volume()

virtual S32 Listener3DClass::Get_Sample_Volume ( void )

inlineprotectedvirtual

Definition at line 122 of file Listener.h.

Get_State()

virtual SOUND_STATE Listener3DClass::Get_State ( void ) const

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 95 of file Listener.h.

Initialize_Miles_Handle()

void Listener3DClass::Initialize_Miles_Handle ( void )

protectedvirtual

Reimplemented from Sound3DClass.

Definition at line 73 of file Listener.cpp.

On_Added_To_Scene()

void Listener3DClass::On_Added_To_Scene ( void )

virtual

Definition at line 124 of file Listener.cpp.

On_Removed_From_Scene()

void Listener3DClass::On_Removed_From_Scene ( void )

virtual

Definition at line 137 of file Listener.cpp.

Pause()

virtual bool Listener3DClass::Pause ( void )

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 91 of file Listener.h.

Resume()

virtual bool Listener3DClass::Resume ( void )

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 92 of file Listener.h.

Resume_Sample()

virtual void Listener3DClass::Resume_Sample ( void )

inlineprotectedvirtual

Definition at line 119 of file Listener.h.

Seek()

virtual void Listener3DClass::Seek ( unsigned long milliseconds )

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 94 of file Listener.h.

Set_DropOff_Radius()

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

inlinevirtual

Reimplemented from Sound3DClass.

Definition at line 103 of file Listener.h.

Set_Max_Vol_Radius()

virtual void Listener3DClass::Set_Max_Vol_Radius ( float radius = 0 )

inlinevirtual

Reimplemented from Sound3DClass.

Definition at line 101 of file Listener.h.

Set_Sample_Loop_Count()

virtual void Listener3DClass::Set_Sample_Loop_Count ( U32 count )

inlineprotectedvirtual

Definition at line 125 of file Listener.h.

Set_Sample_MS_Position()

virtual void Listener3DClass::Set_Sample_MS_Position ( U32 ms )

inlineprotectedvirtual

Definition at line 127 of file Listener.h.

Set_Sample_Pan()

virtual void Listener3DClass::Set_Sample_Pan ( S32 pan )

inlineprotectedvirtual

Definition at line 123 of file Listener.h.

Set_Sample_Playback_Rate()

virtual void Listener3DClass::Set_Sample_Playback_Rate ( S32 rate )

inlineprotectedvirtual

Definition at line 130 of file Listener.h.

Set_Sample_Volume()

virtual void Listener3DClass::Set_Sample_Volume ( S32 volume )

inlineprotectedvirtual

Definition at line 121 of file Listener.h.

Set_Velocity()

virtual void Listener3DClass::Set_Velocity ( const Vector3 & velocity )

inlinevirtual

Reimplemented from Sound3DClass.

Definition at line 109 of file Listener.h.

Start_Sample()

virtual void Listener3DClass::Start_Sample ( void )

inlineprotectedvirtual

Definition at line 117 of file Listener.h.

Stop()

virtual bool Listener3DClass::Stop ( bool )

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 93 of file Listener.h.

Stop_Sample()

virtual void Listener3DClass::Stop_Sample ( void )

inlineprotectedvirtual

Definition at line 118 of file Listener.h.

Friends And Related Symbol Documentation

SoundSceneClass

friend class SoundSceneClass

friend

Definition at line 63 of file Listener.h.

---

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

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