vreOsgSensorViewDisplayInfoOverlaySection.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreOsgSensorViewDisplayInfoOverlaySection.h
//! \brief Defines the overlay section for displaying sensor view information
//!
//! This file contains the DtVreOsgSensorViewDisplayInfoOverlaySection class which
//! provides an overlay section for displaying information about the current sensor
//! view settings on the sensor display. This information appears as text in the
//! upper left corner of the view and includes details like sensor type, zoom level,
//! and other relevant parameters.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <vrvOsg/DtOsgSensorViewDisplayInfoOverlaySection.h>
 
 
namespace makVrv
{
class DtTextProxy;
}
 
namespace makVre
{
//! \brief Overlay section for displaying sensor view information
//!
//! DtVreOsgSensorViewDisplayInfoOverlaySection is responsible for displaying
//! information about the current sensor view settings on the sensor display.
//! It renders text in the upper left corner of the sensor view that shows
//! current settings like sensor type, zoom level, and other relevant
//! parameters. This helps users understand the current sensor configuration
//! at a glance.
class PLAYERSTATION_DLL DtVreOsgSensorViewDisplayInfoOverlaySection : public makVrv::DtOsgSensorViewDisplayInfoOverlaySection
{
public:
   //! \brief Friend declaration for creator class
   //!
   //! Allows the creator class to access protected constructor.
   friend class DtVreOsgSensorViewDisplayInfoOverlaySectionCreator;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the display info overlay section.
   virtual ~DtVreOsgSensorViewDisplayInfoOverlaySection() override;
 
   //! \brief Updates the overlay with current sensor information
   //! \param observer Reference to the observer object
   //! \param state Current sensor field of view data
   //!
   //! Updates the text display with information from the current sensor state.
   //! This includes sensor type, zoom level, and other relevant parameters
   //! extracted from the observer and state objects.
   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 display info overlay section for the specified display engine.
   //! This constructor is protected because instances should only be created by
   //! the DtVreOsgSensorViewDisplayInfoOverlaySectionCreator.
   DtVreOsgSensorViewDisplayInfoOverlaySection(makVrv::DtDe& de);
 
protected:
   //! \brief Current zoom level
   //!
   //! Tracks the current zoom level for the sensor view.
   int myZoomLevel;
};
 
//! \brief Factory creator for display info overlay sections
//!
//! DtVreOsgSensorViewDisplayInfoOverlaySectionCreator is a factory class that
//! creates display 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 DtVreOsgSensorViewDisplayInfoOverlaySectionCreator
   : public makVrv::DtOsgSensorViewOverlaySectionCreator
{
public:
   //! \brief Creates a new display info overlay section
   //! \param de Reference to the display engine
   //! \return Pointer to a newly created overlay section
   //!
   //! Factory method that creates a new display 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;
};
} // namespace makVre