VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::DtRotaryWingJoyDeviceControllerDescriptor Class Reference

Detailed Description

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.

#include <rotaryWingJoyDeviceControllerDescriptor.h>

Inheritance diagram for makVre::DtRotaryWingJoyDeviceControllerDescriptor:
[legend]

Public Member Functions

 DtRotaryWingJoyDeviceControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 
virtual ~DtRotaryWingJoyDeviceControllerDescriptor () override
 
 DtRotaryWingJoyDeviceControllerDescriptor (const DtRotaryWingJoyDeviceControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
 
DtRotaryWingJoyDeviceControllerDescriptoroperator= (const DtRotaryWingJoyDeviceControllerDescriptor &orig)
 
virtual DtComponentDescriptor * clone (DtReaderWriterRegistry *parentRegistry=0) const override
 
virtual DtString type () const override
 
virtual DtReal riseTime () const
 
virtual DtReal yawConst () const
 
virtual DtReal pitchConst () const
 
virtual DtReal rollConst () const
 

Static Public Member Functions

static DtComponentDescriptor * creator ()
 

Protected Member Functions

 DtRotaryWingJoyDeviceControllerDescriptor ()
 

Protected Attributes

Configuration Parameters

These parameters are available for setting in the OPD files.

DtRwReal myRiseTime
 
DtRwReal myYawConst
 
DtRwReal myPitchConst
 
DtRwReal myRollConst
 

Constructor & Destructor Documentation

◆ DtRotaryWingJoyDeviceControllerDescriptor() [1/3]

makVre::DtRotaryWingJoyDeviceControllerDescriptor::DtRotaryWingJoyDeviceControllerDescriptor ( const DtString & name,
DtReaderWriterRegistry * parentRegistry = 0 )

Constructor with component name.

Parameters
nameThe name of this component
parentRegistryParent registry for reader/writer functionality (optional)

Creates a new rotary wing joystick controller descriptor with the specified name.

Referenced by DtRotaryWingJoyDeviceControllerDescriptor(), and operator=().

◆ ~DtRotaryWingJoyDeviceControllerDescriptor()

virtual makVre::DtRotaryWingJoyDeviceControllerDescriptor::~DtRotaryWingJoyDeviceControllerDescriptor ( )
overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

◆ DtRotaryWingJoyDeviceControllerDescriptor() [2/3]

makVre::DtRotaryWingJoyDeviceControllerDescriptor::DtRotaryWingJoyDeviceControllerDescriptor ( const DtRotaryWingJoyDeviceControllerDescriptor & orig,
DtReaderWriterRegistry * parentRegistry = 0 )

Copy constructor.

Parameters
origThe source descriptor to copy from
parentRegistryParent registry for reader/writer functionality (optional)

Creates a new rotary wing joystick controller descriptor as a copy of the provided original.

References DtRotaryWingJoyDeviceControllerDescriptor().

◆ DtRotaryWingJoyDeviceControllerDescriptor() [3/3]

makVre::DtRotaryWingJoyDeviceControllerDescriptor::DtRotaryWingJoyDeviceControllerDescriptor ( )
protected

Default constructor (protected)

Protected default constructor used by the factory pattern.

Member Function Documentation

◆ operator=()

DtRotaryWingJoyDeviceControllerDescriptor & makVre::DtRotaryWingJoyDeviceControllerDescriptor::operator= ( const DtRotaryWingJoyDeviceControllerDescriptor & orig)

Assignment operator.

Parameters
origThe source descriptor to copy from
Returns
Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtRotaryWingJoyDeviceControllerDescriptor().

◆ clone()

virtual DtComponentDescriptor * makVre::DtRotaryWingJoyDeviceControllerDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0) const
overridevirtual

Creates a clone of this descriptor.

Parameters
parentRegistryParent registry for reader/writer functionality (optional)
Returns
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.

Reimplemented in RlCgfVrf::DtVreRlJoyControllerDescriptor.

◆ type()

virtual DtString makVre::DtRotaryWingJoyDeviceControllerDescriptor::type ( ) const
overridevirtual

Gets the type identifier for this descriptor.

Returns
String identifying this descriptor type

Returns a unique type identifier string for this descriptor type. Will return DtRotaryWingJoyDeviceControllerDescriptorType.

Reimplemented in RlCgfVrf::DtVreRlJoyControllerDescriptor.

◆ riseTime()

virtual DtReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::riseTime ( ) const
virtual

Gets the controller rise time.

Returns
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.

◆ yawConst()

virtual DtReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::yawConst ( ) const
virtual

Gets the yaw control feedback constant.

Returns
The yaw feedback constant value

Returns the feedback constant for yaw control, which affects the responsiveness and stability of yaw (rotation) control.

◆ pitchConst()

virtual DtReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::pitchConst ( ) const
virtual

Gets the pitch control feedback constant.

Returns
The pitch feedback constant value

Returns the feedback constant for pitch control, which affects the responsiveness and stability of forward/backward tilt.

◆ rollConst()

virtual DtReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::rollConst ( ) const
virtual

Gets the roll control feedback constant.

Returns
The roll feedback constant value

Returns the feedback constant for roll control, which affects the responsiveness and stability of side-to-side tilt.

◆ creator()

static DtComponentDescriptor * makVre::DtRotaryWingJoyDeviceControllerDescriptor::creator ( )
static

Factory function to create a new instance of this descriptor.

Returns
Pointer to a newly created descriptor

Static factory function used by the descriptor creation system to instantiate new instances of this descriptor type.

Member Data Documentation

◆ myRiseTime

DtRwReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::myRiseTime
protected

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

◆ myYawConst

DtRwReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::myYawConst
protected

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

◆ myPitchConst

DtRwReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::myPitchConst
protected

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

◆ myRollConst

DtRwReal makVre::DtRotaryWingJoyDeviceControllerDescriptor::myRollConst
protected

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


The documentation for this class was generated from the following file: