DtHumanMoveAlongControllerDescriptor Class Reference

DtHumanMoveAlongControllerDescriptor; descriptor for the DtHumanMoveAlongController component. More...

Inheritance diagram for DtHumanMoveAlongControllerDescriptor:

List of all members.

Public Member Functions
	DtHumanMoveAlongControllerDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtHumanMoveAlongControllerDescriptor (const DtHumanMoveAlongControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtHumanMoveAlongControllerDescriptor ()
DtHumanMoveAlongControllerDescriptor &	operator= (const DtHumanMoveAlongControllerDescriptor &orig)
	assignment
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual double	atDistance () const
	Accessor/mutator for myAtDistance.
virtual void	setAtDistance (double distance)
	Accessor/mutator for myAtDistance.
virtual bool	stayOnRoute () const
	Accessor/mutator for myStayOnRoute.
virtual void	setStayOnRoute (bool trueFalse)
	Accessor/mutator for myStayOnRoute.
virtual double	minCorrectionDistance () const
	Accessor/mutator for myMinCorrectionDistance.
virtual void	setMinCorrectionDistance (double distance)
	Accessor/mutator for myMinCorrectionDistance.
virtual double	maxCorrectionDistance () const
	Accessor/mutator for myMaxCorrectionDistance.
virtual void	setMaxCorrectionDistance (double distance)
	Accessor/mutator for myMaxCorrectionDistance.
virtual double	maxCorrectionAngle () const
	Accessor/mutator for myMaxCorrectionAngle.
virtual void	setMaxCorrectionAngle (double angle)
	Accessor/mutator for myMaxCorrectionAngle.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtHumanMoveAlongControllerDescriptor ()
	default constructor; not implemented
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myAtDistance
	Parameter Name: at-distance Parameter Description: Maximum distance from goal entity is considered to be 'at' desired location.
DtRwBoolean	myStayOnRoute
	Parameter Name: stay-on-route Parameter Description: If true, will attempt to closely follow route segments as it moves along a route.
DtRwReal	myMinCorrectionDistance
	Parameter Name: min-correction-distance Parameter Description: Minimum distance from route that entity will attempt to correct heading to stay on route segment.
DtRwReal	myMaxCorrectionDistance
	Parameter Name: max-correction-distance Parameter Description: Maximum distance from route that entity will attempt to correct heading to stay on route segment.
DtRwReal	myMaxCorrectionAngle
	Parameter Name: max-correction-angle Parameter Description: Maximum absolute angular corrections entity will make to attempt to move the entity closer to the route segment.

---

Detailed Description

DtHumanMoveAlongControllerDescriptor; descriptor for the DtHumanMoveAlongController component.

Instances of DtHumanMoveAlongControllerDescriptor are used to specify the parameters for a DtHumanMoveAlongController component.

---

Constructor & Destructor Documentation

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

real constructor

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

copy constructor

virtual DtHumanMoveAlongControllerDescriptor::~DtHumanMoveAlongControllerDescriptor

(

)

[virtual]

DtHumanMoveAlongControllerDescriptor::DtHumanMoveAlongControllerDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtHumanMoveAlongControllerDescriptor& DtHumanMoveAlongControllerDescriptor::operator=

(

const DtHumanMoveAlongControllerDescriptor &

orig

)

assignment

virtual DtString DtHumanMoveAlongControllerDescriptor::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:

DtHumanMoveAlongControllerDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtHumanMoveAlongControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

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

virtual double DtHumanMoveAlongControllerDescriptor::atDistance

(

)

const [virtual]

Accessor/mutator for myAtDistance.

virtual void DtHumanMoveAlongControllerDescriptor::setAtDistance

(

double

distance

)

[virtual]

Accessor/mutator for myAtDistance.

virtual bool DtHumanMoveAlongControllerDescriptor::stayOnRoute

(

)

const [virtual]

Accessor/mutator for myStayOnRoute.

virtual void DtHumanMoveAlongControllerDescriptor::setStayOnRoute

(

bool

trueFalse

)

[virtual]

Accessor/mutator for myStayOnRoute.

virtual double DtHumanMoveAlongControllerDescriptor::minCorrectionDistance

(

)

const [virtual]

Accessor/mutator for myMinCorrectionDistance.

virtual void DtHumanMoveAlongControllerDescriptor::setMinCorrectionDistance

(

double

distance

)

[virtual]

Accessor/mutator for myMinCorrectionDistance.

virtual double DtHumanMoveAlongControllerDescriptor::maxCorrectionDistance

(

)

const [virtual]

Accessor/mutator for myMaxCorrectionDistance.

virtual void DtHumanMoveAlongControllerDescriptor::setMaxCorrectionDistance

(

double

distance

)

[virtual]

Accessor/mutator for myMaxCorrectionDistance.

virtual double DtHumanMoveAlongControllerDescriptor::maxCorrectionAngle

(

)

const [virtual]

Accessor/mutator for myMaxCorrectionAngle.

virtual void DtHumanMoveAlongControllerDescriptor::setMaxCorrectionAngle

(

double

angle

)

[virtual]

Accessor/mutator for myMaxCorrectionAngle.

---

Member Data Documentation

DtRwReal DtHumanMoveAlongControllerDescriptor::myAtDistance [protected]

Parameter Name: at-distance
Parameter Description: Maximum distance from goal entity is considered to be 'at' desired location.

Parameter Units: meters Parameter Default Value: 0.5

DtRwBoolean DtHumanMoveAlongControllerDescriptor::myStayOnRoute [protected]

Parameter Name: stay-on-route
Parameter Description: If true, will attempt to closely follow route segments as it moves along a route.

If false, will only attempt to reach each waypoint in turn as it moves along the route. Parameter Units: Parameter Default Value: true

DtRwReal DtHumanMoveAlongControllerDescriptor::myMinCorrectionDistance [protected]

Parameter Name: min-correction-distance
Parameter Description: Minimum distance from route that entity will attempt to correct heading to stay on route segment.

If entity is within this distance from route segment, it will move directly toward the next waypoint. Parameter Units: meters Parameter Default Value: 0.1

DtRwReal DtHumanMoveAlongControllerDescriptor::myMaxCorrectionDistance [protected]

Parameter Name: max-correction-distance
Parameter Description: Maximum distance from route that entity will attempt to correct heading to stay on route segment.

If entity is within the min-correction-distance and max-correction-distance from the route segment, it will correct its heading toward the next waypoint in such a way that it 'pulls' the entity closer to the route as it travels. If distance from route segment is greater than this threshold, it will move directly toward the next waypoint. Parameter Units: meters Parameter Default Value: 10.0

DtRwReal DtHumanMoveAlongControllerDescriptor::myMaxCorrectionAngle [protected]

Parameter Name: max-correction-angle
Parameter Description: Maximum absolute angular corrections entity will make to attempt to move the entity closer to the route segment.

Default is ~45 degrees. Parameter Units: radians Parameter Default Value: 0.785398

---

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

• include/vrfobjparam/humanMoveAlongControllerDesc.h