hudUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file hudUpdater.h
//! \brief Defines the HUD updater component for the spectator role
//! \ingroup vreSpectatorFrontend
 
#pragma once
 
#include <vreSpectatorFrontend/export.h>
 
#include "vrePlayerStation/playerComponent.h"
 
namespace makVre
{
//! \brief Type identifier for DtSpectatorHudUpdater component
constexpr const char* DtSpectatorHudUpdaterType = "DtSpectatorHudUpdater";
 
//! \brief Head-up display updater component for the spectator role
//!
//! This component manages the spectator's heads-up display (HUD),
//! providing real-time information overlay and visual feedback.
//! It updates HUD elements based on simulation state and spectator
//! interactions, displaying relevant information such as objectives,
//! location data, and event notifications.
class SPECTATOR_DLL DtSpectatorHudUpdater : public makVre::DtPlayerComponent
{
public:
   //! \brief Default constructor
   DtSpectatorHudUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtSpectatorHudUpdater() override;
 
   //! \brief Initializes the HUD updater component
   //! \param player Pointer to the player station
   //! \param config Reference to the initialization configuration
   //! \return True if initialization was successful, false otherwise
   //!
   //! Sets up HUD elements and registers message handlers for HUD events
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates HUD state each frame
   //! \param dt Delta time since the last update in seconds
   //!
   //! Updates HUD elements based on current simulation state
   virtual void tick(double dt) override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
   //! \brief Performs cleanup when the component is shut down
   //!
   //! Releases HUD resources and unregisters message handlers
   virtual void shutdown() override;
 
protected:
};
} // namespace makVre