commanderObserverUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file commanderObserverUpdater.h
//! \brief Defines the DtCommanderObserverUpdater component for managing commander view and sensor modes.
//!
//! This component manages the observer for a vehicle commander, handling attachment to
//! specific vehicle parts, orientation, zoom, and sensor mode switching.
//!
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "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 DtDe;
class DtEntityFacade;
class DtObserver;
class DtSceneObject;
}; // namespace makVrv
 
namespace CommanderObserverUpdaterConfig
{
//! \ingroup RoleConfigParams
//! \defgroup CommanderObserverUpdaterRoleParams Commander Observer Updater Role Parameters
//! \roleInherits{ObserverUpdaterRoleParams}
//! Configuration Options for commander observer updater role.
//! @{
 
//! \vreRoleParam{attachOffset,DtVector,"DtVector::zero()",commanderObserverUpdater,Position offset from the attachment part for the observer.}
constexpr const char* attachOffset = "attachOffset";
 
//! \vreRoleParam{attachPart,int,5376,commanderObserverUpdater,Part number of the vehicle to attach the observer to.}
constexpr const char* attachPart = "attachPart";
 
//! \vreRoleParam{oriOffset,DtQuaternion,"DtQuaternion(0,0,0,1)",commanderObserverUpdater,Orientation offset for the observer relative to the attachment part.}
constexpr const char* oriOffset = "oriOffset";
 
//! \vreRoleParam{sensorModes,table,"",commanderObserverUpdater,Table mapping sensor mode names to VR-Vantage sensor identifiers.}
constexpr const char* sensorModes = "sensorModes";
 
//! @}
} // namespace CommanderObserverUpdaterConfig
 
namespace makVre
{
 
//! \brief Type identifier for DtCommanderObserverUpdater component
constexpr const char* DtCommanderObserverUpdaterType = "DtCommanderObserverUpdater";
 
//! \brief Component for managing commander observer and sensor systems
//!
//! The DtCommanderObserverUpdater manages the visual aspects of a vehicle commander's
//! view. It handles attachment to specific vehicle parts, orientation control,
//! sensor mode switching, and updates the observer state based on vehicle damage state.
//!
//! This component supports multiple sensor modes (Visual, NVG, Thermal White/Black)
//! that can be configured in the role file.
class VRECOMMONCOMPONENTS_DLL DtCommanderObserverUpdater : public DtObserverUpdater
{
public:
   //! \brief Constructor for DtCommanderObserverUpdater
   //!
   //! Initializes the component with default values including no attachment,
   //! Visual sensor mode, and empty sensor mode map.
   DtCommanderObserverUpdater();
 
   //! \brief Virtual destructor for DtCommanderObserverUpdater
   virtual ~DtCommanderObserverUpdater() override;
 
   //! \brief Initializes the component with configuration from Lua
   //!
   //! Reads configuration values including attachment part, position/orientation offsets,
   //! and available sensor modes. Sets up the observer and message handlers for
   //! PlayerCreatedMessage and ResetMessage.
   //!
   //! Also populates the mySensorModes map with configured sensor types and their
   //! corresponding VR-Vantage sensor names.
   //!
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing initialization parameters
   //! \return True if initialization succeeds, false otherwise
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
 
   //! \brief Updates the observer's position, orientation, and sensor mode
   //!
   //! Called each frame to update the observer position based on entity position,
   //! read observer orientation from state attributes, update sensor mode based on
   //! the "currentSensor" state attribute, and handle the entity destruction state.
   //!
   //! \param dt Delta time in seconds since the last tick
   virtual void tick(double dt) override;
 
   //! \brief Shuts down the component
   //!
   //! Removes message handlers and resets the observer to default settings.
   //! Also switches the observer back to the Visual sensor mode.
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Handles player created messages
   //!
   //! Called when a player is created in the simulation. Calls resetObserver()
   //! to re-attach the observer to the entity.
   //!
   //! \param msg The player created message
   //! \return HANDLED to indicate the message was processed
   virtual makVre::DtVreMessageResult handlePlayerCreated(makVre::DtVreMessage* msg);
 
   //! \brief Handles reset messages
   //!
   //! Called when a reset message is received. Calls resetObserver()
   //! to re-attach the observer to the entity.
   //!
   //! \param msg The reset message
   //! \return HANDLED to indicate the message was processed
   virtual makVre::DtVreMessageResult handlePlayerReset(makVre::DtVreMessage* msg);
 
   //! \brief Resets and re-attaches the observer to the entity
   //!
   //! Configures the observer to use AttachTypeMimic, attaches it to the player's element,
   //! and sets the part attachment and offset values.
   void resetObserver();
 
   //! \brief Updates the observer's sensor mode
   //!
   //! Checks the "currentSensor" state attribute and updates the observer's sensor mode
   //! if it has changed. Also updates the "currentSensorName" state attribute.
   //! Uses the VR-Engage sensor mode mapper to convert role-specific sensor names
   //! to VR-Vantage sensor names.
   void updateSensor();
 
   //! \brief Handles entity destruction state changes
   //!
   //! Monitors the "ownship.damageState" attribute. When the entity is destroyed,
   //! switches to Visual mode, resets zoom, and changes the attachment type.
   //! When the entity is restored, calls resetObserver() to restore normal operation.
   void updateDestroyed();
 
   //! \brief Flag indicating if the observer is attached to an entity
   bool myAttached;
 
   //! \brief Cached pointer to the observer being controlled
   makVrv::DtObserver* myObserver;
 
   //! \brief Interpolator for smooth zoom transitions
   //!
   //! Created as needed when zoom level changes and deleted when transition completes
   DtLinearInterpolator<double>* myZoomInterpolator;
 
   //! \brief DIS part enumeration value for the vehicle part to attach the observer to
   //!
   //! Defaults to 5376 (primary radar system 1, representing commander sensor)
   int myAttachPart;
 
   //! \brief Position offset from the attachment part
   //!
   //! Vector offset in meters from the attachment point
   DtVector myAttachedOffset;
 
   //! \brief Orientation offset from the attachment part
   //!
   //! Quaternion representing orientation offset from the attachment point
   DtQuaternion myOriOffest;
 
   //! \brief Last known sensor view mode
   //!
   //! Used to detect changes in sensor mode to avoid unnecessary updates
   SensorViews myLastSensorViewMode;
 
   //! \brief Map of SensorViews enums to VR-Engage sensor mode names
   //!
   //! This map links the enumerated sensor types (VISUAL, NVG, etc.) to their
   //! corresponding VR-Engage sensor mode names configured in the role file.
   std::map<enum SensorViews, std::string> mySensorModes;
};
} // namespace makVre