vrObserverUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vrObserverUpdater.h
//! \brief Defines DtVrObserverUpdater for managing VR-specific observer effects
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "vreHumanFrontend/export.h"
 
#include "vrePlayerStation/playerComponent.h"
 
namespace makVrv
{
//! \brief Forward declaration of the display element class
class DtDe;
 
//! \brief Forward declaration of the virtual reality driver class
class DtVirtualRealityDriver;
}; // namespace makVrv
 
//! \brief Type identifier constant for DtVrObserverUpdater components
//!
//! This constant defines the string identifier used to identify DtVrObserverUpdater
//! component types within the VR-Engage framework. It is used for component
//! registration, type checking, and serialization operations.
constexpr const char* DtVrObserverUpdaterType = "DtVrObserverUpdater";
 
//! \brief VR observer updater component for visual effects
//!
//! DtVrObserverUpdater manages VR-specific visual effects for the observer,
//! including blood sight effects, aiming effects, and other post-processing
//! effects that are applied directly to the VR display. It handles enabling
//! and disabling these effects based on player state.
class HUMAN_DLL DtVrObserverUpdater : public makVre::DtPlayerComponent
{
public:
   //! \brief Default constructor
   DtVrObserverUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtVrObserverUpdater() override;
 
   //! \brief Initializes the VR observer 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 Updates VR visual 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 DtVrObserverUpdaterType.
   virtual const char* type() const override;
 
protected:
   //! \brief Updates blood sight effects based on player health
   //!
   //! Manages the intensity and visibility of blood overlay effects that
   //! indicate when the player is taking damage
   virtual void updateBloodSightEffects();
 
   //! \brief Updates aiming-related visual effects
   //!
   //! Manages visual effects that appear when the player is aiming a weapon
   virtual void updateAimingEffects();
 
   //! \brief Sets the enabled state of a named visual effect
   //! \param effect Name of the effect to control
   //! \param enabled True to enable the effect, false to disable it
   virtual void setEffectEnabled(const std::string& effect, bool enabled);
 
   //! \brief Pointer to the VR driver used to control effects
   makVrv::DtVirtualRealityDriver* myVrDriver;
 
   //! \brief Last known aiming state of the player
   bool myLastKnownAiming;
};