laserTargetDesignatorSimLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file laserTargetDesignatorSimLogic.h
//! \brief Component providing laser target designator functionality for ground and air vehicles
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/playercomponent.h"
#include "vrePlayerStation/inputLogic.h"
 
#include "vreMessageManager/vreMessage.h"
#include "vreUtil/initializer.h"
 
namespace makVrv
{
class DtObserver;
}
 
namespace makVre
{
class DtVreMessage;
 
namespace LaserTargetDesignatorSimLogicConfig
{
//! \ingroup RoleConfigParams
//! \defgroup LaserTargetDesignatorSimLogicRoleParams Laser Target Designator Sim Logic Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for laser target designator simulation logic role.
//! @{
 
//! \vreRoleParam{disableVrHeadPose,bool,true,laserTargetDesignatorSimLogic,Whether to disable VR head pose tracking when using the laser target designator.}
constexpr const char* disableVrHeadPose = "disableVrHeadPose";
 
//! \vreRoleParamRequired{inputConfigFile,string,laserTargetDesignatorSimLogic,"configs/input/laserDesignator.lua",Input configuration file path defining laser target designator control bindings.}
constexpr const char* inputConfigFile = "inputConfigFile";
 
//! @}
} // namespace LaserTargetDesignatorSimLogicConfig
 
class DtVreMessage;
 
//! \brief Type identifier for DtLaserTargetDesignatorSimLogic component
constexpr const char* DtLaserTargetDesignatorSimLogicType = "DtLaserTargetDesignatorSimLogic";
 
//! \brief Component that provides laser target designator functionality
//!
//! DtLaserTargetDesignatorSimLogic provides the capability to turn a laser target
//! designator device on/off. A laser may be either immediately toggled on/off
//! or started and then stopped at some later time, to provide a 'press and hold'
//! interface to the device.
//!
//! Input handler details (for configuring in an SMS input configuration file):
//!   - Group: "laser-target-designator"
//!   - Handler functions: "toggle-laser", "press-and-hold-to-lase"
class VRECOMMONCOMPONENTS_DLL DtLaserTargetDesignatorSimLogic : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtLaserTargetDesignatorSimLogic
   //!
   //! Initializes component state with default values
   DtLaserTargetDesignatorSimLogic();
 
   //! \brief Virtual destructor for DtLaserTargetDesignatorSimLogic
   virtual ~DtLaserTargetDesignatorSimLogic() override;
 
   //! \brief Initializes the laser target designator component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing laser designator settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Configures input handlers, sets up message handlers, initializes sensor modes,
   //! and connects to necessary signals for pose information updates
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
   //! \brief Called every frame to update the laser designator
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Updates the laser target location if the laser is currently active
   virtual void tick(double dt) override;
   //! \brief Shuts down the laser target designator component
   //!
   //! Cleans up input handlers, message handlers, disconnects signals,
   //! and restores original sensor mode
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtLaserTargetDesignatorSimLogic
   virtual const char* type() const override;
 
   //! \brief Starts the laser target designator at the current aim point
   //!
   //! Performs a ray cast from the observer through the center of the screen,
   //! sends a StartLasingLocationMessage with the detected location, and
   //! sets the laser state to on
   virtual void startLasingLocation();
 
   //! \brief Stops the laser target designator
   //!
   //! Sends a StopLasingLocationMessage and sets the laser state to off
   virtual void stopLasingLocation();
 
   //! \brief Updates the current laser target location
   //!
   //! Performs a ray cast from the observer through the center of the screen
   //! and sends a SetLasingLocationMessage with the updated location
   virtual void updateLasingLocation();
 
   //! \brief Toggles the laser target designator on or off
   //!
   //! If the laser is currently on, calls stopLasingLocation();
   //! otherwise, calls startLasingLocation()
   virtual void toggleLasingState();
 
   //! \brief Toggles between IR and visual sensor modes
   //!
   //! Switches the observer's sensor mode between IR and visual,
   //! updating the IRSensorOn state attribute accordingly
   virtual void toggleIRSensor();
 
   //! \brief Input handler function for toggle laser action
   //! \param value Input value (1.0 to toggle the laser state)
   //!
   //! Toggles the laser on/off when the incoming value is 1
   virtual void handleToggleLaser(float value);
 
   //! \brief Input handler function for press-and-hold lasing action
   //! \param value Input value (1.0 = on, 0.0 = off)
   //!
   //! Turns the laser on if the incoming value is 1, and
   //! turns it off if the incoming value is 0
   virtual void handlePressAndHoldToLase(float value);
 
   //! \brief Checks if the laser is currently active
   //! \return True if the laser is currently on, false otherwise
   //!
   //! Returns the current state of the "laserOn" attribute
   virtual bool isLasingOn() const;
 
   //! \brief Handles menu action messages for the laser designator
   //! \param msg The menu action message to handle
   //! \return Message handling result indicating if the message was handled
   //!
   //! Processes "toggleLasingState", "toggleIRSensor", and "laserCodeInput" actions
   virtual DtVreMessageResult handleMenuMessage(makVre::DtVreMessage* msg);
 
protected:
   //! \brief Handles changes to the laserOn attribute
   //! \param on New value of the laserOn attribute
   //!
   //! Updates the laserState attribute text based on the on/off state
   void handleLaserOnChange(bool on);
 
   //! \brief Updates pose information for VR head tracking
   //!
   //! If VR is enabled and disableVrHeadPose is true, this method
   //! resets the camera position and orientation to prevent head tracking
   //! from affecting the aiming of the laser designator
   void updatePoseInformation();
 
   //! \brief Input logic that handles mapping of input actions to functions
   DtInputLogic myInputLogic;
 
   //! \brief Pointer to the observer used for ray casting and sensor mode control
   makVrv::DtObserver* myObserver;
 
   //! \brief Path to the input configuration file
   std::string myInputConfigFile;
 
   //! \brief Name of the IR sensor mode in VR-Vantage
   std::string myIRSensorMode;
 
   //! \brief Name of the visual sensor mode in VR-Vantage
   std::string myVisualSensorMode;
 
   //! \brief Original sensor mode to restore on shutdown
   std::string myCachedSensorMode;
 
   //! \brief Flag indicating if the laser has been started
   bool myLaserStarted;
 
   //! \brief Flag controlling whether VR head pose is disabled during lasing
   //!
   //! When true, VR head tracking is disabled to prevent head movement
   //! from affecting the aim point of the laser designator
   bool myDisableVrHeadPose;
};
} // namespace makVre