Base class for audio system environment components. More...

#include <AudioSystemComponent.h>

Inheritance diagram for plAudioSystemEnvironmentComponent:

[legend]

Public Member Functions
void	OnActivated () override
	This method is called when the component gets activated.

void	OnDeactivated () override
	This method is called when the component gets deactivated.

virtual float	GetEnvironmentAmount (plAudioProxyComponent *pProxyComponent) const =0
	Gets the environment amount for the specified audio proxy component.

plAudioSystemDataID	GetEnvironmentId () const
	Gets the ID of the environment in the Audio System.

virtual float	GetMaxDistance () const
	Gets the distance from the sphere's origin at which the environment amount will slightly start to decrease.

virtual void	SetMaxDistance (float fFadeDistance)
	Sets the distance from the sphere's origin at which the environment amount will slightly start to decrease.

void	OverrideEnvironmentAmount (float fValue)
	Overrides the computed environment value with the given one.

void	OnSetAmount (plMsgAudioSystemSetEnvironmentAmount &msg)

Public Member Functions inherited from plAudioSystemProxyDependentComponent
void	Initialize () override
	Can be overridden for basic initialization that depends on a valid hierarchy and position.

void	OnSimulationStarted () override
	This method is called once for active components, at the start of the next world update, but only when the world is simulated.

void	Deinitialize () override
	This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.

Public Member Functions inherited from plComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state.

bool	GetActiveFlag () const
	Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'.

bool	IsActive () const
	Checks whether this component is in an active state.

bool	IsActiveAndInitialized () const
	Returns whether this component is active and initialized.

bool	IsActiveAndSimulating () const
	Whether the component is currently active and simulation has been started as well.

plComponentManagerBase *	GetOwningManager ()
	Returns the corresponding manager for this component.

const plComponentManagerBase *	GetOwningManager () const
	Returns the corresponding manager for this component.

plGameObject *	GetOwner ()
	Returns the owner game object if the component is attached to one or nullptr.

const plGameObject *	GetOwner () const
	Returns the owner game object if the component is attached to one or nullptr.

plWorld *	GetWorld ()
	Returns the corresponding world for this component.

const plWorld *	GetWorld () const
	Returns the corresponding world for this component.

plComponentHandle	GetHandle () const
	Returns a handle to this component.

plUInt32	GetUniqueID () const
	Returns the unique id for this component.

void	SetUniqueID (plUInt32 uiUniqueID)
	Sets the unique id for this component.

virtual void	SerializeComponent (plWorldWriter &inout_stream) const
	Override this to save the current state of the component to the given stream.

virtual void	DeserializeComponent (plWorldReader &inout_stream)
	Override this to load the current state of the component from the given stream.

void	EnsureInitialized ()
	Ensures that the component is initialized. Must only be called from another component's Initialize callback.

void	EnsureSimulationStarted ()
	Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg)
	Sends a message to this component.

PL_ALWAYS_INLINE bool	SendMessage (plMessage &ref_msg) const

void	PostMessage (const plMessage &msg, plTime delay=plTime::MakeZero(), plObjectMsgQueueType::Enum queueType=plObjectMsgQueueType::NextFrame) const
	Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.

virtual bool	HandlesMessage (const plMessage &msg) const
	Returns whether the given Message is handled by this component.

void	SetUserFlag (plUInt8 uiFlagIndex, bool bSet)
	Be careful to check which flags may already be in use by base classes.

bool	GetUserFlag (plUInt8 uiFlagIndex) const
	Retrieves a custom flag. Index must be between 0 and 7.

void	SetCreatedByPrefab ()
	Adds plObjectFlags::CreatedByPrefab to the component. See the flag for details.

bool	WasCreatedByPrefab () const
	Checks whether the plObjectFlags::CreatedByPrefab flag is set on this component.

Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const plRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T >
PL_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Protected Attributes
float	m_fMaxDistance

plString	m_sEnvironmentName

plColor	m_ShapeColor

bool	m_bOverrideValue

float	m_fOverrideValue

Protected Attributes inherited from plAudioSystemProxyDependentComponent
class plAudioProxyComponent *	m_pProxyComponent {nullptr}

Protected Attributes inherited from plComponent
const plRTTI *	m_pMessageDispatchType = nullptr
	Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Protected Member Functions inherited from plAudioSystemProxyDependentComponent
plAudioSystemDataID	GetEntityId () const
	Get the ID of the entity referenced by the proxy.

Protected Member Functions inherited from plAudioSystemComponent
virtual void	plAudioSystemComponentIsAbstract ()=0

Protected Member Functions inherited from plComponent
	plComponent ()
	Keep the constructor private or protected in derived classes, so it cannot be called manually.

bool	IsDynamic () const
	Returns whether this component is dynamic and thus can only be attached to dynamic game objects.

virtual plWorldModuleTypeId	GetTypeId () const =0

virtual plComponentMode::Enum	GetMode () const =0

void	EnableUnhandledMessageHandler (bool enable)
	By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.

virtual bool	OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg)
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

virtual bool	OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) const
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Detailed Description

Base class for audio system environment components.

Member Function Documentation

◆ GetEnvironmentAmount()

virtual float plAudioSystemEnvironmentComponent::GetEnvironmentAmount ( plAudioProxyComponent * pProxyComponent ) const

nodiscardpure virtual

Gets the environment amount for the specified audio proxy component.

Parameters

pProxyComponent The proxy component for which compute the environment amount.

Returns: The environment amount.

Implemented in plAudioBoxEnvironmentComponent, and plAudioSphereEnvironmentComponent.

◆ OnActivated()

void plAudioSystemEnvironmentComponent::OnActivated ( )

overridevirtual

This method is called when the component gets activated.

By default a component is active, but it can be created in an inactive state. In such a case OnActivated() is only called once a component is activated. If a component gets switched between active and inactive at runtime, OnActivated() and OnDeactivated() are called accordingly. In contrast Initialize() and Deinitialize() are only ever called once.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from plComponent.

◆ OnDeactivated()

void plAudioSystemEnvironmentComponent::OnDeactivated ( )

overridevirtual

This method is called when the component gets deactivated.

Upon destruction, a component that is active first gets deactivated. Therefore OnDeactivated() should be used for typical game code cleanup.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from plComponent.

◆ OverrideEnvironmentAmount()

void plAudioSystemEnvironmentComponent::OverrideEnvironmentAmount ( float fValue )

Overrides the computed environment value with the given one.

Parameters

fValue The override value. Use a negative value to cancel any previous override.

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

Code/EnginePlugins/AudioSystem/AudioSystemPlugin/Components/AudioSystemComponent.h
Code/EnginePlugins/AudioSystem/AudioSystemPlugin/Implementation/Components/AudioSystemComponent.cpp

Public Member Functions