makVre::DtVreHumanMovementActuatorDescriptor Class Reference

Detailed Description

This class extends the base human movement actuator descriptor to add configuration for fatigue modeling. Fatigue affects entity movement speed based on activity levels, with different increase and recovery rates for different intensity levels, and thresholds that determine when fatigue starts to accumulate or how it affects movement capabilities.

#include <vreHumanMovementActuatorDescriptor.h>

Inheritance diagram for makVre::DtVreHumanMovementActuatorDescriptor:

Public Member Functions
	DtVreHumanMovementActuatorDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	DtVreHumanMovementActuatorDescriptor (const DtVreHumanMovementActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtVreHumanMovementActuatorDescriptor () override
DtVreHumanMovementActuatorDescriptor &	operator= (const DtVreHumanMovementActuatorDescriptor &orig)
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const override
DtReal	fatigueIncreaseRateLow () const
void	setFatigueIncreaseRateLow (DtReal fatigueIncreaseRateLow)
DtReal	fatigueIncreaseRateMedium () const
void	setFatigueIncreaseRateMedium (DtReal fatigueIncreaseRateMedium)
DtReal	fatigueIncreaseRateHigh () const
void	setFatigueIncreaseRateHigh (DtReal fatigueIncreaseRateHigh)
DtReal	fatigueRecoveryRateLow () const
void	setFatigueRecoveryRateLow (DtReal fatigueRateLow)
DtReal	fatigueRecoveryRateMedium () const
void	setFatigueRecoveryRateMedium (DtReal fatigueRateMedium)
DtReal	fatigueRecoveryRateHigh () const
void	setFatigueRecoveryRateHigh (DtReal fatigueRateHigh)
DtReal	fatigueMaxForMovement () const
void	setFatigueMaxForMovment (DtReal fatigueMaxForMovement)
DtReal	fatigueThresholdPercent () const
void	setFatigueThresholdPercent (DtReal fatigueThresholdPercent)

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Protected Attributes
DtRwReal	myFatigueIncreaseRateLow
DtRwReal	myFatigueIncreaseRateMedium
DtRwReal	myFatigueIncreaseRateHigh
DtRwReal	myFatigueRecoveryRateLow
DtRwReal	myFatigueRecoveryRateMedium
DtRwReal	myFatigueRecoveryRateHigh
DtRwReal	myFatigueMaxForMovement
DtRwReal	myFatigueThresholdPercent

Private Member Functions
	DtVreHumanMovementActuatorDescriptor ()

Constructor & Destructor Documentation

DtVreHumanMovementActuatorDescriptor() [1/3]

makVre::DtVreHumanMovementActuatorDescriptor::DtVreHumanMovementActuatorDescriptor ( )

private

Default constructor (not implemented)

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

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

DtVreHumanMovementActuatorDescriptor() [2/3]

makVre::DtVreHumanMovementActuatorDescriptor::DtVreHumanMovementActuatorDescriptor	(	const DtString &	componentName,
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with component name.

Parameters

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

Creates a new human movement actuator descriptor with the specified name.

DtVreHumanMovementActuatorDescriptor() [3/3]

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

Copy constructor.

Parameters

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

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

References DtVreHumanMovementActuatorDescriptor().

~DtVreHumanMovementActuatorDescriptor()

virtual makVre::DtVreHumanMovementActuatorDescriptor::~DtVreHumanMovementActuatorDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

Member Function Documentation

operator=()

DtVreHumanMovementActuatorDescriptor & makVre::DtVreHumanMovementActuatorDescriptor::operator=

(

const DtVreHumanMovementActuatorDescriptor &

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

type()

virtual DtString makVre::DtVreHumanMovementActuatorDescriptor::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 DtVreHumanMovementActuatorDescriptorType.

clone()

virtual DtComponentDescriptor * makVre::DtVreHumanMovementActuatorDescriptor::clone ( DtReaderWriterRegistry * parentRegistry = 0 ) 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 movement actuator descriptor as a deep copy of this one.

creator()

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

fatigueIncreaseRateLow()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueIncreaseRateLow

(

)

const

Gets the fatigue increase rate for low-intensity activity.

Returns

The fatigue increase rate in fatigue points per second

Returns the rate at which fatigue increases during low-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

Referenced by setFatigueIncreaseRateLow().

setFatigueIncreaseRateLow()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueIncreaseRateLow

(

DtReal

fatigueIncreaseRateLow

)

Sets the fatigue increase rate for low-intensity activity.

Parameters

fatigueIncreaseRateLow

The fatigue increase rate in fatigue points per second

Sets the rate at which fatigue increases during low-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

References fatigueIncreaseRateLow().

fatigueIncreaseRateMedium()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueIncreaseRateMedium

(

)

const

Gets the fatigue increase rate for medium-intensity activity.

Returns

The fatigue increase rate in fatigue points per second

Returns the rate at which fatigue increases during medium-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

Referenced by setFatigueIncreaseRateMedium().

setFatigueIncreaseRateMedium()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueIncreaseRateMedium

(

DtReal

fatigueIncreaseRateMedium

)

Sets the fatigue increase rate for medium-intensity activity.

Parameters

fatigueIncreaseRateMedium

The fatigue increase rate in fatigue points per second

Sets the rate at which fatigue increases during medium-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

References fatigueIncreaseRateMedium().

fatigueIncreaseRateHigh()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueIncreaseRateHigh

(

)

const

Gets the fatigue increase rate for high-intensity activity.

Returns

The fatigue increase rate in fatigue points per second

Returns the rate at which fatigue increases during high-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

Referenced by setFatigueIncreaseRateHigh().

setFatigueIncreaseRateHigh()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueIncreaseRateHigh

(

DtReal

fatigueIncreaseRateHigh

)

Sets the fatigue increase rate for high-intensity activity.

Parameters

fatigueIncreaseRateHigh

The fatigue increase rate in fatigue points per second

Sets the rate at which fatigue increases during high-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

References fatigueIncreaseRateHigh().

fatigueRecoveryRateLow()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueRecoveryRateLow

(

)

const

Gets the fatigue recovery rate for low-intensity rest.

Returns

The fatigue recovery rate in fatigue points per second

Returns the rate at which fatigue recovers during low-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

setFatigueRecoveryRateLow()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueRecoveryRateLow

(

DtReal

fatigueRateLow

)

Sets the fatigue recovery rate for low-intensity rest.

Parameters

fatigueRateLow

The fatigue recovery rate in fatigue points per second

Sets the rate at which fatigue recovers during low-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

fatigueRecoveryRateMedium()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueRecoveryRateMedium

(

)

const

Gets the fatigue recovery rate for medium-intensity rest.

Returns

The fatigue recovery rate in fatigue points per second

Returns the rate at which fatigue recovers during medium-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

setFatigueRecoveryRateMedium()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueRecoveryRateMedium

(

DtReal

fatigueRateMedium

)

Sets the fatigue recovery rate for medium-intensity rest.

Parameters

fatigueRateMedium

The fatigue recovery rate in fatigue points per second

Sets the rate at which fatigue recovers during medium-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

fatigueRecoveryRateHigh()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueRecoveryRateHigh

(

)

const

Gets the fatigue recovery rate for high-intensity rest.

Returns

The fatigue recovery rate in fatigue points per second

Returns the rate at which fatigue recovers during high-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

setFatigueRecoveryRateHigh()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueRecoveryRateHigh

(

DtReal

fatigueRateHigh

)

Sets the fatigue recovery rate for high-intensity rest.

Parameters

fatigueRateHigh

The fatigue recovery rate in fatigue points per second

Sets the rate at which fatigue recovers during high-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

fatigueMaxForMovement()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueMaxForMovement

(

)

const

Gets the maximum fatigue limit for movement capabilities.

Returns

The maximum fatigue points that still allow movement

Returns the maximum fatigue value that still allows movement. This prevents movement from completely stopping at maximum fatigue (100 points).

Referenced by setFatigueMaxForMovment().

setFatigueMaxForMovment()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueMaxForMovment

(

DtReal

fatigueMaxForMovement

)

Sets the maximum fatigue limit for movement capabilities.

Parameters

fatigueMaxForMovement

The maximum fatigue points that still allow movement

Sets the maximum fatigue value that still allows movement. This prevents movement from completely stopping at maximum fatigue (100 points).

References fatigueMaxForMovement().

fatigueThresholdPercent()

DtReal makVre::DtVreHumanMovementActuatorDescriptor::fatigueThresholdPercent

(

)

const

Gets the fatigue threshold percentage.

Returns

The fatigue threshold as a percentage of maximum speed

Returns the speed threshold (as a percentage of the adjusted maximum speed) above which fatigue starts to accumulate. The adjusted maximum speed takes into account the effects of overall health and mobility health.

Referenced by setFatigueThresholdPercent().

setFatigueThresholdPercent()

void makVre::DtVreHumanMovementActuatorDescriptor::setFatigueThresholdPercent

(

DtReal

fatigueThresholdPercent

)

Sets the fatigue threshold percentage.

Parameters

fatigueThresholdPercent

The fatigue threshold as a percentage of maximum speed

Sets the speed threshold (as a percentage of the adjusted maximum speed) above which fatigue starts to accumulate. The adjusted maximum speed takes into account the effects of overall health and mobility health.

References fatigueThresholdPercent().

Member Data Documentation

myFatigueIncreaseRateLow

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueIncreaseRateLow

protected

Fatigue increase rate for low-intensity activity.

Rate at which fatigue increases during low-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

myFatigueIncreaseRateMedium

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueIncreaseRateMedium

protected

Fatigue increase rate for medium-intensity activity.

Rate at which fatigue increases during medium-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

myFatigueIncreaseRateHigh

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueIncreaseRateHigh

protected

Fatigue increase rate for high-intensity activity.

Rate at which fatigue increases during high-intensity activity. Units are fatigue points per second, with maximum fatigue being 100 points.

myFatigueRecoveryRateLow

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueRecoveryRateLow

protected

Fatigue recovery rate for low-intensity rest.

Rate at which fatigue recovers during low-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

myFatigueRecoveryRateMedium

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueRecoveryRateMedium

protected

Fatigue recovery rate for medium-intensity rest.

Rate at which fatigue recovers during medium-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

myFatigueRecoveryRateHigh

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueRecoveryRateHigh

protected

Fatigue recovery rate for high-intensity rest.

Rate at which fatigue recovers during high-intensity rest periods. Units are fatigue points per second, with maximum fatigue being 100 points.

myFatigueMaxForMovement

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueMaxForMovement

protected

Maximum fatigue limit for movement capabilities.

The maximum fatigue value that still allows movement. This prevents movement from completely stopping at maximum fatigue (100 points).

myFatigueThresholdPercent

DtRwReal makVre::DtVreHumanMovementActuatorDescriptor::myFatigueThresholdPercent

protected

Fatigue threshold percentage.

The speed threshold (as a percentage of the adjusted maximum speed) above which fatigue starts to accumulate. The adjusted maximum speed takes into account the effects of overall health and mobility health.

---

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

• include/vrfExtensions/vreVrfobjparam/vreHumanMovementActuatorDescriptor.h