pilotObserverUpdater.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file pilotObserverUpdater.h
//! \brief Defines DtPilotObserverUpdater for managing pilot-specific camera views
//! \ingroup vrePilotFrontend
 
#pragma once
 
#include <vreCommonComponents/observerUpdater.h>
 
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtObserverObject.h>
#include <vrvUtil/DtDisplayConfiguration.h>
 
#include <matrix/vlVector.h>
#include <matrix/vlTaitBryan.h>
 
#include <vrePilotFrontend/export.h>
 
namespace makVre
{
 
namespace PilotObserverUpdaterConfig
{
//! \ingroup RoleConfigParams
//! \defgroup PilotObserverUpdaterRoleParams Pilot Observer Updater Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for pilot observer updater component.
//! @{
 
//! \vreRoleParam{attachOffset,DtVector,DtVector::zero(),pilotObserverUpdater,Position offset from the attachment point for the pilot observer camera.}
constexpr const char* attachOffset = "attachOffset";
 
//! \vreRoleParam{attachType,int,DtObserverObject::AttachTypeMimic,pilotObserverUpdater,Type of attachment behavior for the observer to the aircraft entity.}
constexpr const char* attachType = "attachType";
 
//! \vreRoleParam{oriOffset,DtVector,DtVector::zero(),pilotObserverUpdater,Orientation offset angles (pitch\, yaw\, roll) for the observer relative to attachment.}
constexpr const char* oriOffset = "oriOffset";
 
//! \vreRoleParam{rotateEntitySymbols,bool,true,pilotObserverUpdater,Whether to rotate entity symbols on displays based on aircraft orientation.}
constexpr const char* rotateEntitySymbols = "rotateEntitySymbols";
 
//! \vreRoleParam{smoothingPeriod,float,0.8,pilotObserverUpdater,Smoothing period in seconds for observer movement transitions.}
constexpr const char* smoothingPeriod = "smoothingPeriod";
 
//! @}
} // namespace PilotObserverUpdaterConfig
 
//! \brief Forward declaration of the interpolator class
class DtInterpolator;
 
//! \brief Forward declaration of the window operation message class
class WindowOperationMessage;
 
//! \brief Forward declaration of the entity resolver class
class DtEntityResolver;
 
//! \brief Forward declaration of the instrument panel manager class
class DtInstrumentPanelManager;
} // namespace makVre
 
namespace makVrv
{
//! \brief Forward declaration of the display element class
class DtDe;
 
//! \brief Forward declaration of the entity facade class
class DtEntityFacade;
 
//! \brief Forward declaration of the observer class
class DtObserver;
 
//! \brief Forward declaration of the scene object class
class DtSceneObject;
 
//! \brief Forward declaration of the window class
class DtWindow;
 
//! \brief Forward declaration of the input driver class
class DtInputDriver;
}; // namespace makVrv
 
//! \brief Type identifier for DtPilotObserverUpdater component
constexpr const char* DtPilotObserverUpdaterType = "DtPilotObserverUpdater";
 
//! \brief Observer updater component for the pilot role
//!
//! DtPilotObserverUpdater manages the observer (camera) behavior for the pilot role,
//! including handling different view modes, cockpit views, and external aircraft views.
//! It handles positioning, orientation, and updates of the observer based on the
//! aircraft state and pilot inputs.
class PILOT_DLL DtPilotObserverUpdater : public makVre::DtObserverUpdater
{
   //! \brief Structure containing instrument panel configuration
   struct InstrumentPanel
   {
      std::string modelDef; //!< Model definition for the instrument panel
      DtVector position;    //!< Position of the instrument panel
      DtVector panelSize;   //!< Size of the instrument panel
      bool isFullScreen;    //!< Flag indicating whether the panel is full screen
   };
 
public:
   //! \brief Default constructor
   DtPilotObserverUpdater();
 
   //! \brief Virtual destructor
   virtual ~DtPilotObserverUpdater() override;
 
   //! \brief Initializes the observer updater component
   //! \param player Pointer to the player station
   //! \param config Configuration settings for initialization
   //! \return True if initialization was successful, false otherwise
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates the observer for the current frame
   //! \param dt Delta time since the last frame in seconds
   virtual void tick(double dt) override;
 
   //! \brief Cleans up resources when the component is being shut down
   virtual void shutdown() override;
 
   //! \brief Returns the component type identifier
   //! \return The component type string
   virtual const char* type() const override;
 
protected:
   //! \brief Marking text for the ownship aircraft
   std::string myOwnshipMarkingText;
 
   //! \brief Pointer to the main window observer
   makVrv::DtObserver* myMainWindowObserver;
 
   //! \brief Unique ID of the player element
   makVrv::DtUniqueID myPlayerElementID;
 
   //! \brief Type of attachment for the observer
   makVrv::DtObserverObject::AttachType myAttachType;
 
   //! \brief Offset position for attached observer
   DtVector myAttachedOffset;
 
   //! \brief Orientation offset for the observer
   DtTaitBryan myOriOffset;
 
   //! \brief Current smoothing period for view transitions
   float mySmoothingPeriod;
 
   //! \brief Previous smoothing period value
   float myOldSmoothingPeriod;
 
   //! \brief Flag indicating if entity symbols should rotate
   bool myRotateEntitySymbols;
 
   //! \brief Previous entity symbols rotation setting
   bool myOldRotateEntitySymbols;
 
   //! \brief Previous laser designator setting
   bool myOldLaserDesignator;
 
   //! \brief Flag indicating if main window sensor mode needs to be reset
   bool myResetMainWindowSensorMode;
 
   //! \brief Count of update ticks since initialization
   int myTickCount;
 
   //! \brief Flag indicating if a saved view is being used
   bool myUsingSavedView;
 
   //! \brief Flag indicating if the aircraft model should be shown
   bool myShowModel;
};