makVre::DtVreHumanJoystickMovementControllerDescriptor Class Reference

Detailed Description

This class extends the base human joystick movement controller descriptor to add configuration for posture-specific speed multipliers. It allows the movement speed of human entities to be adjusted based on their current posture (prone, kneeling, or crouching), creating more realistic movement behavior in VREngage simulations.

#include <vreHumanJoystickMovementControllerDescriptor.h>

Inheritance diagram for makVre::DtVreHumanJoystickMovementControllerDescriptor:

Public Member Functions
	DtVreHumanJoystickMovementControllerDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtVreHumanJoystickMovementControllerDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtVreHumanJoystickMovementControllerDescriptor () override
	DtVreHumanJoystickMovementControllerDescriptor (const DtVreHumanJoystickMovementControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtVreHumanJoystickMovementControllerDescriptor &	operator= (const DtVreHumanJoystickMovementControllerDescriptor &orig)
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const override
virtual double	proneSpeedMultiplier () const
virtual void	setProneSpeedMultiplier (double val)
virtual double	kneelingSpeedMultiplier () const
virtual void	setKneelingSpeedMultiplier (double val)
virtual double	crouchingSpeedMultiplier () const
virtual void	setCrouchingSpeedMultipler (double val)
Public Member Functions inherited from makVre::DtHumanJoystickMovementControllerDescriptor
	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 void	setMaxTurningRate (double rate)
virtual double	maxTurningRate () const

Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Member Functions inherited from makVre::DtHumanJoystickMovementControllerDescriptor
static DtComponentDescriptor *	creator ()

Protected Member Functions
	DtVreHumanJoystickMovementControllerDescriptor ()
Protected Member Functions inherited from makVre::DtHumanJoystickMovementControllerDescriptor
	DtHumanJoystickMovementControllerDescriptor ()

Protected Attributes
DtRwReal	myProneSpeedMultiplier
DtRwReal	myKneelingSpeedMultiplier
DtRwReal	myCrouchingSpeedMultiplier
Protected Attributes inherited from makVre::DtHumanJoystickMovementControllerDescriptor
DtRwReal	myMaxTurningRate

Constructor & Destructor Documentation

DtVreHumanJoystickMovementControllerDescriptor() [1/4]

makVre::DtVreHumanJoystickMovementControllerDescriptor::DtVreHumanJoystickMovementControllerDescriptor	(	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 DtVreHumanJoystickMovementControllerDescriptor(), and operator=().

DtVreHumanJoystickMovementControllerDescriptor() [2/4]

makVre::DtVreHumanJoystickMovementControllerDescriptor::DtVreHumanJoystickMovementControllerDescriptor	(	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.

~DtVreHumanJoystickMovementControllerDescriptor()

virtual makVre::DtVreHumanJoystickMovementControllerDescriptor::~DtVreHumanJoystickMovementControllerDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

DtVreHumanJoystickMovementControllerDescriptor() [3/4]

makVre::DtVreHumanJoystickMovementControllerDescriptor::DtVreHumanJoystickMovementControllerDescriptor	(	const DtVreHumanJoystickMovementControllerDescriptor &	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 DtVreHumanJoystickMovementControllerDescriptor().

DtVreHumanJoystickMovementControllerDescriptor() [4/4]

makVre::DtVreHumanJoystickMovementControllerDescriptor::DtVreHumanJoystickMovementControllerDescriptor ( )

protected

Default constructor (not implemented)

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

Member Function Documentation

operator=()

DtVreHumanJoystickMovementControllerDescriptor & makVre::DtVreHumanJoystickMovementControllerDescriptor::operator=

(

const DtVreHumanJoystickMovementControllerDescriptor &

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 DtVreHumanJoystickMovementControllerDescriptor().

type()

virtual DtString makVre::DtVreHumanJoystickMovementControllerDescriptor::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 DtVreHumanJoystickMovementControllerDescriptorType.

Reimplemented from makVre::DtHumanJoystickMovementControllerDescriptor.

clone()

virtual DtComponentDescriptor * makVre::DtVreHumanJoystickMovementControllerDescriptor::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 from makVre::DtHumanJoystickMovementControllerDescriptor.

creator()

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

proneSpeedMultiplier()

virtual double makVre::DtVreHumanJoystickMovementControllerDescriptor::proneSpeedMultiplier ( ) const

virtual

Gets the prone speed multiplier.

Returns

The speed multiplier for prone posture

Returns the multiplier applied to movement speed when the entity is in prone posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

setProneSpeedMultiplier()

virtual void makVre::DtVreHumanJoystickMovementControllerDescriptor::setProneSpeedMultiplier ( double val )

virtual

Sets the prone speed multiplier.

Parameters

val	The speed multiplier for prone posture

Sets the multiplier applied to movement speed when the entity is in prone posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

kneelingSpeedMultiplier()

virtual double makVre::DtVreHumanJoystickMovementControllerDescriptor::kneelingSpeedMultiplier ( ) const

virtual

Gets the kneeling speed multiplier.

Returns

The speed multiplier for kneeling posture

Returns the multiplier applied to movement speed when the entity is in kneeling posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

setKneelingSpeedMultiplier()

virtual void makVre::DtVreHumanJoystickMovementControllerDescriptor::setKneelingSpeedMultiplier ( double val )

virtual

Sets the kneeling speed multiplier.

Parameters

val	The speed multiplier for kneeling posture

Sets the multiplier applied to movement speed when the entity is in kneeling posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

crouchingSpeedMultiplier()

virtual double makVre::DtVreHumanJoystickMovementControllerDescriptor::crouchingSpeedMultiplier ( ) const

virtual

Gets the crouching speed multiplier.

Returns

The speed multiplier for crouching posture

Returns the multiplier applied to movement speed when the entity is in crouching posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

setCrouchingSpeedMultipler()

virtual void makVre::DtVreHumanJoystickMovementControllerDescriptor::setCrouchingSpeedMultipler ( double val )

virtual

Sets the crouching speed multiplier.

Parameters

val	The speed multiplier for crouching posture

Sets the multiplier applied to movement speed when the entity is in crouching posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

Member Data Documentation

myProneSpeedMultiplier

DtRwReal makVre::DtVreHumanJoystickMovementControllerDescriptor::myProneSpeedMultiplier

protected

Speed multiplier for prone posture.

Multiplier applied to movement speed when the entity is in prone posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

myKneelingSpeedMultiplier

DtRwReal makVre::DtVreHumanJoystickMovementControllerDescriptor::myKneelingSpeedMultiplier

protected

Speed multiplier for kneeling posture.

Multiplier applied to movement speed when the entity is in kneeling posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

myCrouchingSpeedMultiplier

DtRwReal makVre::DtVreHumanJoystickMovementControllerDescriptor::myCrouchingSpeedMultiplier

protected

Speed multiplier for crouching posture.

Multiplier applied to movement speed when the entity is in crouching posture. A value of 1.0 represents normal speed, values less than 1.0 reduce speed, and values greater than 1.0 increase speed.

---

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

• include/vrfExtensions/vreVrfobjparam/vreHumanJoystickMovementControllerDescriptor.h