Sound3DClass Class Reference

#include <Sound3D.h>

Inherits AudibleSoundClass.

Inherited by Listener3DClass, and SoundPseudo3DClass.

Public Member Functions
	Sound3DClass (const Sound3DClass &src)
	Sound3DClass (void)
virtual	~Sound3DClass (void)
const Sound3DClass &	operator= (const Sound3DClass &src)
virtual SOUND_CLASSID	Get_Class_ID (void) const
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 void	Set_Velocity (const Vector3 &velocity)
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
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 ()
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 bool	Pause (void)
virtual bool	Resume (void)
virtual bool	Stop (bool remove_from_playlist=true)
virtual void	Seek (unsigned long milliseconds)
virtual SOUND_STATE	Get_State (void) const
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 float	Get_DropOff_Radius (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 Listener3DClass *	As_Listener3DClass (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 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	Initialize_Miles_Handle (void)
virtual void	Allocate_Miles_Handle (void)
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 void	Free_Miles_Handle (void)
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)

Protected Attributes
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

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)
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 60 of file Sound3D.h.

Constructor & Destructor Documentation

Sound3DClass() [1/2]

Sound3DClass::Sound3DClass

(

const Sound3DClass &

src

)

Definition at line 97 of file Sound3D.cpp.

Sound3DClass() [2/2]

Sound3DClass::Sound3DClass

(

void

)

Definition at line 80 of file Sound3D.cpp.

~Sound3DClass()

Sound3DClass::~Sound3DClass ( void )

virtual

Definition at line 116 of file Sound3D.cpp.

Member Function Documentation

Add_To_Scene()

void Sound3DClass::Add_To_Scene ( bool start_playing = true )

virtual

Reimplemented from AudibleSoundClass.

Definition at line 569 of file Sound3D.cpp.

Allocate_Miles_Handle()

void Sound3DClass::Allocate_Miles_Handle ( void )

protectedvirtual

Reimplemented from AudibleSoundClass.

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 548 of file Sound3D.cpp.

As_Sound3DClass()

virtual Sound3DClass * Sound3DClass::As_Sound3DClass ( void )

inlinevirtual

Reimplemented from SoundSceneObjClass.

Definition at line 92 of file Sound3D.h.

Auto_Calc_Velocity()

virtual void Sound3DClass::Auto_Calc_Velocity ( bool autocalc = true )

inlinevirtual

Definition at line 132 of file Sound3D.h.

Get_Class_ID()

virtual SOUND_CLASSID Sound3DClass::Get_Class_ID ( void ) const

inlinevirtual

Reimplemented from AudibleSoundClass.

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 85 of file Sound3D.h.

Get_DropOff_Radius()

virtual float Sound3DClass::Get_DropOff_Radius ( void )

inlinevirtual

Reimplemented in Listener3DClass.

Definition at line 153 of file Sound3D.h.

Get_Factory()

const PersistFactoryClass & Sound3DClass::Get_Factory ( void ) const

virtual

Reimplemented from AudibleSoundClass.

Reimplemented in SoundPseudo3DClass.

Definition at line 631 of file Sound3D.cpp.

Get_Max_Vol_Radius()

virtual float Sound3DClass::Get_Max_Vol_Radius ( void ) const

inlinevirtual

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 147 of file Sound3D.h.

Get_Position()

virtual Vector3 Sound3DClass::Get_Position ( void ) const

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 114 of file Sound3D.h.

Get_Priority()

virtual float Sound3DClass::Get_Priority ( void ) const

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 102 of file Sound3D.h.

Get_Transform()

virtual Matrix3D Sound3DClass::Get_Transform ( void ) const

inlinevirtual

Reimplemented from AudibleSoundClass.

Definition at line 118 of file Sound3D.h.

Get_Velocity() [1/2]

virtual void Sound3DClass::Get_Velocity ( Vector3 & velocity ) const

inlinevirtual

Definition at line 130 of file Sound3D.h.

Get_Velocity() [2/2]

virtual Vector3 Sound3DClass::Get_Velocity ( void ) const

inlinevirtual

Definition at line 129 of file Sound3D.h.

Initialize_Miles_Handle()

void Sound3DClass::Initialize_Miles_Handle ( void )

protectedvirtual

Reimplemented from AudibleSoundClass.

Reimplemented in FilteredSoundClass, Listener3DClass, and SoundPseudo3DClass.

Definition at line 461 of file Sound3D.cpp.

Is_Auto_Calc_Velocity_On()

virtual bool Sound3DClass::Is_Auto_Calc_Velocity_On ( void ) const

inlinevirtual

Definition at line 133 of file Sound3D.h.

Is_Static()

virtual bool Sound3DClass::Is_Static ( void ) const

inlinevirtual

Definition at line 87 of file Sound3D.h.

Load()

bool Sound3DClass::Load ( ChunkLoadClass & cload )

virtual

Reimplemented from AudibleSoundClass.

Definition at line 669 of file Sound3D.cpp.

Make_Static()

virtual void Sound3DClass::Make_Static ( bool is_static = true )

inlinevirtual

Definition at line 86 of file Sound3D.h.

On_Frame_Update()

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

protectedvirtual

Reimplemented from AudibleSoundClass.

Reimplemented in SoundPseudo3DClass.

Definition at line 167 of file Sound3D.cpp.

On_Loop_End()

void Sound3DClass::On_Loop_End ( void )

protectedvirtual

Reimplemented from AudibleSoundClass.

Reimplemented in SoundPseudo3DClass.

Definition at line 618 of file Sound3D.cpp.

operator=()

const Sound3DClass & Sound3DClass::operator=

(

const Sound3DClass &

src

)

Definition at line 129 of file Sound3D.cpp.

Peek_Cullable_Wrapper()

virtual SoundCullObjClass * Sound3DClass::Peek_Cullable_Wrapper ( void ) const

inlineprotectedvirtual

Reimplemented from SoundSceneObjClass.

Definition at line 169 of file Sound3D.h.

Play()

bool Sound3DClass::Play ( bool alloc_handle = true )

virtual

Reimplemented from AudibleSoundClass.

Definition at line 149 of file Sound3D.cpp.

Remove_From_Scene()

void Sound3DClass::Remove_From_Scene ( void )

virtual

Reimplemented from AudibleSoundClass.

Definition at line 593 of file Sound3D.cpp.

Save()

bool Sound3DClass::Save ( ChunkSaveClass & csave )

virtual

Reimplemented from AudibleSoundClass.

Definition at line 643 of file Sound3D.cpp.

Set_Cullable_Wrapper()

virtual void Sound3DClass::Set_Cullable_Wrapper ( SoundCullObjClass * obj )

inlineprotectedvirtual

Reimplemented from SoundSceneObjClass.

Definition at line 170 of file Sound3D.h.

Set_DropOff_Radius()

void Sound3DClass::Set_DropOff_Radius ( float radius = 1 )

virtual

Reimplemented from AudibleSoundClass.

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 415 of file Sound3D.cpp.

Set_Listener_Transform()

void Sound3DClass::Set_Listener_Transform ( const Matrix3D & tm )

virtual

Reimplemented from AudibleSoundClass.

Reimplemented in SoundPseudo3DClass.

Definition at line 261 of file Sound3D.cpp.

Set_Max_Vol_Radius()

void Sound3DClass::Set_Max_Vol_Radius ( float radius = 0 )

virtual

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 439 of file Sound3D.cpp.

Set_Miles_Handle()

void Sound3DClass::Set_Miles_Handle ( MILES_HANDLE handle )

protectedvirtual

Reimplemented from AudibleSoundClass.

Reimplemented in SoundPseudo3DClass.

Definition at line 711 of file Sound3D.cpp.

Set_Position()

void Sound3DClass::Set_Position ( const Vector3 & position )

virtual

Reimplemented from AudibleSoundClass.

Reimplemented in SoundPseudo3DClass.

Definition at line 337 of file Sound3D.cpp.

Set_Transform()

void Sound3DClass::Set_Transform ( const Matrix3D & transform )

virtual

Reimplemented from AudibleSoundClass.

Reimplemented in SoundPseudo3DClass.

Definition at line 233 of file Sound3D.cpp.

Set_Velocity()

void Sound3DClass::Set_Velocity ( const Vector3 & velocity )

virtual

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 386 of file Sound3D.cpp.

Update_Miles_Transform()

void Sound3DClass::Update_Miles_Transform

(

void

)

Definition at line 283 of file Sound3D.cpp.

Friends And Related Symbol Documentation

SoundSceneClass

friend class SoundSceneClass

friend

Definition at line 67 of file Sound3D.h.

Member Data Documentation

m_bAutoCalcVel

bool Sound3DClass::m_bAutoCalcVel

protected

Definition at line 193 of file Sound3D.h.

m_CurrentVelocity

Vector3 Sound3DClass::m_CurrentVelocity

protected

Definition at line 194 of file Sound3D.h.

m_IsStatic

bool Sound3DClass::m_IsStatic

protected

Definition at line 196 of file Sound3D.h.

m_IsTransformInitted

bool Sound3DClass::m_IsTransformInitted

protected

Definition at line 192 of file Sound3D.h.

m_LastUpdate

unsigned int Sound3DClass::m_LastUpdate

protected

Definition at line 197 of file Sound3D.h.

m_MaxVolRadius

float Sound3DClass::m_MaxVolRadius

protected

Definition at line 195 of file Sound3D.h.

---

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

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