laserDesignatorConnector.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file laserDesignatorConnector.h
//! \brief Defines the DtLaserDesignatorConnector class for handling laser designator events
//!
//! This connector monitors laser designators in the simulation, providing position
//! updates and status changes to VREngage components on request.
 
#pragma once
 
#include "export.h"
 
#include "vrePlayerStationConnector/simEventConnector.h"
 
//! \brief Forward declaration of the reflected designator class
class DtReflectedDesignator;
 
namespace makVrv
{
namespace DT_PROTOCOL_NAMESPACE
{
//! \brief Forward declaration of the reflected laser designator list class
class DtVrlinkReflectedLaserDesignatorList;
} // namespace DT_PROTOCOL_NAMESPACE
} // namespace makVrv
 
namespace makVre
{
//! \brief Forward declaration of the VREngage message class
class DtVreMessage;
 
//! \brief Connector for monitoring and reporting laser designator events
//!
//! DtLaserDesignatorConnector listens for Start/StopMonitoringDesignatorMessages
//! and provides updates on designator position and removal for monitored laser codes.
//! It tracks designators by their code and sends position updates when they change or
//! are removed from the simulation.
class VRL_DLL DtLaserDesignatorConnector : public DT_PROTOCOL_NAMESPACE::DtSimEventConnector
{
public:
   //! \brief Default constructor
   DtLaserDesignatorConnector();
 
   //! \brief Virtual destructor
   virtual ~DtLaserDesignatorConnector() override;
 
   //! \brief Installs the laser designator connector with the application and connection
   //! \param app Pointer to the player station application
   //! \param connection Pointer to the protocol-specific VR-Link connection
   //!
   //! Registers designator added/removed callbacks on the reflected list and registers handlers
   //! for Start/StopMonitoringDesignatorMessages
   virtual void install(
      DtPlayerStationApp* app, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* connection) override;
 
   //! \brief Performs periodic checks of monitored designator positions
   //!
   //! For each designator code being monitored (that exists), checks if its location
   //! has changed. If so, sends an update message with the new position.
   virtual void tick() override;
 
   //! \brief Shuts down the laser designator connector
   //!
   //! Removes all callback registrations and message handlers
   virtual void shutdown() override;
 
   //! \brief Handles the addition of a new designator
   //! \param des Pointer to the newly added designator
   //!
   //! Callback triggered when a new designator is discovered.
   //! If this code is being monitored, sends an initial update with the position.
   virtual void handleDesignatorAdded(DtReflectedDesignator* des);
 
   //! \brief Handles the removal of a designator
   //! \param des Pointer to the designator about to be removed
   //!
   //! Callback triggered when a designator is about to be destroyed.
   //! If this code is being monitored, sends a deletion notification.
   virtual void handleDesignatorRemoved(DtReflectedDesignator* des);
 
protected:
   //! \brief Handles requests to start monitoring a laser designator
   //! \param msg Pointer to the monitoring request message
   //! \return Message result indicating the message was handled
   //!
   //! Processes StartMonitoringDesignatorMessages by adding the requested code to myCodesToMonitor.
   //! If the designator already exists, sends an initial position update.
   virtual DtVreMessageResult handleStartMonitoringDesignator(DtVreMessage* msg);
 
   //! \brief Handles requests to stop monitoring a laser designator
   //! \param msg Pointer to the message requesting monitoring to stop
   //! \return Message result indicating the message was handled
   //!
   //! Processes StopMonitoringDesignatorMessages by removing the code from myCodesToMonitor.
   virtual DtVreMessageResult handleStopMonitoringDesignator(DtVreMessage* msg);
 
protected:
   //! \brief Type alias for the map of monitored designator codes
   //!
   //! Key is the designator code to monitor (integer).
   //! Value is a pair containing:
   //!   - Pointer to the reflected designator (nullptr if not yet discovered)
   //!   - Last sent position (used to detect changes)
   using CodeMonitorMap = std::map<int, std::pair<DtReflectedDesignator*, DtVector>>;
 
   //! \brief Map of laser codes being monitored
   //!
   //! Tracks which designator codes are being monitored, along with their
   //! current designator object and last reported position
   CodeMonitorMap myCodesToMonitor;
};
} // namespace makVre