#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 AudibleSoundClass & | operator= (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 AudibleSoundClass * | As_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 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) |
| const PersistFactoryClass & | Get_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 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 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 float | Determine_Real_Volume (void) const |
| virtual SoundHandleClass * | Get_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 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) |
| virtual void | On_Loop_End (void) |
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) |
Protected Attributes | |
| 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 | WWAudioClass |
Definition at line 102 of file AudibleSound.h.
| Enumerator | |
|---|---|
| STATE_STOPPED | |
| STATE_PLAYING | |
| STATE_PAUSED | |
| STATE_COUNT | |
Definition at line 121 of file AudibleSound.h.
| Enumerator | |
|---|---|
| TYPE_MUSIC | |
| TYPE_SOUND_EFFECT | |
| TYPE_COUNT | |
Definition at line 114 of file AudibleSound.h.
| AudibleSoundClass::AudibleSoundClass | ( | const AudibleSoundClass & | src | ) |
Definition at line 174 of file AudibleSound.cpp.
| AudibleSoundClass::AudibleSoundClass | ( | void | ) |
Definition at line 139 of file AudibleSound.cpp.
|
virtual |
Definition at line 209 of file AudibleSound.cpp.
Implements SoundSceneObjClass.
Reimplemented in Sound3DClass.
Definition at line 1119 of file AudibleSound.cpp.
|
protectedvirtual |
Reimplemented in Listener3DClass, Sound3DClass, and SoundPseudo3DClass.
Definition at line 972 of file AudibleSound.cpp.
|
inlinevirtual |
Reimplemented from SoundSceneObjClass.
Definition at line 151 of file AudibleSound.h.
|
virtual |
Definition at line 1275 of file AudibleSound.cpp.
|
virtual |
Definition at line 1235 of file AudibleSound.cpp.
Implements SoundSceneObjClass.
Definition at line 1058 of file AudibleSound.cpp.
|
protectedvirtual |
Definition at line 1019 of file AudibleSound.cpp.
|
virtual |
Definition at line 1211 of file AudibleSound.cpp.
|
protectedvirtual |
Reimplemented in Listener3DClass, and SoundPseudo3DClass.
Definition at line 654 of file AudibleSound.cpp.
|
protectedvirtual |
Definition at line 308 of file AudibleSound.cpp.
|
inlinevirtual |
Reimplemented in Listener3DClass, Sound3DClass, and SoundPseudo3DClass.
Definition at line 144 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 282 of file AudibleSound.h.
|
inlinevirtual |
Implements SoundSceneObjClass.
Reimplemented in Listener3DClass, and SoundPseudo3DClass.
Definition at line 270 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 232 of file AudibleSound.h.
|
virtual |
Implements PersistClass.
Reimplemented in FilteredSoundClass, Sound3DClass, and SoundPseudo3DClass.
Definition at line 1291 of file AudibleSound.cpp.
|
virtual |
Definition at line 1041 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 198 of file AudibleSound.h.
|
virtual |
Definition at line 856 of file AudibleSound.cpp.
|
inlineprotectedvirtual |
Definition at line 309 of file AudibleSound.h.
|
virtual |
Definition at line 689 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 220 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 233 of file AudibleSound.h.
|
virtual |
Definition at line 770 of file AudibleSound.cpp.
|
inlinevirtual |
Implements SoundSceneObjClass.
Reimplemented in Sound3DClass.
Definition at line 244 of file AudibleSound.h.
|
inlinevirtual |
Reimplemented in Sound3DClass.
Definition at line 207 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 211 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 238 of file AudibleSound.h.
|
inlinevirtual |
Reimplemented in Listener3DClass.
Definition at line 166 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 169 of file AudibleSound.h.
|
inlinevirtual |
Implements SoundSceneObjClass.
Reimplemented in Sound3DClass.
Definition at line 248 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 145 of file AudibleSound.h.
|
virtual |
Definition at line 809 of file AudibleSound.cpp.
|
protectedvirtual |
Reimplemented in FilteredSoundClass, Listener3DClass, Sound3DClass, and SoundPseudo3DClass.
Definition at line 579 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 276 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 175 of file AudibleSound.h.
|
inlinevirtual |
Implements SoundSceneObjClass.
Definition at line 254 of file AudibleSound.h.
|
virtual |
Reimplemented from PersistClass.
Reimplemented in Sound3DClass.
Definition at line 1722 of file AudibleSound.cpp.
|
virtual |
Reimplemented from SoundSceneObjClass.
Reimplemented in Sound3DClass, and SoundPseudo3DClass.
Definition at line 907 of file AudibleSound.cpp.
|
protectedvirtual |
Reimplemented in Sound3DClass, and SoundPseudo3DClass.
Definition at line 991 of file AudibleSound.cpp.
| const AudibleSoundClass & AudibleSoundClass::operator= | ( | const AudibleSoundClass & | src | ) |
Definition at line 235 of file AudibleSound.cpp.
|
virtual |
Reimplemented in Listener3DClass.
Definition at line 401 of file AudibleSound.cpp.
|
protectedvirtual |
Definition at line 324 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 208 of file AudibleSound.h.
Reimplemented in Sound3DClass.
Definition at line 336 of file AudibleSound.cpp.
|
virtual |
Definition at line 1177 of file AudibleSound.cpp.
|
virtual |
Implements SoundSceneObjClass.
Reimplemented in Sound3DClass.
Definition at line 1141 of file AudibleSound.cpp.
|
inlineprotectedvirtual |
Definition at line 325 of file AudibleSound.h.
|
virtual |
Reimplemented in Listener3DClass.
Definition at line 431 of file AudibleSound.cpp.
|
virtual |
Reimplemented from PersistClass.
Reimplemented in Sound3DClass.
Definition at line 1674 of file AudibleSound.cpp.
|
virtual |
Reimplemented in Listener3DClass.
Definition at line 508 of file AudibleSound.cpp.
|
protectedvirtual |
Definition at line 267 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 281 of file AudibleSound.h.
Definition at line 275 of file AudibleSound.h.
|
virtual |
Implements SoundSceneObjClass.
Reimplemented in Listener3DClass, Sound3DClass, and SoundPseudo3DClass.
Definition at line 1163 of file AudibleSound.cpp.
|
inlinevirtual |
Reimplemented from SoundSceneObjClass.
Reimplemented in Sound3DClass, and SoundPseudo3DClass.
Definition at line 246 of file AudibleSound.h.
|
virtual |
Definition at line 868 of file AudibleSound.cpp.
|
protectedvirtual |
Reimplemented in Sound3DClass, and SoundPseudo3DClass.
Definition at line 537 of file AudibleSound.cpp.
|
virtual |
Definition at line 710 of file AudibleSound.cpp.
|
virtual |
Definition at line 737 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 234 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 235 of file AudibleSound.h.
|
virtual |
Definition at line 790 of file AudibleSound.cpp.
|
virtual |
Implements SoundSceneObjClass.
Reimplemented in Sound3DClass, and SoundPseudo3DClass.
Definition at line 1104 of file AudibleSound.cpp.
|
virtual |
Definition at line 890 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 212 of file AudibleSound.h.
|
inlinevirtual |
Definition at line 237 of file AudibleSound.h.
|
virtual |
Implements SoundSceneObjClass.
Reimplemented in Sound3DClass, and SoundPseudo3DClass.
Definition at line 1088 of file AudibleSound.cpp.
|
inlinevirtual |
Definition at line 146 of file AudibleSound.h.
|
virtual |
Definition at line 829 of file AudibleSound.cpp.
Reimplemented in Listener3DClass.
Definition at line 461 of file AudibleSound.cpp.
|
protectedvirtual |
Definition at line 940 of file AudibleSound.cpp.
|
inlinevirtual |
Reimplemented in FilteredSoundClass, and SoundPseudo3DClass.
Definition at line 193 of file AudibleSound.h.
|
friend |
Definition at line 109 of file AudibleSound.h.
|
protected |
Definition at line 363 of file AudibleSound.h.
|
protected |
Definition at line 342 of file AudibleSound.h.
|
protected |
Definition at line 354 of file AudibleSound.h.
|
protected |
Definition at line 370 of file AudibleSound.h.
|
protected |
Definition at line 364 of file AudibleSound.h.
|
protected |
Definition at line 362 of file AudibleSound.h.
|
protected |
Definition at line 353 of file AudibleSound.h.
|
protected |
Definition at line 359 of file AudibleSound.h.
|
protected |
Definition at line 373 of file AudibleSound.h.
|
protected |
Definition at line 349 of file AudibleSound.h.
|
protected |
Definition at line 350 of file AudibleSound.h.
|
protected |
Definition at line 348 of file AudibleSound.h.
|
protected |
Definition at line 367 of file AudibleSound.h.
|
protected |
Definition at line 356 of file AudibleSound.h.
|
protected |
Definition at line 361 of file AudibleSound.h.
|
protected |
Definition at line 346 of file AudibleSound.h.
|
protected |
Definition at line 345 of file AudibleSound.h.
|
protected |
Definition at line 336 of file AudibleSound.h.
|
protected |
Definition at line 355 of file AudibleSound.h.
|
protected |
Definition at line 338 of file AudibleSound.h.
|
protected |
Definition at line 337 of file AudibleSound.h.
|
protected |
Definition at line 360 of file AudibleSound.h.
|
protected |
Definition at line 339 of file AudibleSound.h.
|
protected |
Definition at line 347 of file AudibleSound.h.