vreBinocularsLasingOverlay.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreBinocularsLasingOverlay.h
//! \brief Component for binoculars with laser ranging functionality
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vrePlayerStation/playerComponent.h"
 
#include "vreCommonComponents/export.h"
#include "vreCommonComponents/vreBinocularsOverlay.h"
 
#include <vreMessageManager/vreMessage.h>
 
#include <makArchives/DtDisplayUnitsSettingsRecord.h>
 
// #include <vrvUtil/DtUnicode.h>
 
namespace makVrv
{
class DtIntersector;
}
 
namespace makVre
{
//! \brief Type identifier for DtBinocularsLasingOverlay component
constexpr const char* DtBinocularsLasingOverlayType = "DtBinocularsLasingOverlay";
 
//! \brief Component that extends binoculars with laser target designation and ranging functionality
//!
//! DtBinocularsLasingOverlay extends the basic binoculars overlay with laser ranging capabilities,
//! providing measurement and display of target location, elevation, azimuth, and range information.
//! It updates formatted display values for sensor location, target data, and north reference
//! settings. The overlay maintains target data for a configurable period after lasing stops.
class VRECOMMONCOMPONENTS_DLL DtBinocularsLasingOverlay : public DtBinocularsOverlay
{
public:
   //! \brief Constructor for DtBinocularsLasingOverlay
   //!
   //! Initializes the component with default settings
   DtBinocularsLasingOverlay();
 
   //! \brief Virtual destructor for DtBinocularsLasingOverlay
   //!
   //! Cleans up resources including the intersector object
   virtual ~DtBinocularsLasingOverlay() override;
 
   //! \brief Initializes the binoculars lasing overlay component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing overlay settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Sets up the intersector, initializes attribute state values, and registers message handlers
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
   //! \brief Shuts down the binoculars lasing overlay component
   //!
   //! Removes message handlers and performs base class shutdown
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtBinocularsLasingOverlay
   virtual const char* type() const override;
 
   //! \brief Performs post-initialization after all components are initialized
   //! \return True if post-initialization succeeded, false otherwise
   //!
   //! Configures VR-specific settings if necessary
   virtual bool postInitialize() override;
   //! \brief Called every frame to update the overlay state
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Updates current time, sensor data, north reference, target data,
   //! and handles target data expiration if necessary
   virtual void tick(double dt) override;
 
   //! \brief Determines if the overlay should be visible
   //! \return True if the overlay should be visible, false otherwise
   //!
   //! Checks menu state, base overlay visibility, and laser availability
   //! to determine if the overlay should be displayed
   virtual bool isOverlayVisible() override;
 
protected:
   //! \brief Handles stop lasing messages
   //! \param msg Stop lasing message
   //! \return Message handling result indicating if the message was handled
   //!
   //! Sets target data to expire 30 seconds after lasing stops
   virtual makVre::DtVreMessageResult handleStopLasingMessage(makVre::DtVreMessage* msg);
 
   //! \brief Updates sensor location and elevation attributes
   //!
   //! Updates the following attributes:
   //! - lasing.sensorLocation.formatted: MGRS ten-digit grid (e.g. "11S GN 01234 56789")
   //! - lasing.sensorElevation.formatted: Elevation in meters MSL (e.g. "EL 01234 m MSL")
   virtual void updateSensorData();
 
   //! \brief Updates the north reference attribute
   //!
   //! Updates lasing.northReference.formatted attribute with current north
   //! reference setting ("MAG", "TRUE", or "GRID")
   virtual void updateNorthReference();
 
   //! \brief Updates the time of target location attribute
   //!
   //! Updates lasing.timeOfTargetLocation.formatted attribute with current time in HH:MM:SS format
   virtual void updateTimeOfTargetLocation();
 
   //! \brief Updates all target-related attributes based on current lasing state
   //!
   //! Updates the following attributes when lasing is active:
   //! - lasing.targetLocation.formatted: MGRS ten-digit grid (e.g. "11S GN 01234 56789")
   //! - lasing.targetElevationMSL.formatted: Elevation in meters MSL (e.g. "EL 01234 m MSL")
   //! - lasing.targetRange.formatted: Range in meters (e.g. "RNG 01234 m")
   //! - lasing.targetElevation.formatted: Elevation in NATO MILS (e.g. "ELA 0123 MIL")
   //! - lasing.targetAzimuth.formatted: Azimuth in NATO MILS (e.g. "AZ 0123 MIL")
   //! - lasing.elrfStatus.formatted: "ELRF IDLE" or "GET TGT LOCATION" based on lasing state
   virtual void updateTargetData();
 
   //! \brief Generates a formatted time string for the current time
   //! \return String containing the current time in HH:MM:SS format
   virtual std::string timeString();
 
   //! \brief Sets all target data attributes to null or default values
   //!
   //! Resets all target-related attributes to their default state when
   //! target data expires or becomes invalid
   virtual void clearTargetData();
 
   //! \brief Calculates elevation and azimuth from observer to target
   //! \param geocentricObserverLocation Observer position in geocentric coordinates
   //! \param geocentricIntersectionPoint Target position in geocentric coordinates
   //! \param targetElevation Pointer to store calculated elevation angle in radians
   //! \param targetAzimuth Pointer to store calculated azimuth angle in radians
   //!
   //! Transforms positions to topocentric coordinates and calculates
   //! elevation and azimuth angles, considering the current north reference setting
   virtual void calculateElevationAndAzimuthToTarget(const DtVector& geocentricObserverLocation,
      const DtVector& geocentricIntersectionPoint, double* targetElevation, double* targetAzimuth);
 
protected:
   //! \brief Current simulation time in seconds
   double myCurrentTime;
 
   //! \brief Time when observer-to-target distance was last calculated
   double myTimeLastObserverToTargetDistanceCalculated;
 
   //! \brief Time when target data will expire
   double myTargetDataExpirationTime;
 
   //! \brief Intersector for performing raycasting to determine target position
   makVrv::DtIntersector* myIntersector;
 
   //! \brief Last known north units setting for detecting changes
   makArchives::DtDisplayUnitsSettingsRecord::NorthUnits myLastNorthUnits;
 
   //! \brief Last known local ownship position for detecting changes
   DtVector myLastLocalOwnshipPosition;
 
   //! \brief Last known geocentric position of laser intersection point
   DtVector myLastGeocentricIntersectionPoint;
 
   DtAttributeHandle myLasingHandle;
};
} // namespace makVre