AudibleSoundDefinitionClass Class Reference

#include <AudibleSound.h>

Inherits DefinitionClass.

Public Member Functions
	DECLARE_EDITABLE (AudibleSoundDefinitionClass, DefinitionClass)
	AudibleSoundDefinitionClass (void)
virtual	~AudibleSoundDefinitionClass (void)
virtual uint32	Get_Class_ID (void) const
virtual const PersistFactoryClass &	Get_Factory (void) const
virtual bool	Save (ChunkSaveClass &csave)
virtual bool	Load (ChunkLoadClass &cload)
virtual PersistClass *	Create (void) const
virtual AudibleSoundClass *	Create_Sound (int classid_hint) const
virtual void	Initialize_From_Sound (AudibleSoundClass *sound)
virtual const StringClass &	Get_Filename (void) const
virtual const StringClass &	Get_Display_Text (void) const
virtual float	Get_Max_Vol_Radius (void) const
virtual float	Get_DropOff_Radius (void) const
virtual const Vector3 &	Get_Sphere_Color (void) const
virtual float	Get_Volume (void) const
virtual float	Get_Start_Offset (void) const
virtual float	Get_Pitch_Factor (void) const
virtual void	Set_Volume (float volume)
virtual void	Set_Max_Vol_Radius (float radius)
virtual void	Set_DropOff_Radius (float radius)
virtual void	Set_Start_Offset (float offset)
virtual void	Set_Pitch_Factor (float factor)
virtual LogicalSoundClass *	Create_Logical (void)
Public Member Functions inherited from DefinitionClass
	DECLARE_EDITABLE (DefinitionClass, EditableClass)
	DefinitionClass (void)
virtual	~DefinitionClass (void)
virtual uint32	Get_ID (void) const
virtual void	Set_ID (uint32 id)
virtual const char *	Get_Name (void) const
virtual void	Set_Name (const char *new_name)
virtual bool	Is_Valid_Config (StringClass &message)
uint32	Get_User_Data (void) const
void	Set_User_Data (uint32 data)
bool	Is_Save_Enabled (void) const
void	Enable_Save (bool onoff)
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 EditableClass
virtual int	Get_Parameter_Count (void) const
virtual ParameterClass *	Lock_Parameter (int i)
virtual void	Unlock_Parameter (int i)

Protected Member Functions
bool	Save_Variables (ChunkSaveClass &csave)
bool	Load_Variables (ChunkLoadClass &cload)

Protected Attributes
float	m_Priority
float	m_Volume
float	m_Pan
int	m_LoopCount
float	m_DropOffRadius
float	m_MaxVolRadius
bool	m_Is3D
StringClass	m_Filename
int	m_Type
StringClass	m_DisplayText
float	m_StartOffset
float	m_PitchFactor
int	m_LogicalTypeMask
float	m_LogicalNotifyDelay
float	m_LogicalDropOffRadius
bool	m_CreateLogical
Vector3	m_AttenuationSphereColor
Protected Attributes inherited from DefinitionClass
int	m_DefinitionMgrLink

Detailed Description

Definition at line 382 of file AudibleSound.h.

Constructor & Destructor Documentation

AudibleSoundDefinitionClass()

AudibleSoundDefinitionClass::AudibleSoundDefinitionClass

(

void

)

Definition at line 1308 of file AudibleSound.cpp.

~AudibleSoundDefinitionClass()

virtual AudibleSoundDefinitionClass::~AudibleSoundDefinitionClass ( void )

inlinevirtual

Definition at line 396 of file AudibleSound.h.

Member Function Documentation

Create()

PersistClass * AudibleSoundDefinitionClass::Create ( void ) const

virtual

Implements DefinitionClass.

Definition at line 1573 of file AudibleSound.cpp.

Create_Logical()

LogicalSoundClass * AudibleSoundDefinitionClass::Create_Logical ( void )

virtual

Definition at line 1639 of file AudibleSound.cpp.

Create_Sound()

AudibleSoundClass * AudibleSoundDefinitionClass::Create_Sound ( int classid_hint ) const

virtual

Definition at line 1584 of file AudibleSound.cpp.

DECLARE_EDITABLE()

AudibleSoundDefinitionClass::DECLARE_EDITABLE	(	AudibleSoundDefinitionClass	,
		DefinitionClass	)

Get_Class_ID()

uint32 AudibleSoundDefinitionClass::Get_Class_ID ( void ) const

virtual

Implements DefinitionClass.

Definition at line 1369 of file AudibleSound.cpp.

Get_Display_Text()

virtual const StringClass & AudibleSoundDefinitionClass::Get_Display_Text ( void ) const

inlinevirtual

Definition at line 413 of file AudibleSound.h.

Get_DropOff_Radius()

virtual float AudibleSoundDefinitionClass::Get_DropOff_Radius ( void ) const

inlinevirtual

Definition at line 415 of file AudibleSound.h.

Get_Factory()

const PersistFactoryClass & AudibleSoundDefinitionClass::Get_Factory ( void ) const

virtual

Implements PersistClass.

Definition at line 1428 of file AudibleSound.cpp.

Get_Filename()

virtual const StringClass & AudibleSoundDefinitionClass::Get_Filename ( void ) const

inlinevirtual

Definition at line 412 of file AudibleSound.h.

Get_Max_Vol_Radius()

virtual float AudibleSoundDefinitionClass::Get_Max_Vol_Radius ( void ) const

inlinevirtual

Definition at line 414 of file AudibleSound.h.

Get_Pitch_Factor()

virtual float AudibleSoundDefinitionClass::Get_Pitch_Factor ( void ) const

inlinevirtual

Definition at line 419 of file AudibleSound.h.

Get_Sphere_Color()

virtual const Vector3 & AudibleSoundDefinitionClass::Get_Sphere_Color ( void ) const

inlinevirtual

Definition at line 416 of file AudibleSound.h.

Get_Start_Offset()

virtual float AudibleSoundDefinitionClass::Get_Start_Offset ( void ) const

inlinevirtual

Definition at line 418 of file AudibleSound.h.

Get_Volume()

virtual float AudibleSoundDefinitionClass::Get_Volume ( void ) const

inlinevirtual

Definition at line 417 of file AudibleSound.h.

Initialize_From_Sound()

void AudibleSoundDefinitionClass::Initialize_From_Sound ( AudibleSoundClass * sound )

virtual

Definition at line 1381 of file AudibleSound.cpp.

Load()

bool AudibleSoundDefinitionClass::Load ( ChunkLoadClass & cload )

virtual

Reimplemented from DefinitionClass.

Definition at line 1463 of file AudibleSound.cpp.

Load_Variables()

bool AudibleSoundDefinitionClass::Load_Variables ( ChunkLoadClass & cload )

protected

Definition at line 1531 of file AudibleSound.cpp.

Save()

bool AudibleSoundDefinitionClass::Save ( ChunkSaveClass & csave )

virtual

Reimplemented from DefinitionClass.

Definition at line 1440 of file AudibleSound.cpp.

Save_Variables()

bool AudibleSoundDefinitionClass::Save_Variables ( ChunkSaveClass & csave )

protected

Definition at line 1493 of file AudibleSound.cpp.

Set_DropOff_Radius()

virtual void AudibleSoundDefinitionClass::Set_DropOff_Radius ( float radius )

inlinevirtual

Definition at line 423 of file AudibleSound.h.

Set_Max_Vol_Radius()

virtual void AudibleSoundDefinitionClass::Set_Max_Vol_Radius ( float radius )

inlinevirtual

Definition at line 422 of file AudibleSound.h.

Set_Pitch_Factor()

virtual void AudibleSoundDefinitionClass::Set_Pitch_Factor ( float factor )

inlinevirtual

Definition at line 425 of file AudibleSound.h.

Set_Start_Offset()

virtual void AudibleSoundDefinitionClass::Set_Start_Offset ( float offset )

inlinevirtual

Definition at line 424 of file AudibleSound.h.

Set_Volume()

virtual void AudibleSoundDefinitionClass::Set_Volume ( float volume )

inlinevirtual

Definition at line 421 of file AudibleSound.h.

Member Data Documentation

m_AttenuationSphereColor

Vector3 AudibleSoundDefinitionClass::m_AttenuationSphereColor

protected

Definition at line 460 of file AudibleSound.h.

m_CreateLogical

bool AudibleSoundDefinitionClass::m_CreateLogical

protected

Definition at line 457 of file AudibleSound.h.

m_DisplayText

StringClass AudibleSoundDefinitionClass::m_DisplayText

protected

Definition at line 450 of file AudibleSound.h.

m_DropOffRadius

float AudibleSoundDefinitionClass::m_DropOffRadius

protected

Definition at line 445 of file AudibleSound.h.

m_Filename

StringClass AudibleSoundDefinitionClass::m_Filename

protected

Definition at line 448 of file AudibleSound.h.

m_Is3D

bool AudibleSoundDefinitionClass::m_Is3D

protected

Definition at line 447 of file AudibleSound.h.

m_LogicalDropOffRadius

float AudibleSoundDefinitionClass::m_LogicalDropOffRadius

protected

Definition at line 456 of file AudibleSound.h.

m_LogicalNotifyDelay

float AudibleSoundDefinitionClass::m_LogicalNotifyDelay

protected

Definition at line 455 of file AudibleSound.h.

m_LogicalTypeMask

int AudibleSoundDefinitionClass::m_LogicalTypeMask

protected

Definition at line 454 of file AudibleSound.h.

m_LoopCount

int AudibleSoundDefinitionClass::m_LoopCount

protected

Definition at line 444 of file AudibleSound.h.

m_MaxVolRadius

float AudibleSoundDefinitionClass::m_MaxVolRadius

protected

Definition at line 446 of file AudibleSound.h.

m_Pan

float AudibleSoundDefinitionClass::m_Pan

protected

Definition at line 443 of file AudibleSound.h.

m_PitchFactor

float AudibleSoundDefinitionClass::m_PitchFactor

protected

Definition at line 452 of file AudibleSound.h.

m_Priority

float AudibleSoundDefinitionClass::m_Priority

protected

Definition at line 441 of file AudibleSound.h.

m_StartOffset

float AudibleSoundDefinitionClass::m_StartOffset

protected

Definition at line 451 of file AudibleSound.h.

m_Type

int AudibleSoundDefinitionClass::m_Type

protected

Definition at line 449 of file AudibleSound.h.

m_Volume

float AudibleSoundDefinitionClass::m_Volume

protected

Definition at line 442 of file AudibleSound.h.

---

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

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