DtHumanMovementActuatorDescriptor Class Reference

DtHumanMovementActuatorDescriptor; descriptor for the DtHumanMovementActuatorDescriptor component. More...

Inheritance diagram for DtHumanMovementActuatorDescriptor:

List of all members.

Public Member Functions
	DtHumanMovementActuatorDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtHumanMovementActuatorDescriptor (const DtHumanMovementActuatorDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtHumanMovementActuatorDescriptor ()
DtHumanMovementActuatorDescriptor &	operator= (const DtHumanMovementActuatorDescriptor &orig)
	assignment
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual bool	checkForTerrainCollisions () const
	Accessor/mutator for myCheckForTerrainCollisions.
virtual void	setCheckForTerrainCollisions (bool yesOrNo)
	Accessor/mutator for myCheckForTerrainCollisions.
virtual double	maxUprightTerrainPitch () const
	Accessor/mutator for myMaxUprightTerrainPitch.
virtual void	setMaxUprightTerrainPitch (double pitch)
	Accessor/mutator for myMaxUprightTerrainPitch.
virtual double	maxWalkingSpeed () const
	Accessor/mutator for #myMaxWalkingSpeeed.
virtual void	setMaxWalkingSpeed (double speed)
	Accessor/mutator for #myMaxWalkingSpeeed.
virtual const DtRwStaticDynamicPostureList &	staticToDynamicPostureMap () const
	Accessor for myStaticToDynamicPostureMap.
virtual const DtRwSoilSpeedFactorList &	soilToMaxSpeedFactorMap () const
	Accessor for mySoilToMaxSpeedFactorMap.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtHumanMovementActuatorDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myCheckForTerrainCollisions
	Parameter Name: check-terrain-collisions Parameter Description: Specifies whether or not the actuator will check for terrain collisions when moving the entity.
DtRwReal	myMaxUprightTerrainPitch
	Parameter Name: max-upright-terrain-pitch Parameter Description: Maximum terrain pitch at which entity can maintain a static upright posture (i.e.
DtRwReal	myMaxWalkingSpeed
	Parameter Name: max-walking-speed Parameter Description: Maximum speed at which entity will walk.
DtRwStaticDynamicPostureList	myStaticToDynamicPostureMap
	Parameter Name: static-to-dynamic_posture-map Parameter Description: Map of static postures to dynamic postures that actuator will map to when entity is moving.
DtRwSoilSpeedFactorList	mySoilToMaxSpeedFactorMap
	Parameter Name: soil-to-max-speed-factor-map Parameter Description: Map of soil type to a multiplier used to scale the maximum speed of an entity.

---

Detailed Description

DtHumanMovementActuatorDescriptor; descriptor for the DtHumanMovementActuatorDescriptor component.

Instances of DtHumanMovementActuatorDescriptor are used to specify the parameters for a DtHumanMovementActuator component.

---

Constructor & Destructor Documentation

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

real constructor

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

copy constructor

virtual DtHumanMovementActuatorDescriptor::~DtHumanMovementActuatorDescriptor

(

)

[virtual]

DtHumanMovementActuatorDescriptor::DtHumanMovementActuatorDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtHumanMovementActuatorDescriptor& DtHumanMovementActuatorDescriptor::operator=

(

const DtHumanMovementActuatorDescriptor &

orig

)

assignment

virtual DtString DtHumanMovementActuatorDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtHumanMovementActuatorDescriptorType

Reimplemented from DtActuatorComponentDescriptor.

virtual DtComponentDescriptor* DtHumanMovementActuatorDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtActuatorComponentDescriptor.

static DtComponentDescriptor* DtHumanMovementActuatorDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtActuatorComponentDescriptor.

virtual bool DtHumanMovementActuatorDescriptor::checkForTerrainCollisions

(

)

const [virtual]

Accessor/mutator for myCheckForTerrainCollisions.

virtual void DtHumanMovementActuatorDescriptor::setCheckForTerrainCollisions

(

bool

yesOrNo

)

[virtual]

Accessor/mutator for myCheckForTerrainCollisions.

virtual double DtHumanMovementActuatorDescriptor::maxUprightTerrainPitch

(

)

const [virtual]

Accessor/mutator for myMaxUprightTerrainPitch.

virtual void DtHumanMovementActuatorDescriptor::setMaxUprightTerrainPitch

(

double

pitch

)

[virtual]

Accessor/mutator for myMaxUprightTerrainPitch.

virtual double DtHumanMovementActuatorDescriptor::maxWalkingSpeed

(

)

const [virtual]

Accessor/mutator for #myMaxWalkingSpeeed.

virtual void DtHumanMovementActuatorDescriptor::setMaxWalkingSpeed

(

double

speed

)

[virtual]

Accessor/mutator for #myMaxWalkingSpeeed.

virtual const DtRwStaticDynamicPostureList& DtHumanMovementActuatorDescriptor::staticToDynamicPostureMap

(

)

const [virtual]

Accessor for myStaticToDynamicPostureMap.

virtual const DtRwSoilSpeedFactorList& DtHumanMovementActuatorDescriptor::soilToMaxSpeedFactorMap

(

)

const [virtual]

Accessor for mySoilToMaxSpeedFactorMap.

---

Member Data Documentation

DtRwBoolean DtHumanMovementActuatorDescriptor::myCheckForTerrainCollisions [protected]

Parameter Name: check-terrain-collisions
Parameter Description: Specifies whether or not the actuator will check for terrain collisions when moving the entity.

If this returns true, then the actuator will not move the entity through terrain.
Parameter Default Value: False

DtRwReal DtHumanMovementActuatorDescriptor::myMaxUprightTerrainPitch [protected]

Parameter Name: max-upright-terrain-pitch
Parameter Description: Maximum terrain pitch at which entity can maintain a static upright posture (i.e.

standing posture). Actuator will switch to a prone posture when terrain pitch exceeds this value.
Parameter Units: radians Parameter Default Value: 0.5236

DtRwReal DtHumanMovementActuatorDescriptor::myMaxWalkingSpeed [protected]

Parameter Name: max-walking-speed
Parameter Description: Maximum speed at which entity will walk.

Actuator will switch from a walking posture to a running posture when current speed exceeds this value. Parameter Units: meters/second Parameter Default Value: 2.0

DtRwStaticDynamicPostureList DtHumanMovementActuatorDescriptor::myStaticToDynamicPostureMap [protected]

Parameter Name: static-to-dynamic_posture-map
Parameter Description: Map of static postures to dynamic postures that actuator will map to when entity is moving.

The actuator recieves static posture as input which it sets when the entity is not moving. If the entity is moving, it uses this map to determine the appropriate (closest) moving posture to switch to. For example, if current static posture is 'prone', and the entity starts to move, switch to a dynamic posture of 'crawling'. Parameter Units: Parameter Default Value:

DtRwSoilSpeedFactorList DtHumanMovementActuatorDescriptor::mySoilToMaxSpeedFactorMap [protected]

Parameter Name: soil-to-max-speed-factor-map
Parameter Description: Map of soil type to a multiplier used to scale the maximum speed of an entity.

This factor is multiplied by the entity's overall maximum speed to obtain a maximum speed appropriate for the soil conditions. The available soil types are: "paved-road" "hard-packed" "rocks" "sand" "gravel" "shallow-water" "muck" "deep-water" Parameter Units: Parameter Default Value:

---

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

• include/vrfobjparam/humanMovementActuatorDesc.h