osgSensorViewRecOverlaySection.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file osgSensorViewRecOverlaySection.h
//! \brief Defines the recording status overlay section for sensor views
//!
//! This file contains the DtOsgSensorViewRecOverlaySection class which
//! provides a sensor view overlay that displays recording status information.
//! When recording is active, a "REC" indicator is displayed in the upper
//! left corner of the sensor view.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <vrvOsg/DtOsgSensorViewOverlaySection.h>
 
namespace makVrv
{
//! \brief Forward declaration of the display engine class
class DtDe;
 
//! \brief Forward declaration of the text proxy class
class DtTextProxy;
 
//! \brief Forward declaration of the overlay renderer class
class DtOverlayRenderer;
} // namespace makVrv
 
//! \brief Overlay section that displays recording status in sensor views
//!
//! DtOsgSensorViewRecOverlaySection provides a sensor view overlay that
//! displays recording status information. When recording is active, it shows
//! a "REC" indicator in the upper left corner of the sensor view, typically
//! in red text to indicate the recording state. The overlay is designed to be
//! easily visible without obstructing important sensor information.
class PLAYERSTATION_DLL DtOsgSensorViewRecOverlaySection : public makVrv::DtOsgSensorViewOverlaySection
{
   //! \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.95;
 
   //! \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.3;
 
   //! \brief Height of the text box as a fraction of display height
   const double TextBoxHeight = 0.3;
 
public:
   //! \brief Friend declaration for creator class
   //!
   //! Only the creator class can construct instances of this section.
   friend class DtOsgSensorViewRecOverlaySectionCreator;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the recording status overlay section,
   //! particularly the text display objects.
   virtual ~DtOsgSensorViewRecOverlaySection() override;
 
   //! \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;
 
   //! \brief Updates the recording status display
   //! \param observer Observer object representing the viewer's position and orientation
   //! \param state Current state of the sensor field of view
   //!
   //! Updates the overlay text based on the current recording status. If recording
   //! is active, the "REC" indicator is displayed; otherwise, it is hidden. This method
   //! is called once per frame to keep the display synchronized with the actual recording state.
   virtual void update(const makVrv::DtOsgObserverObject& observer,
      const makVrv::DtSensorFieldOfViewData& state) override;
 
   //! \brief Gets the unique name of this overlay section
   //! \return Reference to the section name string
   //!
   //! Returns the name of this section with which it may be retrieved from
   //! the DtOsgSensorViewOverlay. Each section type has a unique name.
   virtual const std::string& sectionName() const override;
 
public:
   //! \brief Static constant defining the section name
   //!
   //! This string identifier is used to register and retrieve this overlay section.
   static const std::string SectionName;
 
protected:
   //! \brief Protected constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new recording status overlay section. This constructor is protected
   //! because instances should only be created through the creator class.
   DtOsgSensorViewRecOverlaySection(makVrv::DtDe& de)
      : DtOsgSensorViewOverlaySection(de)
      , myText(0)
   {
   }
 
protected:
   //! \brief Text element displaying the recording status
   //!
   //! Pointer to the text proxy object that renders the recording status text.
   //! This is created during initialization and made visible or hidden during
   //! each update call based on the current recording state.
   makVrv::DtTextProxy* myText;
};
 
//! \brief Factory class for creating recording status overlay sections
//!
//! DtOsgSensorViewRecOverlaySectionCreator is responsible for creating
//! instances of DtOsgSensorViewRecOverlaySection. It implements the
//! factory pattern, allowing the overlay system to create specialized sections
//! without knowing their implementation details.
class PLAYERSTATION_DLL DtOsgSensorViewRecOverlaySectionCreator : public makVrv::DtOsgSensorViewOverlaySectionCreator
{
public:
   //! \brief Creates a new recording status overlay section
   //! \param de Reference to the display engine
   //! \return Pointer to the newly created overlay section
   //!
   //! Factory method that creates a new DtOsgSensorViewRecOverlaySection
   //! instance with the specified display engine.
   virtual makVrv::DtOsgSensorViewOverlaySection* create(makVrv::DtDe& de) override
   {
      return new DtOsgSensorViewRecOverlaySection(de);
   }
 
   //! \brief Creates a clone of this creator
   //! \return Pointer to a new instance of this creator
   //!
   //! Creates and returns a new instance of this creator class. This is used
   //! by the overlay system for creator registration and management.
   virtual makVrv::DtOsgSensorViewOverlaySectionCreator* clone() const override
   {
      return new DtOsgSensorViewRecOverlaySectionCreator;
   }
};