#include <FilteredSound.h>

Inherits SoundPseudo3DClass.

Public Member Functions
	FilteredSoundClass (const FilteredSoundClass &src)

	FilteredSoundClass (void)

virtual	~FilteredSoundClass (void)

const FilteredSoundClass &	operator= (const FilteredSoundClass &src)

virtual SOUND_CLASSID	Get_Class_ID (void)

virtual FilteredSoundClass *	As_FilteredSoundClass (void)

virtual void	Update_Volume (void)

const PersistFactoryClass &	Get_Factory (void) const

Public Member Functions inherited from SoundPseudo3DClass
	SoundPseudo3DClass (const SoundPseudo3DClass &src)

	SoundPseudo3DClass (void)

virtual	~SoundPseudo3DClass (void)

const SoundPseudo3DClass &	operator= (const SoundPseudo3DClass &src)

virtual SOUND_CLASSID	Get_Class_ID (void) const

virtual SoundPseudo3DClass *	As_SoundPseudo3DClass (void)

virtual void	Set_Listener_Transform (const Matrix3D &tm)

virtual void	Set_Position (const Vector3 &position)

virtual void	Set_Transform (const Matrix3D &transform)

virtual void	Set_Velocity (const Vector3 &velocity)

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	Update_Pseudo_Volume (void)

virtual void	Update_Pseudo_Volume (float distance)

virtual void	Update_Pseudo_Pan (void)

const PersistFactoryClass &	Get_Factory (void) const

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 Vector3	Get_Position (void) const

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

virtual float	Get_DropOff_Radius ()

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 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 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 void	Initialize_Miles_Handle (void)

Protected Member Functions inherited from SoundPseudo3DClass
virtual bool	On_Frame_Update (unsigned int milliseconds=0)

virtual void	Set_Miles_Handle (MILES_HANDLE handle)

virtual void	Allocate_Miles_Handle (void)

virtual void	Free_Miles_Handle (void)

virtual void	On_Loop_End (void)

Protected Member Functions inherited from Sound3DClass
virtual SoundCullObjClass *	Peek_Cullable_Wrapper (void) const

virtual void	Set_Cullable_Wrapper (SoundCullObjClass *obj)

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)

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 55 of file FilteredSound.h.

Constructor & Destructor Documentation

◆ FilteredSoundClass() [1/2]

FilteredSoundClass::FilteredSoundClass ( const FilteredSoundClass & src )

Definition at line 71 of file FilteredSound.cpp.

◆ FilteredSoundClass() [2/2]

FilteredSoundClass::FilteredSoundClass ( void )

Definition at line 59 of file FilteredSound.cpp.

◆ ~FilteredSoundClass()

FilteredSoundClass::~FilteredSoundClass ( void )

virtual

Definition at line 85 of file FilteredSound.cpp.

Member Function Documentation

◆ As_FilteredSoundClass()

virtual FilteredSoundClass * FilteredSoundClass::As_FilteredSoundClass ( void )

inlinevirtual

Reimplemented from SoundSceneObjClass.

Definition at line 79 of file FilteredSound.h.

◆ Get_Class_ID()

virtual SOUND_CLASSID FilteredSoundClass::Get_Class_ID ( void )

inlinevirtual

Definition at line 74 of file FilteredSound.h.

◆ Get_Factory()

const PersistFactoryClass & FilteredSoundClass::Get_Factory ( void ) const

virtual

Reimplemented from AudibleSoundClass.

Definition at line 180 of file FilteredSound.cpp.

◆ Initialize_Miles_Handle()

void FilteredSoundClass::Initialize_Miles_Handle ( void )

protectedvirtual

Reimplemented from SoundPseudo3DClass.

Definition at line 111 of file FilteredSound.cpp.

◆ operator=()

const FilteredSoundClass & FilteredSoundClass::operator= ( const FilteredSoundClass & src )

Definition at line 97 of file FilteredSound.cpp.

◆ Update_Volume()

void FilteredSoundClass::Update_Volume ( void )

virtual

Reimplemented from SoundPseudo3DClass.

Definition at line 153 of file FilteredSound.cpp.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FilteredSoundClass() [1/2]

◆ FilteredSoundClass() [2/2]

◆ ~FilteredSoundClass()

Member Function Documentation

◆ As_FilteredSoundClass()

◆ Get_Class_ID()

◆ Get_Factory()

◆ Initialize_Miles_Handle()

◆ operator=()

◆ Update_Volume()