pilotMenuLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file pilotMenuLogic.h
//! \brief Defines DtPilotMenuLogic for managing pilot-specific menu interactions
//! \ingroup vrePilotFrontend
 
#pragma once
 
#include <vrePlayerStation/playerComponent.h>
 
#include <vreMessageManager/vreMessage.h>
 
#include <vrePilotFrontend/export.h>
 
namespace makVre
{
//! \brief Forward declaration of the pilot simulation logic class
class DtPilotSimLogic;
 
//! \brief Forward declaration of the action menu logic class
class DtActionMenuLogic;
 
//! \brief Type identifier constant for DtPilotMenuLogic components
//!
//! This constant defines the string identifier used to identify DtPilotMenuLogic
//! component types within the VR-Engage framework. It is used for component
//! registration, type checking, and serialization operations.
constexpr const char* DtPilotMenuLogicType = "DtPilotMenuLogic";
 
//! \brief Menu logic component for the pilot role
//!
//! DtPilotMenuLogic manages context-sensitive menus and commands for the pilot
//! entity, handling interactions and menu selections specific to aircraft operations.
//! It processes menu selections and converts them into appropriate simulation commands.
class PILOT_DLL DtPilotMenuLogic : public makVre::DtPlayerComponent
{
public:
   //! \brief Default constructor
   DtPilotMenuLogic();
 
   //! \brief Virtual destructor
   virtual ~DtPilotMenuLogic() override;
 
   //! \brief Initializes the menu logic 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(DtPlayerStation* player, DtInitTable& config) override;
 
   //! \brief Performs post-initialization setup
   //! \return True if post-initialization was successful, false otherwise
   virtual bool postInitialize() override;
 
   //! \brief Updates menu logic 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 String identifier for this component type
   //!
   //! Returns the type identifier string for this component, which is used
   //! by the VR-Engage framework for component identification and management.
   //! The returned value matches DtPilotMenuLogicType.
   virtual const char* type() const override;
 
   //! \brief Handles menu-related messages
   //! \param msg Pointer to the message being processed
   //! \return Message processing result
   virtual DtVreMessageResult handleMenuMessage(DtVreMessage* msg);
 
   //! \brief Handles sensor data messages
   //! \param msg Pointer to the message being processed
   //! \return Message processing result
   virtual DtVreMessageResult handleSensorData(DtVreMessage* msg);
 
protected:
   //! \brief Pointer to the pilot simulation logic component
   DtPilotSimLogic* myPilotSimLogic;
};
 
} // namespace makVre