DtGroundMoveDirectionControllerDescriptor Class Reference

DtGroundMoveDirectionControllerDescriptor. More...

Inheritance diagram for DtGroundMoveDirectionControllerDescriptor:

List of all members.

Public Member Functions
	DtGroundMoveDirectionControllerDescriptor (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtGroundMoveDirectionControllerDescriptor (const DtGroundMoveDirectionControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	Copy constructor.
DtGroundMoveDirectionControllerDescriptor &	operator= (const DtGroundMoveDirectionControllerDescriptor &orig)
	Assignment operator.
virtual	~DtGroundMoveDirectionControllerDescriptor ()
	Destructor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
virtual double	highSpeedMinPivotAngle () const
	Accessor/mutator for myHighSpeedMinPivotAngle.
virtual void	setHighSpeedMinPivotAngle (const double &newValue)
	Accessor/mutator for myHighSpeedMinPivotAngle.
virtual double	lowSpeedMinPivotAngle () const
	Accessor/mutator for myLowSpeedMinPivotAngle.
virtual void	setLowSpeedMinPivotAngle (const double &newValue)
	Accessor/mutator for myLowSpeedMinPivotAngle.
virtual bool	pivotOnTurns () const
	Accessor/mutator for myPivotOnTurns.
virtual void	setPivotOnTurns (const bool &newValue)
	Accessor/mutator for myPivotOnTurns.
virtual double	pivotSpeedCutoff () const
	Accessor/mutator for myPivotSpeedCutoff.
virtual void	setPivotSpeedCutoff (const double &newValue)
	Accessor/mutator for myPivotSpeedCutoff.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
	Static creator function for factory registration.
Protected Attributes
DtRwReal	myHighSpeedMinPivotAngle
	Parameter Name: high-speed-min-pivot-angle Parameter Description: When the speed of the entity is above the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.
DtRwReal	myLowSpeedMinPivotAngle
	Parameter Name: low-speed-min-pivot-angle Parameter Description: When the speed of the entity is below the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.
DtRwBoolean	myPivotOnTurns
	Parameter Name: pivot-on-turns Parameter Description: Specifies whether or not the entity should pivot when turning.
DtRwReal	myPivotSpeedCutoff
	Parameter Name: pivot-speed-cutoff Parameter Description: Specifies the speed used to differentiate between hish-speed and low-speed-min-pivot-angles.

---

Detailed Description

DtGroundMoveDirectionControllerDescriptor.

This is the descriptor for DtGroundMoveDirectionController components. It contains all parameters which can be specified in the OPD file for this component.

---

Constructor & Destructor Documentation

DtGroundMoveDirectionControllerDescriptor::DtGroundMoveDirectionControllerDescriptor	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructor.

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

Copy constructor.

virtual DtGroundMoveDirectionControllerDescriptor::~DtGroundMoveDirectionControllerDescriptor

(

)

[virtual]

Destructor.

---

Member Function Documentation

DtGroundMoveDirectionControllerDescriptor& DtGroundMoveDirectionControllerDescriptor::operator=

(

const DtGroundMoveDirectionControllerDescriptor &

orig

)

Assignment operator.

virtual DtComponentDescriptor* DtGroundMoveDirectionControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Returns:

a copy of this class using the copy constructor.

Reimplemented from DtComponentDescriptor.

Reimplemented in BHAVE::DtBhaveMovementChooserControllerDescriptor.

virtual DtString DtGroundMoveDirectionControllerDescriptor::type

(

)

const [virtual]

Returns:

DtGroundMoveDirectionControllerDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in BHAVE::DtBhaveMovementChooserControllerDescriptor.

static DtComponentDescriptor* DtGroundMoveDirectionControllerDescriptor::creator

(

)

[static]

Static creator function for factory registration.

Reimplemented from DtComponentDescriptor.

Reimplemented in BHAVE::DtBhaveMovementChooserControllerDescriptor.

virtual double DtGroundMoveDirectionControllerDescriptor::highSpeedMinPivotAngle

(

)

const [virtual]

Accessor/mutator for myHighSpeedMinPivotAngle.

virtual void DtGroundMoveDirectionControllerDescriptor::setHighSpeedMinPivotAngle

(

const double &

newValue

)

[virtual]

Accessor/mutator for myHighSpeedMinPivotAngle.

virtual double DtGroundMoveDirectionControllerDescriptor::lowSpeedMinPivotAngle

(

)

const [virtual]

Accessor/mutator for myLowSpeedMinPivotAngle.

virtual void DtGroundMoveDirectionControllerDescriptor::setLowSpeedMinPivotAngle

(

const double &

newValue

)

[virtual]

Accessor/mutator for myLowSpeedMinPivotAngle.

virtual bool DtGroundMoveDirectionControllerDescriptor::pivotOnTurns

(

)

const [virtual]

Accessor/mutator for myPivotOnTurns.

virtual void DtGroundMoveDirectionControllerDescriptor::setPivotOnTurns

(

const bool &

newValue

)

[virtual]

Accessor/mutator for myPivotOnTurns.

virtual double DtGroundMoveDirectionControllerDescriptor::pivotSpeedCutoff

(

)

const [virtual]

Accessor/mutator for myPivotSpeedCutoff.

virtual void DtGroundMoveDirectionControllerDescriptor::setPivotSpeedCutoff

(

const double &

newValue

)

[virtual]

Accessor/mutator for myPivotSpeedCutoff.

---

Member Data Documentation

DtRwReal DtGroundMoveDirectionControllerDescriptor::myHighSpeedMinPivotAngle [protected]

Parameter Name: high-speed-min-pivot-angle
Parameter Description: When the speed of the entity is above the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.

Parameter Default Value: pi/2 (90 degrees).
Parameter Units: Radians.

DtRwReal DtGroundMoveDirectionControllerDescriptor::myLowSpeedMinPivotAngle [protected]

Parameter Name: low-speed-min-pivot-angle
Parameter Description: When the speed of the entity is below the pivot-speed-cutoff, it will pivot to its desired heading any time the desired heading is greater than this value from the actual heading.

Parameter Default Value: 0.175 (10 degrees)
Parameter Units: Radians.

DtRwBoolean DtGroundMoveDirectionControllerDescriptor::myPivotOnTurns [protected]

Parameter Name: pivot-on-turns
Parameter Description: Specifies whether or not the entity should pivot when turning.

Pivoting will only occur if the entity is capable of pivoting, and if the conditions for a pivot turn are met, based on the other parameters.
Parameter Default Value: true

DtRwReal DtGroundMoveDirectionControllerDescriptor::myPivotSpeedCutoff [protected]

Parameter Name: pivot-speed-cutoff
Parameter Description: Specifies the speed used to differentiate between hish-speed and low-speed-min-pivot-angles.

Parameter Default Value: 0.5 Parameter Units: m/s.

---

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

• include/vrfobjparam/groundMoveDirectionControllerDesc.h