vrvSensorOverlayUpdater.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vrvSensorOverlayUpdater.h
//! \brief Component for managing gimbal sensor overlay sections
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/playerComponent.h"
 
namespace makVre
{
namespace VrvSensorOverlayUpdaterConfig
{
//! \ingroup RoleConfigParams
//! \defgroup VrvSensorOverlayUpdaterRoleParams VRV Sensor Overlay Updater Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for VRV sensor overlay updater role.
//! @{
 
//! \vreRoleParamRequired{sections,table,vrvSensorOverlayUpdater,{},Table of sensor overlay section names to display in the gimbal sensor view.}
constexpr const char* sections = "sections";
 
//! @}
} // namespace VrvSensorOverlayUpdaterConfig
 
//! \brief Type identifier for DtVrvSensorOverlayUpdater component
constexpr const char* DtVrvSensorOverlayUpdaterType = "DtVrvSensorOverlayUpdater";
 
//! \brief Component for configuring and managing gimbal sensor overlay sections
//!
//! DtVrvSensorOverlayUpdater manages which overlay sections are displayed
//! in the gimbal sensor view. It allows customization of the sensor display
//! by including or excluding specific overlay sections based on configuration,
//! and restores default sections when shutting down.
class VRECOMMONCOMPONENTS_DLL DtVrvSensorOverlayUpdater : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtVrvSensorOverlayUpdater
   //!
   //! Initializes the component with the name "DtVrvSensorOverlayUpdater"
   DtVrvSensorOverlayUpdater();
 
   //! \brief Virtual destructor for DtVrvSensorOverlayUpdater
   virtual ~DtVrvSensorOverlayUpdater() override;
 
   //! \brief Initializes the sensor overlay updater component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing overlay section settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Reads the "sections" configuration list to determine which overlay sections
   //! should be displayed. If no sections are specified, default overlay sections
   //! will be used. Sends a SetGimbalOverlaySectionsMessage with the configured
   //! sections to apply the changes.
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
   //! \brief Called every frame to update the component state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Current implementation has no per-frame update actions
   virtual void tick(double dt) override;
   //! \brief Shuts down the sensor overlay updater component
   //!
   //! Sends a RestoreGimbalOverlaySectionsMessage to revert to the default
   //! overlay sections configuration
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtVrvSensorOverlayUpdater
   virtual const char* type() const override;
 
protected:
   // No protected members are required for this component
};
} // namespace makVre