vreFwlJoyController.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreFwlJoyController.h
//! \ingroup vreVrfRtd
//! \brief Fixed-wing joystick controller for VREngage
//!
//! This file defines the DtVreFwlJoyController class, which manages joystick
//! input for fixed-wing aircraft in VREngage and converts it into appropriate
//! control surface movements.
 
#pragma once
 
#include <vreVrfmodel/fixedWingJoyFlightController.h>
 
#include <vreVrfRtd/vreRtdBackendLibCommon.h>
#include <vreVrfRtd/vreRtdTraitJoyControllerExtension.h>
 
class DtBooleanOutputPort;
class DtIntegerOutputPort;
class DtAnalogOutputPort;
 
namespace makVrf
{
class DtArticulatedPartStateRepository;
}
 
 
namespace FwlCgfVrf
{
class DtVreFwlJoyControllerDescriptor;
 
//! \brief Type string for VREngage fixed-wing joystick controller component
//!
//! Constant used to identify this component type in the simulation system.
const char TS_JoyController[] = "fixedwinglib-cgf-vr-engage-joy-controller";
//! \brief Fixed-wing joystick controller for VREngage
//!
//! This class manages joystick input for fixed-wing aircraft and converts
//! it into appropriate control surface movements. It handles various input
//! devices and maps their values to aircraft control ports, providing a bridge
//! between the physical joystick and the aircraft flight model.
class RTD_VRF_BACKEND_PLUGIN_EXPORT DtVreFwlJoyController : public makVre::DtFixedWingJoyFlightController,
                                                            public ::vreRtd::DtVreRtdTraitJoyControllerExtension
{
public:
   //! \brief Constructor
   //! \param name The name of the component
   //! \param owner The local object this component belongs to
   //! \param simManager The simulation services manager
   //! \param desc Component descriptor containing configuration
   //! \param parentRegistry Parent registry for reader/writer functionality
   //!
   //! Initializes a new fixed-wing joystick controller component for VREngage control.
   DtVreFwlJoyController(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the joystick controller component.
   virtual ~DtVreFwlJoyController() override;
 
   //! \brief Initializes the joystick controller
   //! \return True if initialization was successful
   //!
   //! Performs initial setup of the joystick controller, including configuration
   //! loading and port initialization.
   virtual bool init() override;
 
   //! \brief Performs per-frame processing
   //!
   //! Called once per simulation frame to calculate new control values
   //! based on current joystick input and update the output ports.
   virtual void tick() override;
 
   //! \brief Calculates and sets port values for a specific joystick function
   //! \param functionGroup The function group of the joystick input
   //! \param function The specific function within the group
   //! \param value The input value from the joystick
   //! \param repeat Whether this is a repeated input
   //!
   //! Maps joystick inputs to the appropriate aircraft control outputs.
   virtual void calcAndSetPortValues(
      const DtString& functionGroup, const DtString& function, double value, bool repeat) override;
 
   //! \brief Creates component ports
   //! \return True if port creation was successful
   //!
   //! Creates output ports for stick, pedals, throttle, landing gear,
   //! flaps, and other aircraft controls.
   virtual bool createPorts() override;
 
   //! \brief Gets the component type
   //! \return The type string for this component
   //!
   //! Returns TS_JoyController as the component type identifier.
   virtual const char* type() const override;
 
   //! \brief Disables the joystick controller
   //!
   //! Disables joystick input processing, usually when player
   //! control is deactivated.
   virtual void disable() override;
 
   //! \brief Enables the joystick controller
   //!
   //! Enables joystick input processing, usually when player
   //! control is activated.
   virtual void enable() override;
 
   //! \brief Sets the enabled state of the joystick controller
   //! \param yes True to enable the controller, false to disable
   //!
   //! Directly sets the enabled state of the joystick controller.
   virtual void setIsEnabled(bool yes) override;
 
   //! \brief Component factory function
   //! \param name The name for the new component
   //! \param owner The local object the component will belong to
   //! \param simManager The simulation services manager
   //! \param desc Component descriptor containing configuration
   //! \param parentRegistry Parent registry for reader/writer functionality
   //! \return Pointer to the newly created component
   //!
   //! Static factory function used for component creation through the component registry.
   static DtSimComponent* creator(const DtString& name, DtLocalObject* owner, DtSimulationServices* simManager,
      DtComponentDescriptor* desc = 0, DtReaderWriterRegistry* parentRegistry = 0);
 
private:
   //! \brief Copy constructor (not implemented)
   //! \param orig The source object
   DtVreFwlJoyController(const DtVreFwlJoyController& orig);
 
   //! \brief Assignment operator (not implemented)
   //! \param orig The source object
   //! \return Reference to this object
   DtVreFwlJoyController& operator=(const DtVreFwlJoyController& orig);
 
   //! \brief Component descriptor containing configuration parameters
   const DtVreFwlJoyControllerDescriptor* myDesc;
 
   //! \brief Output port for landing gear control
   DtBooleanOutputPort* myLandingGearOutputPort;
 
   //! \brief Output port for flap setting
   DtIntegerOutputPort* myFlapSettingOutputPort;
 
   //! \brief Output port for air brake control
   DtAnalogOutputPort* myAirBrakeOutputPort;
 
   //! \brief Output port for wheel brake control
   DtAnalogOutputPort* myWheelBrakeOutputPort;
 
   //! \brief Flag tracking whether landing gear state has changed
   bool myLandingGearStateChanged;
 
   //! \brief Output port for control stick (pitch/roll)
   DtConstrainedDualAxisAnalogOutputPort* myStickOutputPort;
 
   //! \brief Output port for rudder pedals (yaw)
   DtConstrainedAnalogOutputPort* myPedalOutputPort;
 
   //! \brief Output port for throttle control
   DtConstrainedAnalogOutputPort* myThrottleOutputPort;
 
   //! \brief State repository for X-axis articulation
   makVrf::DtArticulatedPartStateRepository* myXPartRep;
 
   //! \brief State repository for Y-axis articulation
   makVrf::DtArticulatedPartStateRepository* myYPartRep;
};
 
} // namespace FwlCgfVrf