humanAudioUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file humanAudioUpdater.h
//! \brief Defines DtHumanAudioUpdater for managing audio effects in the human role
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "vreHumanFrontend/export.h"
 
#include "vreCommonComponents/stateDefines.h"
 
#include "vrePlayerStation/playerComponent.h"
 
namespace makVrv
{
//! \brief Forward declaration of the display element class
class DtDe;
} // namespace makVrv
 
namespace makAudio
{
//! \brief Forward declaration of the sound class
class DtSound;
} // namespace makAudio
 
namespace makVre
{
//! \brief Forward declaration of the soundscape class
class DtSoundscape;
} // namespace makVre
 
namespace HumanAudioUpdaterConfig
{
//! \ingroup RoleConfigParams
//! \defgroup HumanAudioUpdaterRoleParams Human Audio Updater Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for humanAudioUpdater role.
//! @{
 
//! \vreRoleParam{soundConfig,table,{},humanAudioUpdater,Configuration table containing audio settings for parachute and weapon sounds.}
constexpr const char* soundConfig = "soundConfig";
 
//! \vreRoleParam{soundscape,string,"",humanAudioUpdater,Name of the soundscape configuration file for ambient audio.}
constexpr const char* soundscape = "soundscape";
 
//! \vreRoleParam{soundscapeVolume,double,0.7,humanAudioUpdater,Volume level for the ambient soundscape audio.}
constexpr const char* soundscapeVolume = "soundscapeVolume";
 
//! @}
} // namespace HumanAudioUpdaterConfig
 
//! \brief Type identifier constant for DtHumanAudioUpdater components
//!
//! This constant defines the string identifier used to identify DtHumanAudioUpdater
//! component types within the VR-Engage framework. It is used for component
//! registration, type checking, and serialization operations.
constexpr const char* DtHumanAudioUpdaterType = "DtHumanAudioUpdater";
 
//! \brief Component for managing human-specific audio effects
//!
//! DtHumanAudioUpdater handles the audio effects related to the human entity,
//! such as parachute sounds, weapon reload sounds, and environment soundscapes.
//! It controls the timing and volume of audio cues based on player state and actions.
class HUMAN_DLL DtHumanAudioUpdater : public makVre::DtPlayerComponent
{
public:
   //! \brief Default constructor
   DtHumanAudioUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtHumanAudioUpdater() override;
 
   //! \brief Initializes the audio updater
   //! \param player Pointer to the player station
   //! \param config Configuration settings for initialization
   //! \return True if initialization was successful, false otherwise
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates audio effects for the current frame
   //! \param dt Delta time since the last frame in seconds
   virtual void tick(double dt) override;
 
   //! \brief Cleans up resources when the component is being shut down
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return 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 DtHumanAudioUpdaterType.
   virtual const char* type() const override;
 
   //! \brief Handles changes in the weapon reload timer
   //! \param reloadTimer Current value of the reload timer in seconds
   //!
   //! Called when the weapon reload timer changes, to update reload sound effects
   virtual void onReloadTimerChanged(float reloadTimer);
 
protected:
   //! \brief Sound played during parachute freefall
   makAudio::DtSound* myParachuteFreefallSound;
 
   //! \brief Sound played when parachute opens
   makAudio::DtSound* myParachuteOpenSound;
 
   //! \brief Sound played when inside an open parachute
   makAudio::DtSound* myParachuteInteriorSound;
 
   //! \brief Sound played during weapon reload
   makAudio::DtSound* myReloadSound;
 
   //! \brief Normal speed for freefall sound playback
   double myFreefallNormalSpeed;
 
   //! \brief Normal volume for freefall sound
   double myFreefallNormalVolume;
 
   //! \brief Current environmental soundscape
   makVre::DtSoundscape* mySoundscape;
 
   //! \brief Volume of the current soundscape
   double mySoundscapeVolume;
 
   //! \brief Cached posture of the human entity
   //!
   //! Stored here so the open parachute sound can be triggered
   //! at the right time.
   makVre::HumanPosture myCachedPosture;
};