gunnerObserverUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file gunnerObserverUpdater.h
//! \brief Observer updater component that provides gunner-specific view controls for weapons systems
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vreCommonComponents/stateDefines.h"
#include "vreCommonComponents/observerUpdater.h"
 
#include "vreMessageManager/vreMessage.h"
 
#include "vreUtil/linearInterpolator.h"
 
#include <matrix/vlVector.h>
#include <matrix/vlQuaternion.h>
 
namespace makVrv
{
class DtEntityFacade;
class DtObserver;
class DtSceneObject;
}; // namespace makVrv
 
namespace GunnerObserverUpdaterConfig
{
//! \ingroup RoleConfigParams
//! \defgroup GunnerObserverUpdaterRoleParams Gunner Observer Updater Role Parameters
//! \roleInherits{ObserverUpdaterRoleParams}
//! Configuration Options for gunner observer updater role.
//! @{
 
//! \vreRoleParam{attachOffset,DtVector,"DtVector::zero()",gunnerObserverUpdater,Position offset from the attachment part for the observer.}
constexpr const char* attachOffset = "attachOffset";
 
//! \vreRoleParam{attachPart,int,DtPrimaryGun1,gunnerObserverUpdater,Part number of the vehicle to attach the observer to (typically the barrel).}
constexpr const char* attachPart = "attachPart";
 
//! \vreRoleParam{oriOffset,DtQuaternion,"DtQuaternion(0,0,0,1)",gunnerObserverUpdater,Orientation offset for the observer relative to the attachment part.}
constexpr const char* oriOffset = "oriOffset";
 
//! \vreRoleParam{sensorModes,table,"",gunnerObserverUpdater,Table mapping sensor mode names to VR-Vantage sensor identifiers.}
constexpr const char* sensorModes = "sensorModes";
 
//! @}
} // namespace GunnerObserverUpdaterConfig
 
namespace makVre
{
//! \brief Type identifier for DtGunnerObserverUpdater component
constexpr const char* DtGunnerObserverUpdaterType = "DtGunnerObserverUpdater";
 
//! \brief Observer updater component that handles gunner view functionality
//!
//! DtGunnerObserverUpdater attaches the observer to a weapon system and provides
//! gunner-specific controls including zoom levels, sensor modes (visual, NVG, thermal),
//! and appropriate gunner view positioning. It handles observer resets on player creation
//! and manages smooth transitions between zoom levels.
class VRECOMMONCOMPONENTS_DLL DtGunnerObserverUpdater : public DtObserverUpdater
{
public:
   //! \brief Constructor for DtGunnerObserverUpdater
   //!
   //! Initializes observer state variables including attachment status and sensor modes
   DtGunnerObserverUpdater();
 
   //! \brief Destructor for DtGunnerObserverUpdater
   virtual ~DtGunnerObserverUpdater() override;
 
   //! \brief Initializes the gunner observer updater component
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing gunner observer settings
   //! \return True if initialization succeeded, false otherwise
   //!
   //! Sets up observer attachments, configures sensor modes, and registers message handlers
   //! for player creation and reset events
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
   //! \brief Called every frame to update the gunner observer
   //! \param dt Delta time since the last frame in seconds
   //!
   //! Updates zoom interpolation, observer attachment properties, sensor modes,
   //! and handles special cases when the vehicle is destroyed
   virtual void tick(double dt) override;
   //! \brief Shuts down the gunner observer updater component
   //!
   //! Removes message handlers, detaches the observer, and resets sensor modes
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtGunnerObserverUpdater
   virtual const char* type() const override;
 
protected:
   //! \brief Handles player creation messages
   //! \param msg The player created message
   //! \return Message handling result indicating message was handled
   //!
   //! Resets the observer when a new player is created
   virtual makVre::DtVreMessageResult handlePlayerCreated(makVre::DtVreMessage* msg);
 
   //! \brief Handles player reset messages
   //! \param msg The reset message
   //! \return Message handling result indicating message was handled
   //!
   //! Resets the observer when the player is reset
   virtual makVre::DtVreMessageResult handlePlayerReset(makVre::DtVreMessage* msg);
 
   //! \brief Resets the observer to the proper attachment point and orientation
   //!
   //! Configures the observer to attach to the correct part of the entity with
   //! the appropriate offset and rotation settings
   void resetObserver();
 
   //! \brief Updates the observer's sensor mode based on player state
   //!
   //! Changes sensor modes (visual, NVG, thermal) when the player's currentSensor attribute changes
   void updateSensor();
 
   //! \brief Updates observer behavior when the vehicle is destroyed
   //!
   //! Changes observer attachment type and resets when destruction state changes
   void updateDestroyed();
 
   //! \brief Flag indicating if the observer is attached to a scene object
   bool myAttached;
 
   //! \brief Pointer to the observer object being controlled
   makVrv::DtObserver* myObserver;
 
   //! \brief Interpolator for smooth zoom level transitions
   makVre::DtLinearInterpolator<double>* myZoomInterpolator;
 
   //! \brief ID of the part to attach the observer to (e.g., gun barrel)
   int myAttachPart;
 
   //! \brief Position offset from the attachment point
   DtVector myAttachedOffset;
 
   //! \brief Orientation offset from the attachment point
   DtQuaternion myOriOffest;
 
   //! \brief Currently active sensor view mode
   SensorViews myLastSensorViewMode;
 
   //! \brief Map of SensorViews enums to VR-Engage sensor mode names
   //!
   //! This map is initialized with data from the player configuration and maps
   //! the SensorViews enumeration values to their corresponding string names used
   //! in VR-Vantage
   std::map<enum SensorViews, std::string> mySensorModes;
};
} // namespace makVre