makVre::DtHumanJoystickMovementControllerDescriptor Class Reference

Detailed Description

This class defines a descriptor for the human joystick movement controller component, which enables human entity movement via joystick input devices. It provides configuration for mapping joystick axes to character movement controls, such as turning rate and forward/backward motion, to create realistic humanoid locomotion in VREngage simulations.

#include <humanJoystickMovementControllerDescriptor.h>

Inheritance diagram for makVre::DtHumanJoystickMovementControllerDescriptor:

Public Member Functions
	DtHumanJoystickMovementControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtHumanJoystickMovementControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtHumanJoystickMovementControllerDescriptor () override
	DtHumanJoystickMovementControllerDescriptor (const DtHumanJoystickMovementControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtHumanJoystickMovementControllerDescriptor &	operator= (const DtHumanJoystickMovementControllerDescriptor &orig)
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const override
virtual DtString	type () const override
virtual void	setMaxTurningRate (double rate)
virtual double	maxTurningRate () const

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtHumanJoystickMovementControllerDescriptor ()

Protected Attributes
Configuration Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myMaxTurningRate

Constructor & Destructor Documentation

DtHumanJoystickMovementControllerDescriptor() [1/4]

makVre::DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with component name.

Parameters

name	The name of this component
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new human joystick movement controller descriptor with the specified name.

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

DtHumanJoystickMovementControllerDescriptor() [2/4]

makVre::DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Constructor with component name as symbol string.

Parameters

name	The name of this component as a symbol string
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new human joystick movement controller descriptor with the specified name.

~DtHumanJoystickMovementControllerDescriptor()

virtual makVre::DtHumanJoystickMovementControllerDescriptor::~DtHumanJoystickMovementControllerDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

DtHumanJoystickMovementControllerDescriptor() [3/4]

makVre::DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor	(	const DtHumanJoystickMovementControllerDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL )

Copy constructor.

Parameters

orig	The source descriptor to copy from
parentRegistry	Parent registry for reader/writer functionality (optional)

Creates a new human joystick movement controller descriptor as a copy of the provided original.

References DtHumanJoystickMovementControllerDescriptor().

DtHumanJoystickMovementControllerDescriptor() [4/4]

makVre::DtHumanJoystickMovementControllerDescriptor::DtHumanJoystickMovementControllerDescriptor ( )

protected

Default constructor (not implemented)

Default constructor is protected and not implemented to prevent creation of instances without proper initialization.

Member Function Documentation

operator=()

DtHumanJoystickMovementControllerDescriptor & makVre::DtHumanJoystickMovementControllerDescriptor::operator=

(

const DtHumanJoystickMovementControllerDescriptor &

orig

)

Assignment operator.

Parameters

orig	The source descriptor to copy from

Returns

Reference to this descriptor after assignment

Assigns the contents of the provided descriptor to this one.

References DtHumanJoystickMovementControllerDescriptor().

clone()

virtual DtComponentDescriptor * makVre::DtHumanJoystickMovementControllerDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

overridevirtual

Creates a clone of this descriptor.

Parameters

parentRegistry

Parent registry for reader/writer functionality (optional)

Returns

Pointer to a new descriptor that is a clone of this one

Creates a new human joystick movement controller descriptor as a deep copy of this one.

Reimplemented in makVre::DtVreHumanJoystickMovementControllerDescriptor.

type()

virtual DtString makVre::DtHumanJoystickMovementControllerDescriptor::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. Used for creating descriptors from MTL files.

Reimplemented in makVre::DtVreHumanJoystickMovementControllerDescriptor.

setMaxTurningRate()

virtual void makVre::DtHumanJoystickMovementControllerDescriptor::setMaxTurningRate ( double rate )

virtual

Sets the maximum turning rate.

Parameters

rate	The maximum turning rate in radians per second

Sets the maximum rate at which the human entity can turn when controlled by a joystick.

maxTurningRate()

virtual double makVre::DtHumanJoystickMovementControllerDescriptor::maxTurningRate ( ) const

virtual

Gets the maximum turning rate.

Returns

The maximum turning rate in radians per second

Returns the maximum rate at which the human entity can turn when controlled by a joystick.

creator()

static DtComponentDescriptor * makVre::DtHumanJoystickMovementControllerDescriptor::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

myMaxTurningRate

DtRwReal makVre::DtHumanJoystickMovementControllerDescriptor::myMaxTurningRate

protected

Maximum turning rate for the human entity.

Defines the maximum rate at which the human entity can turn when controlled by a joystick. Higher values allow for faster turning, while lower values result in more gradual turns.

Default value: 3.14 (approximately PI) Units: radians/second

---

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

• include/vrfExtensions/vreVrfobjparam/humanJoystickMovementControllerDescriptor.h