makVre::DtLadderClimbingActuatorDescriptor Class Reference

Detailed Description

This class defines a descriptor for ladder climbing actuator components in VREngage. It extends the base actuator component descriptor to add configuration for ladder climbing speed, which affects how quickly human entities can climb ladders in VREngage simulations.

#include <vreLadderClimbingActuatorDescriptor.h>

Inheritance diagram for makVre::DtLadderClimbingActuatorDescriptor:

Public Member Functions
	DtLadderClimbingActuatorDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtLadderClimbingActuatorDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtLadderClimbingActuatorDescriptor (const DtLadderClimbingActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtLadderClimbingActuatorDescriptor &	operator= (const DtLadderClimbingActuatorDescriptor &orig)
virtual	~DtLadderClimbingActuatorDescriptor () override
virtual DtString	type () const override
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const override
virtual DtReal	ladderClimbingSpeed () const
virtual void	setLadderClimbingSpeed (DtReal speed)

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Static Public Attributes
static double	theDefaultLadderClimbingSpeed

Protected Member Functions
	DtLadderClimbingActuatorDescriptor ()

Protected Attributes
DtRwReal	myLadderClimbingSpeed

Constructor & Destructor Documentation

DtLadderClimbingActuatorDescriptor() [1/4]

makVre::DtLadderClimbingActuatorDescriptor::DtLadderClimbingActuatorDescriptor	(	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 ladder climbing actuator descriptor with the specified name.

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

DtLadderClimbingActuatorDescriptor() [2/4]

makVre::DtLadderClimbingActuatorDescriptor::DtLadderClimbingActuatorDescriptor	(	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 ladder climbing actuator descriptor with the specified name.

DtLadderClimbingActuatorDescriptor() [3/4]

makVre::DtLadderClimbingActuatorDescriptor::DtLadderClimbingActuatorDescriptor	(	const DtLadderClimbingActuatorDescriptor &	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 ladder climbing actuator descriptor as a copy of the provided original.

References DtLadderClimbingActuatorDescriptor().

~DtLadderClimbingActuatorDescriptor()

virtual makVre::DtLadderClimbingActuatorDescriptor::~DtLadderClimbingActuatorDescriptor ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the descriptor.

DtLadderClimbingActuatorDescriptor() [4/4]

makVre::DtLadderClimbingActuatorDescriptor::DtLadderClimbingActuatorDescriptor ( )

protected

Default constructor (not implemented)

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

Member Function Documentation

operator=()

DtLadderClimbingActuatorDescriptor & makVre::DtLadderClimbingActuatorDescriptor::operator=

(

const DtLadderClimbingActuatorDescriptor &

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

type()

virtual DtString makVre::DtLadderClimbingActuatorDescriptor::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 DtLadderClimbingActuatorDescriptorType.

clone()

virtual DtComponentDescriptor * makVre::DtLadderClimbingActuatorDescriptor::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 ladder climbing actuator descriptor as a deep copy of this one.

ladderClimbingSpeed()

virtual DtReal makVre::DtLadderClimbingActuatorDescriptor::ladderClimbingSpeed ( ) const

virtual

Gets the ladder climbing speed.

Returns

The ladder climbing speed in meters per second

Returns the maximum speed at which entities can climb ladders.

setLadderClimbingSpeed()

virtual void makVre::DtLadderClimbingActuatorDescriptor::setLadderClimbingSpeed ( DtReal speed )

virtual

Sets the ladder climbing speed.

Parameters

speed

The ladder climbing speed in meters per second

Sets the maximum speed at which entities can climb ladders.

creator()

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

theDefaultLadderClimbingSpeed

double makVre::DtLadderClimbingActuatorDescriptor::theDefaultLadderClimbingSpeed

static

Default ladder climbing speed.

The default value for ladder climbing speed is 0.4 meters per second.

myLadderClimbingSpeed

DtRwReal makVre::DtLadderClimbingActuatorDescriptor::myLadderClimbingSpeed

protected

Maximum ladder climbing speed.

The maximum speed at which entities can climb ladders. Parameter name: "ladder-climbing-speed" Default value: 0.4 meters per second

---

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

• include/vrfExtensions/vreVrfobjparam/vreLadderClimbingActuatorDescriptor.h