plAudioWorldModule Class Reference

World Module allowing to access audio system features, query environments and environment amounts, and extracting obstruction/occlusion data. More...

#include <AudioWorldModule.h>

Inheritance diagram for plAudioWorldModule:

Public Member Functions
	plAudioWorldModule (plWorld *pWorld)
void	Initialize () override
	This method is called after the constructor. A derived type can override this method to do initialization work. Typically this is the method where updates function are registered.
void	AddEnvironment (const plAudioSystemEnvironmentComponent *pComponent)
void	RemoveEnvironment (const plAudioSystemEnvironmentComponent *pComponent)
EnvironmentSet::Iterator	GetEnvironments () const
void	SetDefaultListener (const plAudioListenerComponent *pListener)
const plAudioListenerComponent *	GetDefaultListener () const
Public Member Functions inherited from plWorldModule
plWorld *	GetWorld ()
	Returns the corresponding world to this module.
const plWorld *	GetWorld () const
	Returns the corresponding world to this module.
plUInt32	GetWorldIndex () const
	Same as GetWorld()->GetIndex(). Needed to break circular include dependencies.
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.

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()
Protected Types inherited from plWorldModule
using	UpdateFunction = plDelegate<void(const UpdateContext&)>
	Update function delegate.
Protected Member Functions inherited from plWorldModule
	plWorldModule (plWorld *pWorld)
void	RegisterUpdateFunction (const UpdateFunctionDesc &desc)
	Registers the given update function at the world.
void	DeregisterUpdateFunction (const UpdateFunctionDesc &desc)
	De-registers the given update function from the world. Note that only the m_Function and the m_Phase of the description have to be valid for de-registration.
plAllocator *	GetAllocator ()
	Returns the allocator used by the world.
plInternal::WorldLargeBlockAllocator *	GetBlockAllocator ()
	Returns the block allocator used by the world.
bool	GetWorldSimulationEnabled () const
	Returns whether the world simulation is enabled.
virtual void	Deinitialize ()
	This method is called before the destructor. A derived type can override this method to do deinitialization work.
virtual void	OnSimulationStarted ()
	This method is called at the start of the next world update when the world is simulated. This method will be called after the initialization method.
virtual void	WorldClear ()
	Called by plWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).
Protected Attributes inherited from plWorldModule
plWorld *	m_pWorld

Detailed Description

World Module allowing to access audio system features, query environments and environment amounts, and extracting obstruction/occlusion data.

Member Function Documentation

Initialize()

void plAudioWorldModule::Initialize ( )

overridevirtual

This method is called after the constructor. A derived type can override this method to do initialization work. Typically this is the method where updates function are registered.

Reimplemented from plWorldModule.

---

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

• Code/EnginePlugins/AudioSystem/AudioSystemPlugin/Core/AudioWorldModule.h
• Code/EnginePlugins/AudioSystem/AudioSystemPlugin/Implementation/Core/AudioWorldModule.cpp