rotaryWingJoyDeviceControllerDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file rotaryWingJoyDeviceControllerDescriptor.h
//! \ingroup vreVrfobjparam
//! \brief Rotary wing joystick controller descriptor for VREngage
//!
//! This file defines the DtRotaryWingJoyDeviceControllerDescriptor class, which configures
//! joystick control for rotary wing (helicopter) entities in VREngage. It provides parameters
//! for flight characteristics, including rise time and feedback constants for different axes.
 
#pragma once
 
#include "vreVrfobjparam/export.h"
 
#include <vrfobjparam/joyDeviceControllerDescriptor.h>
#include <readerWriter/rwReal.h>
 
//! \brief Type identifier string for the rotary wing joystick controller descriptor
const char DtRotaryWingJoyDeviceControllerDescriptorType[] = "rotary-wing-joy-controller-descriptor";
 
namespace makVre
{
//! \brief Rotary wing joystick controller descriptor for VREngage
//!
//! This class defines a descriptor for the rotary wing joystick flight controller component,
//! which enables helicopter-like entities to be controlled via joystick input devices.
//! It provides configuration for helicopter flight characteristics, including rise time
//! and feedback constants for yaw, pitch, and roll axes to create realistic helicopter
//! flight control in VREngage simulations.
class VREVRFOBJPARAM_DLL DtRotaryWingJoyDeviceControllerDescriptor : public DtJoyDeviceControllerDescriptor
{
public:
   //! \brief Constructor with component name
   //! \param name The name of this component
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new rotary wing joystick controller descriptor with the specified name.
   DtRotaryWingJoyDeviceControllerDescriptor(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Virtual destructor
   //!
   //! Cleans up resources used by the descriptor.
   virtual ~DtRotaryWingJoyDeviceControllerDescriptor() override;
 
   //! \brief Copy constructor
   //! \param orig The source descriptor to copy from
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //!
   //! Creates a new rotary wing joystick controller descriptor as a copy of the provided original.
   DtRotaryWingJoyDeviceControllerDescriptor(
      const DtRotaryWingJoyDeviceControllerDescriptor& orig, DtReaderWriterRegistry* parentRegistry = 0);
 
   //! \brief Assignment operator
   //! \param orig The source descriptor to copy from
   //! \return Reference to this descriptor after assignment
   //!
   //! Assigns the contents of the provided descriptor to this one.
   DtRotaryWingJoyDeviceControllerDescriptor& operator=(const DtRotaryWingJoyDeviceControllerDescriptor& orig);
 
   //! \brief Creates a clone of this descriptor
   //! \param parentRegistry Parent registry for reader/writer functionality (optional)
   //! \return Pointer to a new descriptor that is a clone of this one
   //!
   //! Creates a new rotary wing joystick controller descriptor as a deep copy of this one.
   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = 0) const override;
 
   //! \brief Gets the type identifier for this descriptor
   //! \return String identifying this descriptor type
   //!
   //! Returns a unique type identifier string for this descriptor type.
   //! Will return DtRotaryWingJoyDeviceControllerDescriptorType.
   virtual DtString type() const override;
 
   //! \brief Gets the controller rise time
   //! \return The controller rise time in seconds
   //!
   //! Returns the time it takes for the controller to respond fully to input changes.
   //! This affects how quickly the helicopter responds to joystick commands.
   virtual DtReal riseTime() const;
 
   //! \brief Gets the yaw control feedback constant
   //! \return The yaw feedback constant value
   //!
   //! Returns the feedback constant for yaw control, which affects
   //! the responsiveness and stability of yaw (rotation) control.
   virtual DtReal yawConst() const;
 
   //! \brief Gets the pitch control feedback constant
   //! \return The pitch feedback constant value
   //!
   //! Returns the feedback constant for pitch control, which affects
   //! the responsiveness and stability of forward/backward tilt.
   virtual DtReal pitchConst() const;
 
   //! \brief Gets the roll control feedback constant
   //! \return The roll feedback constant value
   //!
   //! Returns the feedback constant for roll control, which affects
   //! the responsiveness and stability of side-to-side tilt.
   virtual DtReal rollConst() const;
 
   //! \brief Factory function to create a new instance of this descriptor
   //! \return Pointer to a newly created descriptor
   //!
   //! Static factory function used by the descriptor creation system to instantiate
   //! new instances of this descriptor type.
   static DtComponentDescriptor* creator();
 
protected:
   //! \brief Default constructor (protected)
   //!
   //! Protected default constructor used by the factory pattern.
   DtRotaryWingJoyDeviceControllerDescriptor();
 
   //! \name Configuration Parameters
   //! These parameters are available for setting in the OPD files.
   //! @{
 
   //! \brief Controller response rise time
   //!
   //! The time it takes for the controller to respond fully to input changes.
   //! This affects how quickly the helicopter responds to joystick commands.
   //! Higher values result in slower, smoother response, while lower values
   //! provide quicker but potentially less stable control.
   //!
   //! Default value: 1.5
   //! Units: seconds
   DtRwReal myRiseTime;
 
   //! \brief Yaw control feedback constant
   //!
   //! The feedback constant used for yaw (rotation) control of the helicopter.
   //! This value affects how responsive and stable the helicopter is when rotating
   //! around its vertical axis. Higher values provide tighter control but may
   //! cause oscillation if set too high.
   //!
   //! Default value: 2.0
   DtRwReal myYawConst;
 
   //! \brief Pitch control feedback constant
   //!
   //! The feedback constant used for pitch (forward/backward tilt) control of the helicopter.
   //! This value affects how responsive and stable the helicopter is when tilting
   //! forward or backward. Higher values provide tighter control but may
   //! cause oscillation if set too high.
   //!
   //! Default value: 1.0
   DtRwReal myPitchConst;
 
   //! \brief Roll control feedback constant
   //!
   //! The feedback constant used for roll (side-to-side tilt) control of the helicopter.
   //! This value affects how responsive and stable the helicopter is when tilting
   //! to the left or right. Higher values provide tighter control but may
   //! cause oscillation if set too high.
   //!
   //! Default value: 2.2
   DtRwReal myRollConst;
   //! @}
};
} // namespace makVre