flightControlsInputLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file flightControlsInputLogic.h
//! \brief Defines DtFlightControlsInputLogic for managing aircraft control inputs
//! \ingroup vrePilotFrontend
 
#pragma once
 
#include "vrePilotFrontend/export.h"
#include <vrePlayerStation/inputLogic.h>
 
namespace makVre
{
//! \brief Forward declaration of the pilot simulation logic class
class DtPilotSimLogic;
 
//! \brief Input logic component for aircraft flight controls
//!
//! DtFlightControlsInputLogic manages user input processing for aircraft
//! flight controls, handling keyboard, joystick, and controller inputs for
//! both fixed-wing and rotary-wing aircraft. It translates raw input values
//! into appropriate control actions for the aircraft entity.
class PILOT_DLL DtFlightControlsInputLogic : public DtInputLogic
{
public:
   //! \brief Constructor
   //! \param simLogic Reference to the pilot simulation logic component
   //! \param configFile Path to the input configuration file
   DtFlightControlsInputLogic(DtPilotSimLogic& simLogic, const std::string& configFile);
 
   //! \brief Virtual destructor
   virtual ~DtFlightControlsInputLogic() override;
 
   //! \brief Initializes the flight controls input logic
   //! \param isFixedWing True for fixed-wing aircraft, false for rotary-wing
   //! \param useRTD True to use real-time dynamics, false otherwise
   virtual void initialize(bool isFixedWing, bool useRTD);
 
   //! \brief Sets the flight controls mode based on aircraft type
   //! \param isFixedWing True for fixed-wing aircraft, false for rotary-wing
   //! \param useRTD True to use real-time dynamics, false otherwise
   //! \return Name of the configured function group
   virtual std::string setFlightControls(bool isFixedWing, bool useRTD);
 
   //! \brief Gets the current flight controls function group name
   //! \return Name of the current function group
   virtual std::string flightControlsFunctionGroup() const;
 
   //! \brief Handles air brake control input
   //! \param val Input value in the range [0.0, 1.0]
   virtual void airBrake(float val);
 
   //! \brief Handles flap state control input
   //! \param val Input value determining flap state
   virtual void flapState(float val);
 
   //! \brief Handles landing gear control input
   //! \param val Input value controlling gear state
   virtual void landingGear(float val);
 
   //! \brief Handles rudder pedal control input
   //! \param val Input value in the range [-1.0, 1.0]
   virtual void pedal(float val);
 
   //! \brief Handles pitch control input
   //! \param val Input value in the range [-1.0, 1.0], where positive is nose down
   virtual void pitch(float val);
 
   //! \brief Handles roll control input
   //! \param val Input value in the range [-1.0, 1.0], where positive is right roll
   virtual void roll(float val);
 
   //! \brief Handles throttle control input
   //! \param val Input value in the range [0.0, 1.0]
   virtual void throttle(float val);
 
   //! \brief Handles wheel brake control input
   //! \param val Input value in the range [0.0, 1.0]
   virtual void wheelBrake(float val);
 
   //! \brief Handles collective control input (for helicopters)
   //! \param val Input value in the range [0.0, 1.0]
   virtual void collective(float val);
 
   //! \brief Handles yaw control input
   //! \param val Input value in the range [-1.0, 1.0]
   virtual void yaw(float val);
 
 
   //! \brief Activates autopilot mode 1
   //! \param val Input value, typically 1.0 for activation
   virtual void autopilotMode1(float val);
 
   //! \brief Activates autopilot mode 2
   //! \param val Input value, typically 1.0 for activation
   virtual void autopilotMode2(float val);
 
   //! \brief Toggles autopilot on/off
   //! \param val Input value, typically 1.0 for activation
   virtual void autopilotToggle(float val);
 
   //! \brief Cycles to the next weapon with ammunition
   //! \param val Input value, typically 1.0 for activation
   virtual void cycleWeapon(float val);
 
   //! \brief Sets the flap to a specific position
   //! \param flap Flap position index to set
   virtual void setFlap(int flap);
 
   //! \brief Sets flaps to position 1
   //! \param val Input value, typically 1.0 for activation
   virtual void flap1(float val);
 
   //! \brief Sets flaps to position 2
   //! \param val Input value, typically 1.0 for activation
   virtual void flap2(float val);
 
   //! \brief Toggles flaps between positions
   //! \param val Input value, defaults to 1.0 for activation
   virtual void flapToggle(float val = 1);
 
   //! \brief Controls nose wheel steering
   //! \param val Input value in the range [-1.0, 1.0], where positive is right
   virtual void setNoseWheelSteering(float val);
 
   //! \brief Refills fuel resources and ammunition counts
   //! \param val Input value, typically 1.0 for activation
   virtual void replenishFuelAndAmmo(float val);
 
   //! \brief Toggles landing gear between raised and lowered positions
   //! \param val Input value, defaults to 1.0 for activation
   virtual void toggleLandingGear(float val = 1);
 
   //! \brief Raises the landing gear
   virtual void raiseLandingGear();
 
   //! \brief Lowers the landing gear
   virtual void lowerLandingGear();
 
   //! \brief Activates the weapon trigger
   //! \param val Input value, typically 1.0 for activation
   virtual void trigger(float val);
 
   //! \brief Launches specified countermeasures
   //! \param countermeasuresName Name of the countermeasures to launch
   virtual void launchCountermeasures(const std::string& countermeasuresName);
 
   //! \brief Toggles automatic countermeasures deployment
   //! \param val Input value, defaults to 1.0 for activation
   virtual void toggleAutomaticCountermeasures(float val = 1);
 
   //! \brief Launches chaff countermeasures
   //! \param val Input value, typically 1.0 for activation
   virtual void launchChaff(float val);
 
   //! \brief Launches flare countermeasures
   //! \param val Input value, typically 1.0 for activation
   virtual void launchFlares(float val);
 
   //! \brief Suppresses warning notifications
   //! \param val Input value, typically 1.0 for activation
   virtual void suppressWarnings(float val);
 
   //! \brief Toggles AR camera menu display
   //! \param val Input value, typically 1.0 for activation
   virtual void toggleArCameraMenu(float val);
 
   //! \brief Toggles the observer attachment mode
   //! \param val Input value, typically 1.0 for activation
   virtual void toggleObserverAttachMode(float val);
 
protected:
   //! \brief Reference to the pilot simulation logic component
   DtPilotSimLogic& mySimLogic;
 
   //! \brief Path to the input configuration file
   std::string myConfigFile;
 
   //! \brief Current flight controls function group name
   std::string myFunctionGroup;
 
   //! \brief Flag indicating if nose wheel steering is active
   bool myNoseWheelSteering;
 
   //! \brief Current flap state position
   int myFlapState;
};
} // namespace makVre