fixedWingJoyFlightController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file fixedWingJoyFlightController.h
//! \ingroup vreVrfmodel
//! \brief Joystick controller for fixed-wing aircraft entities
//!
//! This file defines the DtFixedWingJoyFlightController class which extends
//! the fixed wing pilot controller with joystick control capabilities, allowing
//! for direct manual control of fixed-wing aircraft.
 
#pragma once
 
#include "vreVrfmodel/export.h"
#include <vrfmodel/fixedWingPilotController.h>
#include <vrfmodel/joystickControllerInterface.h>
 
class DtString;
class DtSimulationServices;
 
//! \brief Type identifier for the fixed wing joystick flight controller component
const char DtFixedWingJoyFlightControllerType[] = "fixed-wing-joy-flight-controller";
 
namespace makVre
{
//! \brief Controller for joystick control of fixed wing aircraft
//!
//! DtFixedWingJoyFlightController extends the fixed wing pilot controller with
//! joystick input capabilities, allowing direct manual control of fixed wing aircraft.
//! It implements the DtJoystickControllerInterface to process input from joystick
//! devices and translate it to appropriate flight control outputs.
//!
//! Uses Descriptor Type: DtJoyDeviceControllerDescriptor
class VREVRFMODEL_DLL DtFixedWingJoyFlightController : public DtFixedWingPilotController,
                                                       public DtJoystickControllerInterface
{
public:
   //! \brief Constructor
   //! \param name The name of this component
   //! \param owner The local object that owns this component
   //! \param simManager The simulation services manager
   //! \param desc Optional component descriptor
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //!
   //! Creates a new fixed wing joystick flight controller component with the specified parameters.
   DtFixedWingJoyFlightController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the fixed wing joy flight controller component.
   virtual ~DtFixedWingJoyFlightController() override;
 
   //! \brief Gets the type identifier for this component
   //! \return String identifying the component type (DtFixedWingJoyFlightControllerType)
   //!
   //! Implements the DtSimComponent::type() method to return the
   //! type identifier for this component.
   virtual const char* type() const override;
 
   //! \brief Factory method to create a new instance of this component
   //! \param name The name for the new component
   //! \param owner The local object that will own this component
   //! \param simManager The simulation services manager
   //! \param desc Optional component descriptor
   //! \param parentRegistry Optional parent registry for reader/writer functionality
   //! \return Pointer to the newly created component
   //!
   //! Static factory method used by the component creation system to instantiate
   //! new instances of this component type.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
private:
   //! \brief Default constructor (not implemented)
   //!
   //! Default constructor is private and not implemented to prevent
   //! creation of instances without proper initialization.
   DtFixedWingJoyFlightController();
 
   //! \brief Copy constructor (not implemented)
   //!
   //! Copy constructor is private and not implemented to prevent
   //! copy construction.
   DtFixedWingJoyFlightController(const DtFixedWingJoyFlightController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \return Reference to this object
   //!
   //! Assignment operator is private and not implemented to prevent assignment.
   DtFixedWingJoyFlightController& operator=(const DtFixedWingJoyFlightController& orig);
 
protected:
   //! \brief Processes joystick input and updates output ports
   //! \param functionGroup The function group identifier for the input
   //! \param function The specific function identifier within the group
   //! \param value The input value from the joystick
   //! \param repeat Flag indicating if this is a repeated input
   //!
   //! Implements the DtJoystickControllerInterface method to process joystick
   //! input and update the controller's output ports accordingly.
   virtual void calcAndSetPortValues(
      const DtString& functionGroup, const DtString& function, double value, bool repeat) override;
 
   //! \brief Handles joystick connection event
   //!
   //! Called when a joystick is connected to the system.
   //! Activates joystick control mode for this controller.
   virtual void joystickConnected() override;
 
   //! \brief Handles joystick disconnection event
   //!
   //! Called when a joystick is disconnected from the system.
   //! Deactivates joystick control mode for this controller.
   virtual void joystickDisconnected() override;
};
} // namespace makVre