VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtSpectatorAudioUpdater Class Reference

Detailed Description

This component manages audio feedback for the spectator role, including handling sound effects, ambient audio, and event-based audio cues. It responds to simulation events and updates audio sources accordingly.

#include <audioUpdater.h>

Inheritance diagram for makVre::DtSpectatorAudioUpdater:
[legend]

Public Member Functions

 DtSpectatorAudioUpdater ()
 
virtual ~DtSpectatorAudioUpdater () override
 
virtual bool initialize (makVre::DtPlayerStation *player, makVre::DtInitTable &config) override
 
virtual void tick (double dt) override
 
virtual void shutdown () override
 
virtual const char * type () const override
 
- Public Member Functions inherited from makVre::DtPlayerComponent
 DtPlayerComponent ()
 
virtual ~DtPlayerComponent ()
 
virtual bool postInitialize ()
 
virtual void setName (const std::string &name)
 
virtual const std::string & name ()
 
virtual DtPlayerStationplayer ()
 
virtual DtAttributeHandleplayerAttributeStore ()
 
virtual const DtAttributeHandleplayerAttributeStore () const
 

Additional Inherited Members

- Protected Member Functions inherited from makVre::DtPlayerComponent
virtual void initializeStateAttributes ()
 
- Protected Attributes inherited from makVre::DtPlayerComponent
std::string myName
 
DtInitTable myConfig
 
DtPlayerStationmyPlayer
 
makVrv::DtDe * myDe
 
DtEntityResolvermyResolver
 
DtAttributeCallbackManager myAttributeCallbacks
 

Constructor & Destructor Documentation

◆ DtSpectatorAudioUpdater()

makVre::DtSpectatorAudioUpdater::DtSpectatorAudioUpdater ( )

Default constructor.

◆ ~DtSpectatorAudioUpdater()

virtual makVre::DtSpectatorAudioUpdater::~DtSpectatorAudioUpdater ( )
overridevirtual

Virtual destructor.

Member Function Documentation

◆ initialize()

virtual bool makVre::DtSpectatorAudioUpdater::initialize ( makVre::DtPlayerStation * player,
makVre::DtInitTable & config )
overridevirtual

Initializes the audio updater component.

Parameters
playerPointer to the player station
configReference to the initialization configuration
Returns
True if initialization was successful, false otherwise

Sets up audio sources and registers message handlers for audio events

Reimplemented from makVre::DtPlayerComponent.

References makVre::DtPlayerComponent::player().

◆ tick()

virtual void makVre::DtSpectatorAudioUpdater::tick ( double dt)
overridevirtual

Updates audio state each frame.

Parameters
dtDelta time since the last update in seconds

Updates audio sources and manages sound playback based on simulation state

Implements makVre::DtPlayerComponent.

◆ shutdown()

virtual void makVre::DtSpectatorAudioUpdater::shutdown ( )
overridevirtual

Performs cleanup when the component is shut down.

Releases audio resources and unregisters message handlers

Reimplemented from makVre::DtPlayerComponent.

◆ type()

virtual const char * makVre::DtSpectatorAudioUpdater::type ( ) const
overridevirtual

Returns the component type identifier.

Returns
String identifier for this component type

Returns the type identifier string for this component, which is used by the VR-Engage framework for component identification and management. The returned value matches DtSpectatorAudioUpdaterType.

Implements makVre::DtPlayerComponent.


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