Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Types | Protected Member Functions | Friends | List of all members
SoundSceneClass Class Reference

#include <SoundScene.h>

Classes

class  AudibleInfoClass
 

Public Member Functions

 SoundSceneClass (void)
 
virtual ~SoundSceneClass (void)
 
virtual void Re_Partition (const Vector3 &min_dimension, const Vector3 &max_dimension)
 
virtual void Collect_Logical_Sounds (int listener_count=-1)
 
virtual void Attach_Listener_To_Obj (RenderObjClass *render_obj, int bone_index=-1)
 
virtual void Set_Listener_Position (const Vector3 &pos)
 
virtual Vector3 Get_Listener_Position (void) const
 
virtual void Set_Listener_Transform (const Matrix3D &transform)
 
virtual Matrix3D Get_Listener_Transform (void) const
 
virtual Listener3DClass * Peek_2nd_Listener (void) const
 
virtual void Set_2nd_Listener (Listener3DClass *listener)
 
virtual void Flush_Scene (void)
 
virtual void Update_Sound (SoundCullObjClass *sound_obj)
 
virtual void Add_Sound (AudibleSoundClass *sound_obj, bool start_playing=true)
 
virtual void Remove_Sound (AudibleSoundClass *sound_obj, bool stop_playing=true)
 
virtual void Add_Static_Sound (AudibleSoundClass *sound_obj, bool start_playing=true)
 
virtual void Remove_Static_Sound (AudibleSoundClass *sound_obj, bool stop_playing=true)
 
virtual void Add_Logical_Sound (LogicalSoundClass *sound_obj, bool single_shot=false)
 
virtual void Remove_Logical_Sound (LogicalSoundClass *sound_obj, bool single_shot=false, bool remove_from_list=true)
 
virtual void Add_Logical_Listener (LogicalListenerClass *listener_obj)
 
virtual void Remove_Logical_Listener (LogicalListenerClass *listener_obj)
 
bool Save_Static (ChunkSaveClass &csave)
 
bool Load_Static (ChunkLoadClass &cload)
 
bool Save_Dynamic (ChunkSaveClass &csave)
 
bool Load_Dynamic (ChunkLoadClass &cload)
 
bool Is_Batch_Mode (void) const
 
void Set_Batch_Mode (bool batch_mode)
 
bool Is_Sound_In_Scene (AudibleSoundClass *sound_obj, bool all=true)
 

Protected Types

typedef MultiListClass< AudibleInfoClass > COLLECTED_SOUNDS
 

Protected Member Functions

virtual void On_Frame_Update (unsigned int milliseconds=0)
 
virtual void Initialize (void)
 
virtual bool Is_Logical_Sound_In_Scene (LogicalSoundClass *sound_obj, bool single_shot=false)
 
virtual void Save_Static_Sounds (ChunkSaveClass &csave)
 
virtual void Load_Static_Sounds (ChunkLoadClass &cload)
 
virtual void Collect_Audible_Sounds (Listener3DClass *listener, COLLECTED_SOUNDS &list)
 

Friends

class WWAudioClass
 

Detailed Description

Definition at line 81 of file SoundScene.h.

Member Typedef Documentation

◆ COLLECTED_SOUNDS

typedef MultiListClass<AudibleInfoClass> SoundSceneClass::COLLECTED_SOUNDS
protected

Definition at line 196 of file SoundScene.h.

Constructor & Destructor Documentation

◆ SoundSceneClass()

SoundSceneClass::SoundSceneClass ( void )

Definition at line 80 of file SoundScene.cpp.

◆ ~SoundSceneClass()

SoundSceneClass::~SoundSceneClass ( void )
virtual

Definition at line 102 of file SoundScene.cpp.

Member Function Documentation

◆ Add_Logical_Listener()

void SoundSceneClass::Add_Logical_Listener ( LogicalListenerClass * listener_obj)
virtual

Definition at line 942 of file SoundScene.cpp.

◆ Add_Logical_Sound()

void SoundSceneClass::Add_Logical_Sound ( LogicalSoundClass * sound_obj,
bool single_shot = false )
virtual

Definition at line 792 of file SoundScene.cpp.

◆ Add_Sound()

void SoundSceneClass::Add_Sound ( AudibleSoundClass * sound_obj,
bool start_playing = true )
virtual

Definition at line 521 of file SoundScene.cpp.

◆ Add_Static_Sound()

void SoundSceneClass::Add_Static_Sound ( AudibleSoundClass * sound_obj,
bool start_playing = true )
virtual

Definition at line 652 of file SoundScene.cpp.

◆ Attach_Listener_To_Obj()

virtual void SoundSceneClass::Attach_Listener_To_Obj ( RenderObjClass * render_obj,
int bone_index = -1 )
inlinevirtual

Definition at line 109 of file SoundScene.h.

◆ Collect_Audible_Sounds()

void SoundSceneClass::Collect_Audible_Sounds ( Listener3DClass * listener,
COLLECTED_SOUNDS & list )
protectedvirtual

Definition at line 239 of file SoundScene.cpp.

◆ Collect_Logical_Sounds()

void SoundSceneClass::Collect_Logical_Sounds ( int listener_count = -1)
virtual

Definition at line 139 of file SoundScene.cpp.

◆ Flush_Scene()

void SoundSceneClass::Flush_Scene ( void )
virtual

Definition at line 1233 of file SoundScene.cpp.

◆ Get_Listener_Position()

virtual Vector3 SoundSceneClass::Get_Listener_Position ( void ) const
inlinevirtual

Definition at line 112 of file SoundScene.h.

◆ Get_Listener_Transform()

virtual Matrix3D SoundSceneClass::Get_Listener_Transform ( void ) const
inlinevirtual

Definition at line 115 of file SoundScene.h.

◆ Initialize()

void SoundSceneClass::Initialize ( void )
protectedvirtual

Definition at line 1011 of file SoundScene.cpp.

◆ Is_Batch_Mode()

bool SoundSceneClass::Is_Batch_Mode ( void ) const
inline

Definition at line 156 of file SoundScene.h.

◆ Is_Logical_Sound_In_Scene()

bool SoundSceneClass::Is_Logical_Sound_In_Scene ( LogicalSoundClass * sound_obj,
bool single_shot = false )
protectedvirtual

Definition at line 1048 of file SoundScene.cpp.

◆ Is_Sound_In_Scene()

bool SoundSceneClass::Is_Sound_In_Scene ( AudibleSoundClass * sound_obj,
bool all = true )

Definition at line 1025 of file SoundScene.cpp.

◆ Load_Dynamic()

bool SoundSceneClass::Load_Dynamic ( ChunkLoadClass & cload)

Definition at line 1221 of file SoundScene.cpp.

◆ Load_Static()

bool SoundSceneClass::Load_Static ( ChunkLoadClass & cload)

Definition at line 1165 of file SoundScene.cpp.

◆ Load_Static_Sounds()

void SoundSceneClass::Load_Static_Sounds ( ChunkLoadClass & cload)
protectedvirtual

Definition at line 1136 of file SoundScene.cpp.

◆ On_Frame_Update()

void SoundSceneClass::On_Frame_Update ( unsigned int milliseconds = 0)
protectedvirtual

Definition at line 340 of file SoundScene.cpp.

◆ Peek_2nd_Listener()

virtual Listener3DClass * SoundSceneClass::Peek_2nd_Listener ( void ) const
inlinevirtual

Definition at line 117 of file SoundScene.h.

◆ Re_Partition()

void SoundSceneClass::Re_Partition ( const Vector3 & min_dimension,
const Vector3 & max_dimension )
virtual

Definition at line 116 of file SoundScene.cpp.

◆ Remove_Logical_Listener()

void SoundSceneClass::Remove_Logical_Listener ( LogicalListenerClass * listener_obj)
virtual

Definition at line 969 of file SoundScene.cpp.

◆ Remove_Logical_Sound()

void SoundSceneClass::Remove_Logical_Sound ( LogicalSoundClass * sound_obj,
bool single_shot = false,
bool remove_from_list = true )
virtual

Definition at line 854 of file SoundScene.cpp.

◆ Remove_Sound()

void SoundSceneClass::Remove_Sound ( AudibleSoundClass * sound_obj,
bool stop_playing = true )
virtual

Definition at line 593 of file SoundScene.cpp.

◆ Remove_Static_Sound()

void SoundSceneClass::Remove_Static_Sound ( AudibleSoundClass * sound_obj,
bool stop_playing = true )
virtual

Definition at line 733 of file SoundScene.cpp.

◆ Save_Dynamic()

bool SoundSceneClass::Save_Dynamic ( ChunkSaveClass & csave)

Definition at line 1209 of file SoundScene.cpp.

◆ Save_Static()

bool SoundSceneClass::Save_Static ( ChunkSaveClass & csave)

Definition at line 1075 of file SoundScene.cpp.

◆ Save_Static_Sounds()

void SoundSceneClass::Save_Static_Sounds ( ChunkSaveClass & csave)
protectedvirtual

Definition at line 1099 of file SoundScene.cpp.

◆ Set_2nd_Listener()

void SoundSceneClass::Set_2nd_Listener ( Listener3DClass * listener)
virtual

Definition at line 1289 of file SoundScene.cpp.

◆ Set_Batch_Mode()

void SoundSceneClass::Set_Batch_Mode ( bool batch_mode)
inline

Definition at line 157 of file SoundScene.h.

◆ Set_Listener_Position()

virtual void SoundSceneClass::Set_Listener_Position ( const Vector3 & pos)
inlinevirtual

Definition at line 111 of file SoundScene.h.

◆ Set_Listener_Transform()

virtual void SoundSceneClass::Set_Listener_Transform ( const Matrix3D & transform)
inlinevirtual

Definition at line 114 of file SoundScene.h.

◆ Update_Sound()

void SoundSceneClass::Update_Sound ( SoundCullObjClass * sound_obj)
virtual

Definition at line 995 of file SoundScene.cpp.

Friends And Related Symbol Documentation

◆ WWAudioClass

friend class WWAudioClass
friend

Definition at line 88 of file SoundScene.h.

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