Open 3D Engine AudioSystem Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Friends | List of all members
Audio::CATLAudioObject Class Reference

Inherits Audio::CATLAudioObjectBase, and AudioRaycastNotificationBus::Handler.

Public Member Functions

 CATLAudioObject (const TAudioObjectID nID, IATLAudioObjectData *const pImplData=nullptr)
 
 CATLAudioObject (const CATLAudioObject &)=delete
 
CATLAudioObject & operator= (const CATLAudioObject &)=delete
 
bool HasPosition () const override
 
void Clear () override
 
void Update (const float fUpdateIntervalMS, const SATLWorldPosition &rListenerPosition) override
 
void SetPosition (const SATLWorldPosition &oNewPosition)
 
void SetRaycastCalcType (const ObstructionType type)
 
void RunRaycasts (const SATLWorldPosition &listenerPos)
 
bool CanRunRaycasts () const
 
void GetObstOccData (SATLSoundPropagationData &data) const
 
void OnAudioRaycastResults (const AudioRaycastResult &result) override
 
void SetVelocityTracking (const bool bTrackingOn)
 
bool GetVelocityTracking () const
 
void UpdateVelocity (const float fUpdateIntervalMS)
 
void DrawDebugInfo (AzFramework::DebugDisplayRequests &debugDisplay, const AZ::Vector3 &listenerPos, const CATLDebugNameStore *const debugNameStore) const
 
const SATLWorldPosition & GetPosition () const
 
- Public Member Functions inherited from Audio::CATLAudioObjectBase
void TriggerInstanceStarting (TAudioTriggerInstanceID triggerInstanceId, TAudioControlID audioControlId)
 
void TriggerInstanceStarted (TAudioTriggerInstanceID triggerInstanceId, void *owner)
 
void TriggerInstanceFinished (TObjectTriggerStates::const_iterator iter)
 
void EventStarted (const CATLEvent *const atlEvent)
 
void EventFinished (const CATLEvent *const atlEvent)
 
void SetSwitchState (const TAudioControlID nSwitchID, const TAudioSwitchStateID nStateID)
 
void SetRtpc (const TAudioControlID nRtpcID, const float fValue)
 
void SetEnvironmentAmount (const TAudioEnvironmentID nEnvironmentID, const float fAmount)
 
const TObjectTriggerImplStates & GetTriggerImpls () const
 
const TObjectRtpcMap & GetRtpcs () const
 
const TObjectEnvironmentMap & GetEnvironments () const
 
void ClearRtpcs ()
 
void ClearEnvironments ()
 
const TObjectEventSet & GetActiveEvents () const
 
bool HasActiveEvents () const
 
TObjectTriggerInstanceSet GetTriggerInstancesByOwner (void *const pOwner) const
 
void IncrementRefCount ()
 
void DecrementRefCount ()
 
size_t GetRefCount () const
 
void SetImplDataPtr (IATLAudioObjectData *const pImplData)
 
IATLAudioObjectData * GetImplDataPtr () const
 
virtual bool HasPosition () const =0
 
void CheckBeforeRemoval (const CATLDebugNameStore *const pDebugNameStore)
 
- Public Member Functions inherited from Audio::CATLEntity< TAudioObjectID >
 CATLEntity (const TAudioObjectID nID, const EATLDataScope eDataScope)
 
virtual TAudioObjectID GetID () const
 
virtual EATLDataScope GetDataScope () const
 

Friends

class ::ATLAudioObjectTest
 

Additional Inherited Members

- Protected Types inherited from Audio::CATLAudioObjectBase
using TStateDrawInfoMap = ATLMapLookupType< TAudioControlID, CStateDebugDrawData >
 
- Protected Member Functions inherited from Audio::CATLAudioObjectBase
 CATLAudioObjectBase (const TAudioObjectID nObjectID, const EATLDataScope eDataScope, IATLAudioObjectData *const pImplData=nullptr)
 
virtual void Clear ()
 
virtual void Update (const float fUpdateIntervalMS, const SATLWorldPosition &rListenerPosition)
 
AZStd::string GetTriggerNames (const char *const sSeparator, const CATLDebugNameStore *const pDebugNameStore)
 
AZStd::string GetEventIDs (const char *const sSeparator)
 
- Protected Attributes inherited from Audio::CATLAudioObjectBase
TObjectEventSet m_cActiveEvents
 
TObjectTriggerStates m_cTriggers
 
TObjectTriggerImplStates m_cTriggerImpls
 
TObjectRtpcMap m_cRtpcs
 
TObjectEnvironmentMap m_cEnvironments
 
TObjectStateMap m_cSwitchStates
 
size_t m_nRefCounter
 
IATLAudioObjectData * m_pImplData
 
TStateDrawInfoMap m_cStateDrawInfoMap
 
- Protected Attributes inherited from Audio::CATLEntity< TAudioObjectID >
EATLDataScope m_eDataScope
 

Member Function Documentation

◆ Clear()

void Audio::CATLAudioObject::Clear ( )
overridevirtual

Reimplemented from Audio::CATLAudioObjectBase.

◆ HasPosition()

bool Audio::CATLAudioObject::HasPosition ( ) const
inlineoverridevirtual

Implements Audio::CATLAudioObjectBase.

◆ Update()

void Audio::CATLAudioObject::Update ( const float  fUpdateIntervalMS,
const SATLWorldPosition &  rListenerPosition 
)
overridevirtual

Reimplemented from Audio::CATLAudioObjectBase.

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