droneHudUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file droneHudUpdater.h
//! \brief Defines DtDroneHudUpdater for drone-specific HUD elements and overlays
//! \ingroup vreHumanFrontend
 
#pragma once
 
#include "vreHumanFrontend/export.h"
 
#include "vreHumanFrontend/hudUpdater.h"
 
namespace makVre
{
//! \brief Type identifier for DtHumanVrHudUpdater component
constexpr const char* DtDroneHudUpdaterType = "DtDroneHudUpdater";
 
//! \brief HUD updater component for drone operation displays
//!
//! DtDroneHudUpdater manages the drone-specific HUD elements including
//! the drone view frame, battery status, distance from home, altitude,
//! heading, and speed indicators. It updates these elements based on
//! the current drone state and sensor information.
class HUMAN_DLL DtDroneHudUpdater : public DtHudUpdater
{
public:
   //! \brief Default constructor
   DtDroneHudUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtDroneHudUpdater() override;
 
   //! \brief Initializes the drone HUD 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 the drone HUD elements for the current frame
   //! \param dt Delta time since the last frame in seconds
   virtual void tick(double dt) override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Handles changes in drone operation state
   //! \param usingDrone True if the player is using a drone, false otherwise
   virtual void onUsingDroneChanged(bool usingDrone);
 
   //! \brief Called when the HUD updater is started
   virtual void onStart() override;
 
   //! \brief Called when the HUD updater is stopped
   virtual void onStop() override;
 
   //! \brief Updates all HUD elements
   virtual void updateAll() override;
 
   //! \brief Updates all HUD elements based on visibility
   //! \param visible Flag indicating if the reticle is visible
   virtual void updateHudElements(bool visible) override;
 
   //! \brief Updates the drone display elements
   //! \param visible Flag indicating if the drone display should be visible
   //! \param reset Flag indicating if the display should be reset to default state
   virtual void updateDroneDisplay(bool visible = true, bool reset = false);
 
   //! \brief Updates the drone battery amount display
   //! \param amount Current battery level as a percentage
   virtual void updateDroneBatteryAmount(float amount);
 
   //! \brief Handles resource update messages
   //! \param msg Pointer to the message being processed
   //! \return Message processing result
   virtual makVre::DtVreMessageResult handleResourceUpdate(makVre::DtVreMessage* msg);
 
   //! \brief Handles simulation state change messages
   //! \param msg Pointer to the message being processed
   //! \return Message processing result
   virtual makVre::DtVreMessageResult handleSimulationState(makVre::DtVreMessage* msg);
 
   //! \brief Deletes all HUD elements
   virtual void onDeleteAll() override;
 
   //! \brief Finds a channel by name
   //! \param channelName Name of the channel to find, defaults to "Channel 1"
   //! \return Pointer to the found channel, or nullptr if not found
   virtual makVrv::DtOsgChannel* findChannel(const std::string& channelName = "Channel 1") override;
 
   //! \brief Creates quad overlays based on the provided configurations
   //! \param overlay Pointer to the overlay renderer
   //! \param configs Vector of HUD image configurations to create
   virtual void createQuads(makVrv::DtOverlayRenderer* overlay, const std::vector<HudImageConfig>& configs) override;
 
   //! \brief Flag indicating if the drone HUD is currently visible
   bool myDroneHudVisible;
 
   //! \brief Quad proxy for the drone icon display
   makVrv::DtQuadProxy* myDrone;
 
   //! \brief Quad proxy for the drone view frame
   makVrv::DtQuadProxy* myDroneViewFrame;
 
   //! \brief Text proxy for displaying battery status
   makVrv::DtTextProxy* myBatteryText;
 
   //! \brief Text proxy for displaying distance from home base
   makVrv::DtTextProxy* myDistanceFromHome;
 
   //! \brief Text proxy for displaying altitude above ground level
   makVrv::DtTextProxy* myAgl;
 
   //! \brief Text proxy for displaying current heading
   makVrv::DtTextProxy* myHeading;
 
   //! \brief Text proxy for displaying horizontal speed
   makVrv::DtTextProxy* myHorizontalSpeed;
 
   //! \brief Text proxy for displaying vertical speed
   makVrv::DtTextProxy* myVerticalSpeed;
 
   //! \brief Current drone battery amount as a percentage
   double myDroneBatteryAmount;
 
   //! \brief Location for wind effect requests
   DtVector myWindRequestLocation;
 
   //! \brief Name of the channel used for drone display
   std::string myChannelName;
 
   //! \brief Current velocity vector of the drone
   DtVector myDroneVelocity;
};
} // namespace makVre