ScummVM API documentation
Public Member Functions | Static Public Member Functions | List of all members
hpl::cSoundEntity Class Reference
Inheritance diagram for hpl::cSoundEntity:
hpl::iEntity3D hpl::iEntity hpl::iSaveObject

Public Member Functions

 cSoundEntity (const tString &asName, cSoundEntityData *apData, cSoundEntityManager *apSoundEntityManager, cWorld3D *apWorld, cSoundHandler *apSoundHandler, bool abRemoveWhenOver)
 
void Play (bool abPlayStart=true)
 
void Stop (bool abPlayEnd=true)
 
void FadeIn (float afSpeed)
 
void FadeOut (float afSpeed)
 
bool IsStopped ()
 
bool IsFadingOut ()
 
float getFadingSpeed ()
 
bool GetRemoveWhenOver ()
 
void SetVolume (float afX)
 
float GetVolume ()
 
iSoundChannel * GetSound (eSoundEntityType aType)
 
cSoundEntry * GetSoundEntry (eSoundEntityType aType)
 
void UpdateLogic (float afTimeStep)
 
tString GetEntityType ()
 
cSoundEntityData * GetData ()
 
virtual iSaveData * CreateSaveData ()
 
virtual void SaveToSaveData (iSaveData *apSaveData)
 
virtual void LoadFromSaveData (iSaveData *apSaveData)
 
virtual void SaveDataSetup (cSaveObjectHandler *apSaveObjectHandler, cGame *apGame)
 
- Public Member Functions inherited from hpl::iEntity3D
 iEntity3D (tString asName)
 
cVector3f GetLocalPosition ()
 
cMatrixf & GetLocalMatrix ()
 
cVector3f GetWorldPosition ()
 
cMatrixf & GetWorldMatrix ()
 
void SetPosition (const cVector3f &avPos)
 
void SetMatrix (const cMatrixf &a_mtxTransform)
 
void SetWorldPosition (const cVector3f &avWorldPos)
 
void SetWorldMatrix (const cMatrixf &a_mtxWorldTransform)
 
void SetTransformUpdated (bool abUpdateCallbacks=true)
 
bool GetTransformUpdated ()
 
int GetTransformUpdateCount ()
 
void AddCallback (iEntityCallback *apCallback)
 
void RemoveCallback (iEntityCallback *apCallback)
 
void SetSourceFile (const tString &asFile)
 
const tString & GetSourceFile ()
 
virtual cBoundingVolume * GetBoundingVolume ()
 
void AddChild (iEntity3D *apEntity)
 
void RemoveChild (iEntity3D *apEntity)
 
bool IsChild (iEntity3D *apEntity)
 
iEntity3D * GetEntityParent ()
 
virtual tRenderContainerDataList * GetRenderContainerDataList ()
 
int GetIteratorCount ()
 
void SetIteratorCount (const int alX)
 
void SetCurrentSector (cSector *apSetor)
 
virtual cSector * GetCurrentSector () const
 
bool IsInSector (cSector *apSector)
 
int GetGlobalRenderCount ()
 
void SetGlobalRenderCount (int alX)
 
virtual iSaveData * CreateSaveData ()
 
virtual void SaveToSaveData (iSaveData *apSaveData)
 
virtual void LoadFromSaveData (iSaveData *apSaveData)
 
virtual void SaveDataSetup (cSaveObjectHandler *apSaveObjectHandler, cGame *apGame)
 
- Public Member Functions inherited from hpl::iEntity
 iEntity (tString asName)
 
virtual tString GetEntityType ()=0
 
virtual void UpdateLogic (float afTimeStep)
 
tString & GetName ()
 
void SetName (const tString &asName)
 
iNode * GetParent ()
 
void SetParent (iNode *apNode)
 
bool HasParent ()
 
bool IsActive ()
 
void SetActive (bool abActive)
 
virtual bool IsVisible ()
 
virtual void SetVisible (bool abVisible)
 
virtual iSaveData * CreateSaveData ()
 
virtual void SaveToSaveData (iSaveData *apSaveData)
 
virtual void LoadFromSaveData (iSaveData *apSaveData)
 
virtual void SaveDataSetup (cSaveObjectHandler *apSaveObjectHandler, cGame *apGame)
 
- Public Member Functions inherited from hpl::iSaveObject
int GetSaveObjectId ()
 
virtual void SaveToSaveData (iSaveData *apSaveData)
 
virtual void LoadFromSaveData (iSaveData *apSaveData)
 
virtual iSaveData * CreateSaveData ()=0
 
virtual void SaveDataSetup (cSaveObjectHandler *apSaveObjectHandler, cGame *apGame)
 
void SetIsSaved (bool abX)
 
bool IsSaved ()
 

Static Public Member Functions

static void initGlobalCallbackList ()
 
static void finalizeGlobalCallbackList ()
 
static void AddGlobalCallback (iSoundEntityGlobalCallback *apCallback)
 
static void RemoveGlobalCallback (iSoundEntityGlobalCallback *apCallback)
 

Additional Inherited Members

- Protected Attributes inherited from hpl::iEntity3D
cMatrixf m_mtxLocalTransform
 
cMatrixf m_mtxWorldTransform
 
cBoundingVolume mBoundingVolume
 
bool mbUpdateBoundingVolume
 
bool mbApplyTransformToBV
 
bool mbTransformUpdated
 
int mlGlobalRenderCount
 
int mlCount
 
tString msSourceFile
 
tEntityCallbackList mlstCallbacks
 
tRenderContainerDataList mlstRenderContainerData
 
tEntity3DList mlstChildren
 
iEntity3D * mpParent
 
cSector * mpCurrentSector
 
int mlIteratorCount
 
- Protected Attributes inherited from hpl::iEntity
iNode * mpParentNode
 
tString msName
 
bool mbIsVisible
 
bool mbIsActive
 
- Protected Attributes inherited from hpl::iSaveObject
iSaveData * mpSaveData
 

Member Function Documentation

◆ UpdateLogic()

void hpl::cSoundEntity::UpdateLogic ( float  afTimeStep)
virtual

Reimplemented from hpl::iEntity.

◆ GetEntityType()

tString hpl::cSoundEntity::GetEntityType ( )
inlinevirtual

Implements hpl::iEntity.

◆ CreateSaveData()

virtual iSaveData * hpl::cSoundEntity::CreateSaveData ( )
virtual

Creates the SaveData that this class uses.

Reimplemented from hpl::iEntity3D.

◆ SaveToSaveData()

virtual void hpl::cSoundEntity::SaveToSaveData ( iSaveData *  apSaveData)
virtual

Save it's data to a SaveData

Reimplemented from hpl::iEntity3D.

◆ LoadFromSaveData()

virtual void hpl::cSoundEntity::LoadFromSaveData ( iSaveData *  apSaveData)
virtual

Load it's data from a SaveData

Reimplemented from hpl::iEntity3D.

◆ SaveDataSetup()

virtual void hpl::cSoundEntity::SaveDataSetup ( cSaveObjectHandler *  apSaveObjectHandler,
cGame *  apGame 
)
virtual

After all objects have been created, this function is called to enable setup.

Reimplemented from hpl::iEntity3D.

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