vreOsgSensorViewPitchOverlaySection.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreOsgSensorViewPitchOverlaySection.h
//! \brief Defines the overlay section for displaying pitch information
//!
//! This file contains the DtVreOsgSensorViewPitchOverlaySection class which
//! provides an overlay section for displaying pitch angle information on the
//! sensor view. This helps users understand the current viewing angle and
//! orientation of the sensor relative to the horizon.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <vrvOsg/DtOsgSensorViewPitchOverlaySection.h>
 
 
namespace makVrv
{
class DtTextProxy;
}
 
namespace makVre
{
//! \brief Overlay section for displaying pitch angle information
//!
//! DtVreOsgSensorViewPitchOverlaySection is responsible for displaying
//! the current pitch angle of the sensor view. It renders this information
//! as text on the sensor display, helping users understand the current
//! viewing angle relative to the horizon. This is particularly useful
//! in applications like aerial observation or targeting systems.
class PLAYERSTATION_DLL DtVreOsgSensorViewPitchOverlaySection : public makVrv::DtOsgSensorViewPitchOverlaySection
{
public:
   //! \brief Friend declaration for creator class
   //!
   //! Allows the creator class to access protected constructor.
   friend class DtVreOsgSensorViewPitchOverlaySectionCreator;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the pitch overlay section.
   virtual ~DtVreOsgSensorViewPitchOverlaySection() override;
 
   //! \brief Initializes the overlay section
   //! \param overlayRenderer Reference to the overlay renderer
   //! \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
   //!
   //! Sets up the overlay section with the specified renderer and dimensions.
   //! This must be called before update() is called.
   virtual void initialize(makVrv::DtOverlayRenderer& overlayRenderer, unsigned int channelWidth,
      unsigned int channelHeight, unsigned int channelXOffset, unsigned int channelYOffset) override;
 
   //! \brief Updates the channel size
   //! \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
   //!
   //! Updates the overlay section for a new channel size or position.
   //! This is typically called when the view is resized or repositioned.
   virtual void setChannelSize(unsigned int channelWidth, unsigned int channelHeight, unsigned int channelXOffset,
      unsigned int channelYOffset) override;
 
   //! \brief Updates the overlay with current pitch information
   //! \param observer Reference to the observer object
   //! \param state Current sensor field of view data
   //!
   //! Updates the text display with pitch angle information from the
   //! current sensor state. This calculates the current pitch angle
   //! using getPitchDegrees() and formats it for display.
   virtual void update(const makVrv::DtOsgObserverObject& observer,
      const makVrv::DtSensorFieldOfViewData& state) override;
 
protected:
   //! \brief Calculates the pitch angle in degrees
   //! \param observer Reference to the observer object
   //! \param state Current sensor field of view data
   //! \return Current pitch angle in degrees
   //!
   //! Computes the current pitch angle in degrees based on the observer
   //! orientation and sensor field of view state. This is used to determine
   //! the angle value to display in the overlay.
   virtual double getPitchDegrees(
      const makVrv::DtOsgObserverObject& observer, const makVrv::DtSensorFieldOfViewData& state);
 
   //! \brief Protected constructor
   //! \param de Reference to the display engine
   //!
   //! Creates a new pitch overlay section for the specified display engine.
   //! This constructor is protected because instances should only be created by
   //! the DtVreOsgSensorViewPitchOverlaySectionCreator.
   DtVreOsgSensorViewPitchOverlaySection(makVrv::DtDe& de);
 
   //! \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:
   static const std::string SectionName;
 
protected:
   //! \brief Text display object for the pitch angle
   //!
   //! Proxy for the text object that displays the pitch angle information.
   makVrv::DtTextProxy* myDegreeText;
};
 
//! \brief Factory creator for pitch overlay sections
//!
//! DtVreOsgSensorViewPitchOverlaySectionCreator is a factory class that
//! creates pitch overlay section instances. It allows the overlay sections
//! to be created on demand by the overlay system using the factory pattern.
class PLAYERSTATION_DLL DtVreOsgSensorViewPitchOverlaySectionCreator
   : public makVrv::DtOsgSensorViewPitchOverlaySectionCreator
{
public:
   //! \brief Creates a new pitch overlay section
   //! \param de Reference to the display engine
   //! \return Pointer to a newly created overlay section
   //!
   //! Factory method that creates a new pitch overlay section
   //! instance for the specified display engine.
   virtual makVrv::DtOsgSensorViewPitchOverlaySection* 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::DtOsgSensorViewPitchOverlaySectionCreator* clone() const override;
};
} // namespace makVre