DtGroundMoveToDescriptor Class Reference

A DtComponentDescriptor that has parameters that indicate the distances at which the entity is considered at a given waypoint or near a given waypoint. More...

Inheritance diagram for DtGroundMoveToDescriptor:

List of all members.

Public Member Functions
	DtGroundMoveToDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtGroundMoveToDescriptor (const DtGroundMoveToDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtGroundMoveToDescriptor &	operator= (const DtGroundMoveToDescriptor &orig)
	assignment
virtual	~DtGroundMoveToDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual void	setAtDistance (DtReal atDistance)
	Accessor/mutator for myAtDistance.
virtual DtReal	atDistance () const
	Accessor/mutator for myAtDistance.
virtual void	setNearDistance (DtReal nearDistance)
	Accessor/mutator for myNearDistance.
virtual DtReal	nearDistance () const
	Accessor/mutator for myNearDistance.
virtual void	setApproachSpeed (DtReal approachSpeed)
	Accessor/mutator for myApproachSpeed.
virtual DtReal	approachSpeed () const
	Accessor/mutator for myApproachSpeed.
virtual void	setStayInLane (bool value)
	Accessor/mutator for myStayInLane.
virtual bool	stayInLane () const
	Accessor/mutator for myStayInLane.
virtual void	setRoadCenterOffset (double value)
	Accessor/mutator for myRoadCenterOffset.
virtual double	roadCenterOffset () const
	Accessor/mutator for myRoadCenterOffset.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtGroundMoveToDescriptor ()
	default constructor; not implemented
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myNearDistance
	Parameter Name: near-distance Parameter Description: The distance from a destination point at which an entity begins to slow down.
DtRwReal	myAtDistance
	Parameter Name: at-distance Parameter Description: The distance from a destination point at which an entity considers itself to be at the point.
DtRwReal	myApproachSpeed
	Parameter Name: approach-speed Parameter Description: Speed entity should go when approaching (near) its goal.
DtRwBoolean	myStayInLane
	Parameter Name: stay-in-lane Parameter Description: Flag indicating whether the entity should treat roads differently when they are encountered along while moving (by keeping to one side of them).
DtRwReal	myRoadCenterOffset
	Parameter Name: road-center-offset Parameter Description: If the entity is using roads, this is the distance that should be maintained from the center of the road, in meters to the right of the direction of travel (negative numbers will be to the left).

---

Detailed Description

A DtComponentDescriptor that has parameters that indicate the distances at which the entity is considered at a given waypoint or near a given waypoint.

---

Constructor & Destructor Documentation

DtGroundMoveToDescriptor::DtGroundMoveToDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtGroundMoveToDescriptor::~DtGroundMoveToDescriptor

(

)

[virtual]

destructor

DtGroundMoveToDescriptor::DtGroundMoveToDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtGroundMoveToDescriptor& DtGroundMoveToDescriptor::operator=

(

const DtGroundMoveToDescriptor &

orig

)

assignment

virtual DtString DtGroundMoveToDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

This will be used to create the descriptor on read from an mtl file.

Reimplemented from DtComponentDescriptor.

Reimplemented in DtIndLifeformLauncherAcquireDescriptor, DtGroundFollowEntityDescriptor, and DtIndividualLifeformAcquireDescriptor.

virtual void DtGroundMoveToDescriptor::setAtDistance

(

DtReal

atDistance

)

[virtual]

Accessor/mutator for myAtDistance.

virtual DtReal DtGroundMoveToDescriptor::atDistance

(

)

const [virtual]

Accessor/mutator for myAtDistance.

virtual void DtGroundMoveToDescriptor::setNearDistance

(

DtReal

nearDistance

)

[virtual]

Accessor/mutator for myNearDistance.

virtual DtReal DtGroundMoveToDescriptor::nearDistance

(

)

const [virtual]

Accessor/mutator for myNearDistance.

virtual void DtGroundMoveToDescriptor::setApproachSpeed

(

DtReal

approachSpeed

)

[virtual]

Accessor/mutator for myApproachSpeed.

virtual DtReal DtGroundMoveToDescriptor::approachSpeed

(

)

const [virtual]

Accessor/mutator for myApproachSpeed.

virtual void DtGroundMoveToDescriptor::setStayInLane

(

bool

value

)

[virtual]

Accessor/mutator for myStayInLane.

virtual bool DtGroundMoveToDescriptor::stayInLane

(

)

const [virtual]

Accessor/mutator for myStayInLane.

virtual void DtGroundMoveToDescriptor::setRoadCenterOffset

(

double

value

)

[virtual]

Accessor/mutator for myRoadCenterOffset.

virtual double DtGroundMoveToDescriptor::roadCenterOffset

(

)

const [virtual]

Accessor/mutator for myRoadCenterOffset.

virtual DtComponentDescriptor* DtGroundMoveToDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtGroundFollowEntityDescriptor, DtIndividualLifeformAcquireDescriptor, and DtIndLifeformLauncherAcquireDescriptor.

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

Reimplemented in DtIndividualLifeformAcquireDescriptor, DtGroundFollowEntityDescriptor, and DtIndLifeformLauncherAcquireDescriptor.

---

Member Data Documentation

DtRwReal DtGroundMoveToDescriptor::myNearDistance [protected]

Parameter Name: near-distance
Parameter Description: The distance from a destination point at which an entity begins to slow down.

Parameter Default Value: 25.
Parameter Units: meters

DtRwReal DtGroundMoveToDescriptor::myAtDistance [protected]

Parameter Name: at-distance Parameter Description: The distance from a destination point at which an entity considers itself to be at the point.

Parameter Default Value: 1. Parameter Units: meters

DtRwReal DtGroundMoveToDescriptor::myApproachSpeed [protected]

Parameter Name: approach-speed
Parameter Description: Speed entity should go when approaching (near) its goal.

Default is 2. m/s.
Parameter Default Value: 2.
Parameter Units: meters/second

DtRwBoolean DtGroundMoveToDescriptor::myStayInLane [protected]

Parameter Name: stay-in-lane
Parameter Description: Flag indicating whether the entity should treat roads differently when they are encountered along while moving (by keeping to one side of them).

Parameter Default Value: False

DtRwReal DtGroundMoveToDescriptor::myRoadCenterOffset [protected]

Parameter Name: road-center-offset
Parameter Description: If the entity is using roads, this is the distance that should be maintained from the center of the road, in meters to the right of the direction of travel (negative numbers will be to the left).

Parameter Default Value: 2.
Parameter Units: meters

---

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

• include/vrfobjparam/gndMoveToDesc.h