Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
AudibleSoundClass Class Reference

#include <AudibleSound.h>

Inherits SoundSceneObjClass.

Inherited by Sound3DClass.

Public Types

enum  SOUND_TYPE { TYPE_MUSIC = 0 , TYPE_SOUND_EFFECT , TYPE_COUNT }
 
enum  SOUND_STATE { STATE_STOPPED = 0 , STATE_PLAYING , STATE_PAUSED , STATE_COUNT }
 

Public Member Functions

 AudibleSoundClass (const AudibleSoundClass &src)
 
 AudibleSoundClass (void)
 
virtual ~AudibleSoundClass (void)
 
const AudibleSoundClassoperator= (const AudibleSoundClass &src)
 
virtual SOUND_CLASSID Get_Class_ID (void) const
 
virtual SOUND_TYPE Get_Type (void) const
 
virtual void Set_Type (SOUND_TYPE type)
 
virtual AudibleSoundClassAs_AudibleSoundClass (void)
 
virtual bool On_Frame_Update (unsigned int milliseconds=0)
 
virtual bool Play (bool alloc_handle=true)
 
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 Get_Priority (void) const
 
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 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
 
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
 
virtual void Set_Dirty (bool dirty=true)
 
virtual bool Is_Dirty (void) const
 
virtual void Set_Definition (AudibleSoundDefinitionClass *def)
 
virtual AudibleSoundDefinitionClassGet_Definition (void)
 
virtual void Re_Sync (AudibleSoundClass &src)
 
virtual void Free_Conversion (void)
 
virtual void Convert_To_Filtered (void)
 
virtual AudibleSoundClassAs_Converted_Format (void)
 
const PersistFactoryClassGet_Factory (void) const
 
bool Save (ChunkSaveClass &csave)
 
bool Load (ChunkLoadClass &cload)
 
- Public Member Functions inherited from SoundSceneObjClass
 SoundSceneObjClass (void)
 
 SoundSceneObjClass (const SoundSceneObjClass &src)
 
virtual ~SoundSceneObjClass (void)
 
const SoundSceneObjClassoperator= (const SoundSceneObjClass &src)
 
virtual Sound3DClassAs_Sound3DClass (void)
 
virtual SoundPseudo3DClassAs_SoundPseudo3DClass (void)
 
virtual FilteredSoundClassAs_FilteredSoundClass (void)
 
virtual Listener3DClassAs_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 RefCountClassPeek_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 RenderObjClassPeek_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)
 
MultiListNodeClassGet_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 float Determine_Real_Volume (void) const
 
virtual SoundHandleClassGet_Miles_Handle (void) const
 
virtual void Set_Miles_Handle (MILES_HANDLE handle=INVALID_MILES_HANDLE)
 
virtual void Free_Miles_Handle (void)
 
virtual void Initialize_Miles_Handle (void)
 
virtual void Allocate_Miles_Handle (void)
 
virtual SoundBufferClassGet_Buffer (void) const
 
virtual SoundBufferClassPeek_Buffer (void) const
 
virtual void Set_Buffer (SoundBufferClass *buffer)
 
virtual void Restart_Loop (void)
 
virtual void Update_Play_Position (void)
 
virtual void On_Loop_End (void)
 
- Protected Member Functions inherited from SoundSceneObjClass
virtual SoundCullObjClassPeek_Cullable_Wrapper (void) const
 
virtual void Set_Cullable_Wrapper (SoundCullObjClass *obj)
 
- Protected Member Functions inherited from RefCountClass
virtual ~RefCountClass (void)
 

Protected Attributes

SoundHandleClassm_SoundHandle
 
unsigned long m_Timestamp
 
SOUND_STATE m_State
 
SOUND_TYPE m_Type
 
SoundBufferClassm_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
 
AudibleSoundClassm_pConvertedFormat
 
AudibleSoundDefinitionClassm_Definition
 
LogicalSoundClassm_LogicalSound
 
- Protected Attributes inherited from SoundSceneObjClass
SoundSceneClassm_Scene
 
SoundCullObjClassm_PhysWrapper
 
AudioCallbackClassm_pCallback
 
AudioCallbackClass::EVENTS m_RegisteredEvents
 
uint32 m_ID
 
RenderObjClassm_AttachedObject
 
int m_AttachedBone
 
uint32 m_UserData
 
RefCountClassm_UserObj
 

Friends

class WWAudioClass
 

Additional Inherited Members

- Static Public Member Functions inherited from RefCountClass
static int Total_Refs (void)
 
static RefCountClassAdd_Active_Ref (RefCountClass *obj)
 
static RefCountClassSet_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 102 of file AudibleSound.h.

Member Enumeration Documentation

◆ SOUND_STATE

Enumerator
STATE_STOPPED 
STATE_PLAYING 
STATE_PAUSED 
STATE_COUNT 

Definition at line 121 of file AudibleSound.h.

◆ SOUND_TYPE

Enumerator
TYPE_MUSIC 
TYPE_SOUND_EFFECT 
TYPE_COUNT 

Definition at line 114 of file AudibleSound.h.

Constructor & Destructor Documentation

◆ AudibleSoundClass() [1/2]

AudibleSoundClass::AudibleSoundClass ( const AudibleSoundClass & src)

Definition at line 174 of file AudibleSound.cpp.

◆ AudibleSoundClass() [2/2]

AudibleSoundClass::AudibleSoundClass ( void )

Definition at line 139 of file AudibleSound.cpp.

◆ ~AudibleSoundClass()

AudibleSoundClass::~AudibleSoundClass ( void )
virtual

Definition at line 209 of file AudibleSound.cpp.

Member Function Documentation

◆ Add_To_Scene()

void AudibleSoundClass::Add_To_Scene ( bool start_playing = true)
virtual

Implements SoundSceneObjClass.

Reimplemented in Sound3DClass.

Definition at line 1119 of file AudibleSound.cpp.

◆ Allocate_Miles_Handle()

void AudibleSoundClass::Allocate_Miles_Handle ( void )
protectedvirtual

Reimplemented in Listener3DClass, Sound3DClass, and SoundPseudo3DClass.

Definition at line 972 of file AudibleSound.cpp.

◆ As_AudibleSoundClass()

virtual AudibleSoundClass * AudibleSoundClass::As_AudibleSoundClass ( void )
inlinevirtual

Reimplemented from SoundSceneObjClass.

Definition at line 151 of file AudibleSound.h.

◆ As_Converted_Format()

AudibleSoundClass * AudibleSoundClass::As_Converted_Format ( void )
virtual

Definition at line 1275 of file AudibleSound.cpp.

◆ Convert_To_Filtered()

void AudibleSoundClass::Convert_To_Filtered ( void )
virtual

Definition at line 1235 of file AudibleSound.cpp.

◆ Cull_Sound()

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

Implements SoundSceneObjClass.

Definition at line 1058 of file AudibleSound.cpp.

◆ Determine_Real_Volume()

float AudibleSoundClass::Determine_Real_Volume ( void ) const
protectedvirtual

Definition at line 1019 of file AudibleSound.cpp.

◆ Free_Conversion()

void AudibleSoundClass::Free_Conversion ( void )
virtual

Definition at line 1211 of file AudibleSound.cpp.

◆ Free_Miles_Handle()

void AudibleSoundClass::Free_Miles_Handle ( void )
protectedvirtual

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 654 of file AudibleSound.cpp.

◆ Get_Buffer()

SoundBufferClass * AudibleSoundClass::Get_Buffer ( void ) const
protectedvirtual

Definition at line 308 of file AudibleSound.cpp.

◆ Get_Class_ID()

virtual SOUND_CLASSID AudibleSoundClass::Get_Class_ID ( void ) const
inlinevirtual

Reimplemented in Listener3DClass, Sound3DClass, and SoundPseudo3DClass.

Definition at line 144 of file AudibleSound.h.

◆ Get_Definition()

virtual AudibleSoundDefinitionClass * AudibleSoundClass::Get_Definition ( void )
inlinevirtual

Definition at line 282 of file AudibleSound.h.

◆ Get_DropOff_Radius()

virtual float AudibleSoundClass::Get_DropOff_Radius ( void ) const
inlinevirtual

Implements SoundSceneObjClass.

Reimplemented in Listener3DClass, and SoundPseudo3DClass.

Definition at line 270 of file AudibleSound.h.

◆ Get_Duration()

virtual unsigned long AudibleSoundClass::Get_Duration ( void ) const
inlinevirtual

Definition at line 232 of file AudibleSound.h.

◆ Get_Factory()

const PersistFactoryClass & AudibleSoundClass::Get_Factory ( void ) const
virtual

Implements PersistClass.

Reimplemented in FilteredSoundClass, Sound3DClass, and SoundPseudo3DClass.

Definition at line 1291 of file AudibleSound.cpp.

◆ Get_Filename()

LPCTSTR AudibleSoundClass::Get_Filename ( void ) const
virtual

Definition at line 1041 of file AudibleSound.cpp.

◆ Get_Loop_Count()

virtual int AudibleSoundClass::Get_Loop_Count ( void ) const
inlinevirtual

Definition at line 198 of file AudibleSound.h.

◆ Get_Loops_Left()

int AudibleSoundClass::Get_Loops_Left ( void ) const
virtual

Definition at line 856 of file AudibleSound.cpp.

◆ Get_Miles_Handle()

virtual SoundHandleClass * AudibleSoundClass::Get_Miles_Handle ( void ) const
inlineprotectedvirtual

Definition at line 309 of file AudibleSound.h.

◆ Get_Pan()

float AudibleSoundClass::Get_Pan ( void )
virtual

Definition at line 689 of file AudibleSound.cpp.

◆ Get_Pitch_Factor()

virtual float AudibleSoundClass::Get_Pitch_Factor ( void )
inlinevirtual

Definition at line 220 of file AudibleSound.h.

◆ Get_Play_Position()

virtual unsigned long AudibleSoundClass::Get_Play_Position ( void ) const
inlinevirtual

Definition at line 233 of file AudibleSound.h.

◆ Get_Playback_Rate()

int AudibleSoundClass::Get_Playback_Rate ( void )
virtual

Definition at line 770 of file AudibleSound.cpp.

◆ Get_Position()

virtual Vector3 AudibleSoundClass::Get_Position ( void ) const
inlinevirtual

Implements SoundSceneObjClass.

Reimplemented in Sound3DClass.

Definition at line 244 of file AudibleSound.h.

◆ Get_Priority()

virtual float AudibleSoundClass::Get_Priority ( void ) const
inlinevirtual

Reimplemented in Sound3DClass.

Definition at line 207 of file AudibleSound.h.

◆ Get_Runtime_Priority()

virtual float AudibleSoundClass::Get_Runtime_Priority ( void ) const
inlinevirtual

Definition at line 211 of file AudibleSound.h.

◆ Get_Start_Offset()

virtual float AudibleSoundClass::Get_Start_Offset ( void ) const
inlinevirtual

Definition at line 238 of file AudibleSound.h.

◆ Get_State()

virtual SOUND_STATE AudibleSoundClass::Get_State ( void ) const
inlinevirtual

Reimplemented in Listener3DClass.

Definition at line 166 of file AudibleSound.h.

◆ Get_Timestamp()

virtual unsigned long AudibleSoundClass::Get_Timestamp ( void ) const
inlinevirtual

Definition at line 169 of file AudibleSound.h.

◆ Get_Transform()

virtual Matrix3D AudibleSoundClass::Get_Transform ( void ) const
inlinevirtual

Implements SoundSceneObjClass.

Reimplemented in Sound3DClass.

Definition at line 248 of file AudibleSound.h.

◆ Get_Type()

virtual SOUND_TYPE AudibleSoundClass::Get_Type ( void ) const
inlinevirtual

Definition at line 145 of file AudibleSound.h.

◆ Get_Volume()

float AudibleSoundClass::Get_Volume ( void )
virtual

Definition at line 809 of file AudibleSound.cpp.

◆ Initialize_Miles_Handle()

void AudibleSoundClass::Initialize_Miles_Handle ( void )
protectedvirtual

Reimplemented in FilteredSoundClass, Listener3DClass, Sound3DClass, and SoundPseudo3DClass.

Definition at line 579 of file AudibleSound.cpp.

◆ Is_Dirty()

virtual bool AudibleSoundClass::Is_Dirty ( void ) const
inlinevirtual

Definition at line 276 of file AudibleSound.h.

◆ Is_Playing()

virtual bool AudibleSoundClass::Is_Playing ( void ) const
inlinevirtual

Definition at line 175 of file AudibleSound.h.

◆ Is_Sound_Culled()

virtual bool AudibleSoundClass::Is_Sound_Culled ( void ) const
inlinevirtual

Implements SoundSceneObjClass.

Definition at line 254 of file AudibleSound.h.

◆ Load()

bool AudibleSoundClass::Load ( ChunkLoadClass & cload)
virtual

Reimplemented from PersistClass.

Reimplemented in Sound3DClass.

Definition at line 1722 of file AudibleSound.cpp.

◆ On_Frame_Update()

bool AudibleSoundClass::On_Frame_Update ( unsigned int milliseconds = 0)
virtual

Reimplemented from SoundSceneObjClass.

Reimplemented in Sound3DClass, and SoundPseudo3DClass.

Definition at line 907 of file AudibleSound.cpp.

◆ On_Loop_End()

void AudibleSoundClass::On_Loop_End ( void )
protectedvirtual

Reimplemented in Sound3DClass, and SoundPseudo3DClass.

Definition at line 991 of file AudibleSound.cpp.

◆ operator=()

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

Definition at line 235 of file AudibleSound.cpp.

◆ Pause()

bool AudibleSoundClass::Pause ( void )
virtual

Reimplemented in Listener3DClass.

Definition at line 401 of file AudibleSound.cpp.

◆ Peek_Buffer()

SoundBufferClass * AudibleSoundClass::Peek_Buffer ( void ) const
protectedvirtual

Definition at line 324 of file AudibleSound.cpp.

◆ Peek_Priority()

virtual float AudibleSoundClass::Peek_Priority ( void ) const
inlinevirtual

Definition at line 208 of file AudibleSound.h.

◆ Play()

bool AudibleSoundClass::Play ( bool alloc_handle = true)
virtual

Reimplemented in Sound3DClass.

Definition at line 336 of file AudibleSound.cpp.

◆ Re_Sync()

void AudibleSoundClass::Re_Sync ( AudibleSoundClass & src)
virtual

Definition at line 1177 of file AudibleSound.cpp.

◆ Remove_From_Scene()

void AudibleSoundClass::Remove_From_Scene ( void )
virtual

Implements SoundSceneObjClass.

Reimplemented in Sound3DClass.

Definition at line 1141 of file AudibleSound.cpp.

◆ Restart_Loop()

virtual void AudibleSoundClass::Restart_Loop ( void )
inlineprotectedvirtual

Definition at line 325 of file AudibleSound.h.

◆ Resume()

bool AudibleSoundClass::Resume ( void )
virtual

Reimplemented in Listener3DClass.

Definition at line 431 of file AudibleSound.cpp.

◆ Save()

bool AudibleSoundClass::Save ( ChunkSaveClass & csave)
virtual

Reimplemented from PersistClass.

Reimplemented in Sound3DClass.

Definition at line 1674 of file AudibleSound.cpp.

◆ Seek()

void AudibleSoundClass::Seek ( unsigned long milliseconds)
virtual

Reimplemented in Listener3DClass.

Definition at line 508 of file AudibleSound.cpp.

◆ Set_Buffer()

void AudibleSoundClass::Set_Buffer ( SoundBufferClass * buffer)
protectedvirtual

Definition at line 267 of file AudibleSound.cpp.

◆ Set_Definition()

virtual void AudibleSoundClass::Set_Definition ( AudibleSoundDefinitionClass * def)
inlinevirtual

Definition at line 281 of file AudibleSound.h.

◆ Set_Dirty()

virtual void AudibleSoundClass::Set_Dirty ( bool dirty = true)
inlinevirtual

Definition at line 275 of file AudibleSound.h.

◆ Set_DropOff_Radius()

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

Implements SoundSceneObjClass.

Reimplemented in Listener3DClass, Sound3DClass, and SoundPseudo3DClass.

Definition at line 1163 of file AudibleSound.cpp.

◆ Set_Listener_Transform()

virtual void AudibleSoundClass::Set_Listener_Transform ( const Matrix3D & tm)
inlinevirtual

Reimplemented from SoundSceneObjClass.

Reimplemented in Sound3DClass, and SoundPseudo3DClass.

Definition at line 246 of file AudibleSound.h.

◆ Set_Loop_Count()

void AudibleSoundClass::Set_Loop_Count ( int count = 1)
virtual

Definition at line 868 of file AudibleSound.cpp.

◆ Set_Miles_Handle()

void AudibleSoundClass::Set_Miles_Handle ( MILES_HANDLE handle = INVALID_MILES_HANDLE)
protectedvirtual

Reimplemented in Sound3DClass, and SoundPseudo3DClass.

Definition at line 537 of file AudibleSound.cpp.

◆ Set_Pan()

void AudibleSoundClass::Set_Pan ( float pan = 0.5F)
virtual

Definition at line 710 of file AudibleSound.cpp.

◆ Set_Pitch_Factor()

void AudibleSoundClass::Set_Pitch_Factor ( float factor)
virtual

Definition at line 737 of file AudibleSound.cpp.

◆ Set_Play_Position() [1/2]

virtual void AudibleSoundClass::Set_Play_Position ( float position)
inlinevirtual

Definition at line 234 of file AudibleSound.h.

◆ Set_Play_Position() [2/2]

virtual void AudibleSoundClass::Set_Play_Position ( unsigned long milliseconds)
inlinevirtual

Definition at line 235 of file AudibleSound.h.

◆ Set_Playback_Rate()

void AudibleSoundClass::Set_Playback_Rate ( int rate_in_hz)
virtual

Definition at line 790 of file AudibleSound.cpp.

◆ Set_Position()

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

Implements SoundSceneObjClass.

Reimplemented in Sound3DClass, and SoundPseudo3DClass.

Definition at line 1104 of file AudibleSound.cpp.

◆ Set_Priority()

void AudibleSoundClass::Set_Priority ( float priority = 0.5F)
virtual

Definition at line 890 of file AudibleSound.cpp.

◆ Set_Runtime_Priority()

virtual void AudibleSoundClass::Set_Runtime_Priority ( float priority)
inlinevirtual

Definition at line 212 of file AudibleSound.h.

◆ Set_Start_Offset()

virtual void AudibleSoundClass::Set_Start_Offset ( float offset)
inlinevirtual

Definition at line 237 of file AudibleSound.h.

◆ Set_Transform()

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

Implements SoundSceneObjClass.

Reimplemented in Sound3DClass, and SoundPseudo3DClass.

Definition at line 1088 of file AudibleSound.cpp.

◆ Set_Type()

virtual void AudibleSoundClass::Set_Type ( SOUND_TYPE type)
inlinevirtual

Definition at line 146 of file AudibleSound.h.

◆ Set_Volume()

void AudibleSoundClass::Set_Volume ( float volume = 1.0F)
virtual

Definition at line 829 of file AudibleSound.cpp.

◆ Stop()

bool AudibleSoundClass::Stop ( bool remove_from_playlist = true)
virtual

Reimplemented in Listener3DClass.

Definition at line 461 of file AudibleSound.cpp.

◆ Update_Play_Position()

void AudibleSoundClass::Update_Play_Position ( void )
protectedvirtual

Definition at line 940 of file AudibleSound.cpp.

◆ Update_Volume()

virtual void AudibleSoundClass::Update_Volume ( void )
inlinevirtual

Reimplemented in FilteredSoundClass, and SoundPseudo3DClass.

Definition at line 193 of file AudibleSound.h.

Friends And Related Symbol Documentation

◆ WWAudioClass

friend class WWAudioClass
friend

Definition at line 109 of file AudibleSound.h.

Member Data Documentation

◆ m_bDirty

bool AudibleSoundClass::m_bDirty
protected

Definition at line 363 of file AudibleSound.h.

◆ m_Buffer

SoundBufferClass* AudibleSoundClass::m_Buffer
protected

Definition at line 342 of file AudibleSound.h.

◆ m_CurrentPosition

unsigned long AudibleSoundClass::m_CurrentPosition
protected

Definition at line 354 of file AudibleSound.h.

◆ m_Definition

AudibleSoundDefinitionClass* AudibleSoundClass::m_Definition
protected

Definition at line 370 of file AudibleSound.h.

◆ m_DropOffRadius

float AudibleSoundClass::m_DropOffRadius
protected

Definition at line 364 of file AudibleSound.h.

◆ m_IsCulled

bool AudibleSoundClass::m_IsCulled
protected

Definition at line 362 of file AudibleSound.h.

◆ m_Length

unsigned long AudibleSoundClass::m_Length
protected

Definition at line 353 of file AudibleSound.h.

◆ m_ListenerTransform

Matrix3D AudibleSoundClass::m_ListenerTransform
protected

Definition at line 359 of file AudibleSound.h.

◆ m_LogicalSound

LogicalSoundClass* AudibleSoundClass::m_LogicalSound
protected

Definition at line 373 of file AudibleSound.h.

◆ m_LoopCount

int AudibleSoundClass::m_LoopCount
protected

Definition at line 349 of file AudibleSound.h.

◆ m_LoopsLeft

int AudibleSoundClass::m_LoopsLeft
protected

Definition at line 350 of file AudibleSound.h.

◆ m_Pan

float AudibleSoundClass::m_Pan
protected

Definition at line 348 of file AudibleSound.h.

◆ m_pConvertedFormat

AudibleSoundClass* AudibleSoundClass::m_pConvertedFormat
protected

Definition at line 367 of file AudibleSound.h.

◆ m_PitchFactor

float AudibleSoundClass::m_PitchFactor
protected

Definition at line 356 of file AudibleSound.h.

◆ m_PrevTransform

Matrix3D AudibleSoundClass::m_PrevTransform
protected

Definition at line 361 of file AudibleSound.h.

◆ m_Priority

float AudibleSoundClass::m_Priority
protected

Definition at line 346 of file AudibleSound.h.

◆ m_RuntimePriority

float AudibleSoundClass::m_RuntimePriority
protected

Definition at line 345 of file AudibleSound.h.

◆ m_SoundHandle

SoundHandleClass* AudibleSoundClass::m_SoundHandle
protected

Definition at line 336 of file AudibleSound.h.

◆ m_StartOffset

float AudibleSoundClass::m_StartOffset
protected

Definition at line 355 of file AudibleSound.h.

◆ m_State

SOUND_STATE AudibleSoundClass::m_State
protected

Definition at line 338 of file AudibleSound.h.

◆ m_Timestamp

unsigned long AudibleSoundClass::m_Timestamp
protected

Definition at line 337 of file AudibleSound.h.

◆ m_Transform

Matrix3D AudibleSoundClass::m_Transform
protected

Definition at line 360 of file AudibleSound.h.

◆ m_Type

SOUND_TYPE AudibleSoundClass::m_Type
protected

Definition at line 339 of file AudibleSound.h.

◆ m_Volume

float AudibleSoundClass::m_Volume
protected

Definition at line 347 of file AudibleSound.h.


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