osgSensorViewDisplayLaserOverlaySection.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file osgSensorViewDisplayLaserOverlaySection.h
//! \brief Defines the laser display overlay section for sensor views
//!
//! This file contains the DtOsgSensorViewDisplayLaserOverlaySection class which
//! provides a sensor view overlay that displays information about the current
//! laser designator settings, including laser code, tracking code, and laser status.
//! \ingroup vrvOsg
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include "vreUtil/attribute.h"
 
#include <vrvOsg/DtOsgSensorViewOverlaySection.h>
 
 
namespace makVrv
{
//! \brief Forward declaration of the text proxy class
class DtTextProxy;
} // namespace makVrv
 
namespace makVre
{
//! \brief Overlay section that displays laser designator information in sensor views
//!
//! DtOsgSensorViewDisplayLaserOverlaySection provides a sensor view overlay that
//! displays information about the current laser designator settings, including the
//! active laser code, tracking code, and laser on/off status. The information is
//! displayed as text in the lower left corner of the sensor view, with visual
//! indicators for the laser status (blinking when active).
class PLAYERSTATION_DLL DtOsgSensorViewDisplayLaserOverlaySection : public makVrv::DtOsgSensorViewOverlaySection
{
public:
   //! \brief Friend declaration for creator class
   //!
   //! Only the creator class can construct instances of this section.
   friend class DtOsgSensorViewDisplayLaserOverlaySectionCreator;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the laser display overlay section,
   //! particularly the text display objects and state callbacks.
   virtual ~DtOsgSensorViewDisplayLaserOverlaySection() 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 laser information and setting up state attribute callbacks. 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 laser information 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 laser information 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 with the current laser settings during each frame update.
   //! Handles the blinking of the laser indicator when the laser is active.
   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 laser display overlay section. This constructor is protected
   //! because instances should only be created through the creator class.
   DtOsgSensorViewDisplayLaserOverlaySection(makVrv::DtDe& de);
 
   //! \brief Handles changes to the laser code setting
   //! \param code New laser code value
   //!
   //! Callback triggered when the "laserCode" state attribute changes.
   //! Updates the stored laser code and refreshes the display text.
   virtual void handleLaserCodeChanged(int code);
 
   //! \brief Handles changes to the tracking code setting
   //! \param code New tracking code value
   //!
   //! Callback triggered when the "trackingCode" state attribute changes.
   //! Updates the stored tracking code and refreshes the display text.
   virtual void handleTrackCodeChanged(int code);
 
   //! \brief Handles changes to the laser on/off state
   //! \param laserOn New laser state (true = on, false = off)
   //!
   //! Callback triggered when the "LaserOn" state attribute changes.
   //! Updates the stored laser state and refreshes the display text.
   //! When the laser is on, the display will blink to indicate active status.
   virtual void handleLaserOnChanged(bool laserOn);
 
private:
   //! \brief Updates the displayed text based on current laser settings
   //!
   //! Updates the text content to reflect the current laser code, tracking code,
   //! and laser status. Formats the text with appropriate indicators and manages
   //! the blinking effect when the laser is active.
   void updateText();
 
protected:
   //! \brief Text element displaying the laser information
   //!
   //! Pointer to the text proxy object that renders the laser information text.
   //! This is created during initialization and updated during each update call.
   makVrv::DtTextProxy* myText;
 
   //! \brief Currently selected laser code
   //!
   //! The code number currently set for the laser designator.
   int myLaserCode;
 
   //! \brief Currently selected tracking code
   //!
   //! The code number currently being tracked by the laser designator.
   int myTargetCode;
 
   //! \brief Flag indicating whether the laser is currently on
   //!
   //! True when the laser is active, false when inactive.
   bool myLaserOn;
 
   //! \brief Timestamp of the last display update
   //!
   //! Used to control the blink rate of the laser indicator.
   double myLastTime;
 
   //! \brief Current visibility state for blinking text
   //!
   //! Toggles between true and false to create the blinking effect
   //! when the laser is active.
   bool myShow;
 
   //! \brief Member-scope instance of Attribute callback manager
   //!
   //! Used to manage Attribute change callback connections and ensure that all
   //! callbacks are unregistered when this class instance is destroyed.
   DtAttributeCallbackManager myAttributeCallbacks;
};
 
//! \brief Factory class for creating laser display overlay sections
//!
//! DtOsgSensorViewDisplayLaserOverlaySectionCreator is responsible for creating
//! instances of DtOsgSensorViewDisplayLaserOverlaySection. It implements the
//! factory pattern, allowing the overlay system to create specialized sections
//! without knowing their implementation details.
//! \ingroup vrvOsg
class PLAYERSTATION_DLL DtOsgSensorViewDisplayLaserOverlaySectionCreator
   : public makVrv::DtOsgSensorViewOverlaySectionCreator
{
public:
   //! \brief Creates a new laser display overlay section
   //! \param de Reference to the display engine
   //! \return Pointer to the newly created overlay section
   //!
   //! Factory method that creates a new DtOsgSensorViewDisplayLaserOverlaySection
   //! instance with the specified display engine.
   virtual makVrv::DtOsgSensorViewOverlaySection* create(makVrv::DtDe& de) override;
 
   //! \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;
};
 
} // namespace makVre