vreOsgSensorViewPlatformInfoOverlaySection.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreOsgSensorViewPlatformInfoOverlaySection.h
//! \brief Defines the overlay section for displaying platform information
//!
//! This file contains the DtVreOsgSensorViewPlatformInfoOverlaySection class which
//! provides an overlay section for displaying information about the platform
//! (vehicle or entity) on which the sensor is mounted. This information includes
//! altitude above ground level, time, and other platform-specific data.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <vrvOsg/DtOsgSensorViewPlatformInfoOverlaySection.h>
#include <vrvCore/DtDisplayUnitsSettingsManager.h>
 
#include <vreMessageManager/vreMessage.h>
 
namespace makVrv
{
class DtTextProxy;
}
 
namespace makVre
{
//! \brief Overlay section for displaying platform information
//!
//! This version is extended to handle simulation AGL messages.
class PLAYERSTATION_DLL DtVreOsgSensorViewPlatformInfoOverlaySection : public makVrv::DtOsgSensorViewPlatformInfoOverlaySection
{
public:
   //! \brief Friend declaration for creator class
   //!
   //! Allows the creator class to access protected constructor.
   friend class DtVreOsgSensorViewPlatformInfoOverlaySectionCreator;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the platform info overlay section.
   virtual ~DtVreOsgSensorViewPlatformInfoOverlaySection() override;
 
   //! \brief Updates the overlay with current platform information
   //! \param observer Reference to the observer object
   //! \param state Current sensor field of view data
   //!
   //! Updates the text display with platform information based on the current
   //! sensor and platform state. This includes date, time, altitude above ground
   //! level, and other relevant platform data.
   virtual void update(const makVrv::DtOsgObserverObject& observer,
      const makVrv::DtSensorFieldOfViewData& state) override;
 
   //! \brief Gets the name of this overlay section
   //! \return Reference to the section name string
   //!
   //! Returns the name of this section, which can be used to retrieve it
   //! from the DtOsgSensorViewOverlay. The name uniquely identifies this
   //! section type in the overlay system.
   virtual const std::string& sectionName() const override;
 
public:
   //! \brief Static section name identifier
   //!
   //! Constant string that identifies this type of overlay section.
   static const std::string SectionName;
 
protected:
   //! \brief Handles simulation state update messages
   //! \param msg Pointer to the simulation state message
   //! \return Message handling result
   //!
   //! Processes simulation state messages to extract and update the altitude
   //! above ground level (AGL) value for display in the overlay. This method
   //! parses the incoming message and updates the internal AGL value.
   virtual makVre::DtVreMessageResult handleSimulationState(makVre::DtVreMessage* msg);
 
   //! \brief Protected constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new platform info overlay section for the specified display engine.
   //! This constructor is protected because instances should only be created by
   //! the DtVreOsgSensorViewPlatformInfoOverlaySectionCreator.
   DtVreOsgSensorViewPlatformInfoOverlaySection(makVrv::DtDe& de);
 
protected:
 
   //! \brief Flag for first update handling
   //!
   //! True until the first update has been processed, used to subscribe
   //! to simulation engine AGL updates on first update.
   bool myFirstUpdate;
 
   //! \brief Flag indicating if simulation AGL is being used
   //!
   //! When true, altitude above ground level is taken from simulation state
   //! messages rather than computed from other sources.
   bool myUsingSimAgl;
 
   //! \brief Entity identifier of the host platform
   //!
   //! Identifies the platform (entity) to which this sensor is attached.
   DtEntityIdentifier myHostEntityId;
 
   //! \brief Current AGL value from simulation
   //!
   //! Stores the most recent altitude above ground level value received
   //! from simulation state messages, in the simulation's internal units.
   makVrv::DtUnicode mySimAglText;
};
 
//! \brief Factory creator for platform info overlay sections
//!
//! DtVreOsgSensorViewPlatformInfoOverlaySectionCreator is a factory class that
//! creates platform info overlay section instances. It allows the overlay sections
//! to be created on demand by the overlay system using the factory pattern.
class PLAYERSTATION_DLL DtVreOsgSensorViewPlatformInfoOverlaySectionCreator
   : public makVrv::DtOsgSensorViewOverlaySectionCreator
{
public:
   //! \brief Creates a new platform info overlay section
   //! \param de Reference to the display engine
   //! \return Pointer to a newly created overlay section
   //!
   //! Factory method that creates a new platform info overlay section
   //! instance for the specified display engine.
   virtual makVrv::DtOsgSensorViewOverlaySection* create(makVrv::DtDe& de) override;
 
   //! \brief Creates a copy of this creator
   //! \return Pointer to a new creator instance of the same type
   //!
   //! Creates a new instance of this creator class, used by the overlay system
   //! for creator registration and management.
   virtual makVrv::DtOsgSensorViewOverlaySectionCreator* clone() const override;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the creator.
   virtual ~DtVreOsgSensorViewPlatformInfoOverlaySectionCreator() override;
};
} // namespace makVre