vreOsgSensorViewTargetInfoOverlaySection.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreOsgSensorViewTargetInfoOverlaySection.h
//! \brief Defines the overlay section for displaying target information
//!
//! This file contains the DtVreOsgSensorViewTargetInfoOverlaySection class which
//! provides an overlay section for displaying information about the target at the
//! center of the sensor view. This includes target location coordinates in either
//! latitude/longitude or MGRS format.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <vrvOsg/DtOsgSensorViewTargetInfoOverlaySection.h>
 
 
namespace makVrv
{
//! \brief Forward declaration of the text proxy class
class DtTextProxy;
 
//! \brief Forward declaration of the ray intersector class
class DtIntersector;
} // namespace makVrv
 
namespace makVre
{
//! \brief Overlay section for displaying target information
//!
//! DtVreOsgSensorViewTargetInfoOverlaySection is responsible for displaying
//! information about the target at the center of the sensor view. It performs
//! ray intersection with the terrain or 3D model to determine the exact location
//! of the target point, and displays the coordinates in either latitude/longitude
//! or Military Grid Reference System (MGRS) format.
class PLAYERSTATION_DLL DtVreOsgSensorViewTargetInfoOverlaySection : public makVrv::DtOsgSensorViewTargetInfoOverlaySection
{
   //! \brief Horizontal position of the text as a fraction of display width (0.0-1.0)
   //!
   //! Value of 0.02 positions the text near the left edge of the display
   const double TextHorizLocation = 0.02;
 
   //! \brief Vertical position of the text as a fraction of display height (0.0-1.0)
   //!
   //! Value of 0.95 positions the text near the top edge of the display
   const double TextVertLocation = 0.05;
 
   //! \brief Default font size for the recording status text in points
   const double DefaultFontSize = 12;
 
   //! \brief Width of the text box as a fraction of display width
   const double TextBoxWidth = 0.2;
 
   //! \brief Height of the text box as a fraction of display height
   const double TextBoxHeight = 0.2;
public:
   //! \brief Friend declarations for creator classes
   //!
   //! Allow the creator classes to access protected constructor.
   friend class DtVreOsgSensorViewTargetInfoOverlaySectionCreator;
   friend class DtVreOsgSensorViewMgrsTargetInfoOverlaySectionCreator;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the target info overlay section.
   virtual ~DtVreOsgSensorViewTargetInfoOverlaySection() override;
 
   //! \brief Updates the overlay with current target information
   //! \param observer Reference to the observer object
   //! \param state Current sensor field of view data
   //!
   //! Updates the text display with target information based on the current
   //! observer view. This performs a ray intersection with the terrain or 3D model
   //! at the center of the view to determine the exact target location, and then
   //! formats the coordinates for display.
   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 Protected constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new target info overlay section for the specified display engine.
   //! This constructor is protected because instances should only be created by
   //! the creator classes.
   DtVreOsgSensorViewTargetInfoOverlaySection(makVrv::DtDe& de);
 
   //! \brief Initializes the overlay section
   //! \param overlayRenderer Renderer for creating overlay elements
   //! \param channelWidth Width of the channel in pixels
   //! \param channelHeight Height of the channel in pixels
   //! \param channelXOffset X offset of the channel in pixels
   //! \param channelYOffset Y offset of the channel in pixels
   //!
   //! Initializes the overlay section by creating the text element that displays
   //! the recording status. This must be called prior to any update calls. The
   //! position of the text is calculated based on the channel dimensions and offsets.
   virtual void initialize(makVrv::DtOverlayRenderer& overlayRenderer, unsigned int channelWidth,
    unsigned int channelHeight, unsigned int channelXOffset, unsigned int channelYOffset) override;
 
   //! \brief Updates the overlay when the channel size changes
   //! \param channelWidth New width of the channel in pixels
   //! \param channelHeight New height of the channel in pixels
   //! \param channelXOffset New X offset of the channel in pixels
   //! \param channelYOffset New Y offset of the channel in pixels
   //!
   //! Adjusts the position and size of the text element when the channel
   //! dimensions or position change. This ensures the recording status display
   //! maintains its relative position in the view.
   virtual void setChannelSize(unsigned int channelWidth, unsigned int channelHeight, unsigned int channelXOffset,
      unsigned int channelYOffset) override;
 
protected:
   //! \brief Enumeration for coordinate system display formats
   //!
   //! Defines the coordinate system formats that can be used for displaying
   //! the target location.
   enum CoordSysType
   {
      LatLon = 0, //!< Latitude/Longitude coordinate system
      MGRS = 1    //!< Military Grid Reference System coordinate format
   };
 
   //! \brief Current coordinate system format
   //!
   //! Determines whether coordinates are displayed in Lat/Lon or MGRS format.
   CoordSysType myCoordSysType;
 
   int myFontSize = 0;
};
 
//! \brief Factory creator for target info overlay sections with Lat/Lon format
//!
//! DtVreOsgSensorViewTargetInfoOverlaySectionCreator is a factory class that
//! creates target info overlay section instances with coordinates displayed
//! in Latitude/Longitude format. It allows the overlay sections to be created
//! on demand by the overlay system using the factory pattern.
class PLAYERSTATION_DLL DtVreOsgSensorViewTargetInfoOverlaySectionCreator
   : public makVrv::DtOsgSensorViewOverlaySectionCreator
{
public:
   //! \brief Creates a new target info overlay section
   //! \param de Reference to the display engine
   //! \return Pointer to a newly created overlay section
   //!
   //! Factory method that creates a new target info overlay section instance
   //! for the specified display engine, configured to display coordinates
   //! in Latitude/Longitude format.
   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 DtOsgSensorViewOverlaySectionCreator* clone() const override;
};
 
//! \brief Factory creator for target info overlay sections with MGRS format
//!
//! DtVreOsgSensorViewMgrsTargetInfoOverlaySectionCreator is a factory class that
//! creates target info overlay section instances with coordinates displayed
//! in Military Grid Reference System (MGRS) format. It allows the overlay sections
//! to be created on demand by the overlay system using the factory pattern.
class PLAYERSTATION_DLL DtVreOsgSensorViewMgrsTargetInfoOverlaySectionCreator
   : public makVrv::DtOsgSensorViewOverlaySectionCreator
{
public:
   //! \brief Creates a new target info overlay section with MGRS coordinates
   //! \param de Reference to the display engine
   //! \return Pointer to a newly created overlay section
   //!
   //! Factory method that creates a new target info overlay section instance
   //! for the specified display engine, configured to display coordinates
   //! in Military Grid Reference System (MGRS) format.
   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 DtOsgSensorViewOverlaySectionCreator* clone() const override;
};
} // namespace makVre