humanVrHudUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file humanVrHudUpdater.h
//! \brief Defines DtHumanVrHudUpdater for managing human-specific HUD elements in VR mode
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "vreHumanFrontend/export.h"
 
#include "vreHumanFrontend/humanHudUpdater.h"
#include "vreCommonComponents/stateDefines.h"
 
 
namespace makVre
{
//! \brief Type identifier for DtHumanVrHudUpdater component
constexpr const char* DtHumanVrHudUpdaterType = "DtHumanVrHudUpdater";
 
//! \brief HUD updater component for the human role in VR mode
//!
//! DtHumanVrHudUpdater extends the standard human HUD updater with VR-specific
//! functionality, managing specialized rendering of HUD elements for VR displays.
//! It handles positioning, visibility, and updates of HUD elements based on
//! the player state in VR mode, including weapon indicators and reticles.
class HUMAN_DLL DtHumanVrHudUpdater : public DtHumanHudUpdater
{
public:
   //! \brief Default constructor
   DtHumanVrHudUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtHumanVrHudUpdater() override;
 
   //! \brief Initializes the VR HUD updater component
   //! \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 Performs post-initialization setup
   //! \return True if post-initialization was successful, false otherwise
   virtual bool postInitialize() override;
 
   //! \brief Updates the VR HUD elements 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 The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Finds an OSG channel by name
   //! \param channelName Name of the channel to find, empty for default channel
   //! \return Pointer to the found channel, or nullptr if not found
   virtual makVrv::DtOsgChannel* findChannel(const std::string& channelName = "") override;
 
   //! \brief Deletes all HUD elements
   virtual void deleteAll() override;
 
   //! \brief Checks if this updater provides the reticle
   //! \return True if this updater provides the reticle, false otherwise
   //! \note Overrides parent class method to handle VR-specific reticle behavior
   virtual bool amReticleProvider() const override;
 
   //! \brief Updates the gun reticle in VR mode
   //! \param visible Flag indicating if the reticle should be visible
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Updates position, size, and visibility of the gun reticle for VR
   void updateGunReticle(bool visible, double dt);
 
   //! \brief Handles changes in VR state
   //! \param enabled True if VR is enabled, false otherwise
   void onVrStateChanged(bool enabled);
 
   //! \brief Handles changes in the current weapon index
   //! \param index New weapon index
   //! \note Overrides parent class method to handle VR-specific behavior
   virtual void onWeaponIndexChanged(int index) override;
 
   //! \brief Handles changes in weapon state
   //! \param state New weapon state
   //! \note Overrides parent class method to handle VR-specific behavior
   virtual void onWeaponStateChanged(int state) override;
 
   //! \brief Handles changes in the launcher entity ID
   //! \param id New launcher entity identifier
   //! \note Overrides parent class method to handle VR-specific behavior
   virtual void onLauncherIdChanged(DtEntityIdentifier id) override;
 
   //! \brief Handles changes in the weapon list
   //! \param weapons New list of weapon names
   //! \note Overrides parent class method to handle VR-specific behavior
   virtual void onWeaponListChanged(const DtAttributeHandle&) override;
 
   //! \brief Handles changes in player posture
   //! \param posture New player posture
   //! \note Overrides parent class method to handle VR-specific behavior
   virtual void onPostureChanged(HumanPosture posture);
 
   //! \brief Applies a delayed fade effect to a fader value
   //! \param fader Pointer to the fader value to update
   //! \param val Target fade value
   virtual void delayFade(float* fader, float val);
 
   //! \brief Applies a fade effect to a quad proxy
   //! \param quad Pointer to the quad proxy to fade
   //! \param val Fade value to apply
   virtual void applyFade(makVrv::DtQuadProxy* quad, float val);
 
   //! \brief Applies a fade effect to a text proxy
   //! \param text Pointer to the text proxy to fade
   //! \param val Fade value to apply
   virtual void applyFade(makVrv::DtTextProxy* text, float val);
 
protected:
   //! \brief Current fade value for weapon indicators
   float myWeaponFadeValue;
 
   //! \brief Current fade value for posture indicators
   float myPostureFadeValue;
 
   //! \brief VR-specific aim point cursor
   makVre::DtMenuCursor* myVrAimPoint;
};
} // namespace makVre