DtGroundFollowEntityDescriptor Class Reference

A DtGroundMoveToDescriptor that has the speed ratios to use when at, near, or past the desired location relative to the followed entity. More...

Inheritance diagram for DtGroundFollowEntityDescriptor:

List of all members.

Public Member Functions
	DtGroundFollowEntityDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtGroundFollowEntityDescriptor (const DtGroundFollowEntityDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtGroundFollowEntityDescriptor &	operator= (const DtGroundFollowEntityDescriptor &orig)
	assignment
virtual	~DtGroundFollowEntityDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of descriptor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	nearCatchUpFactor () const
	Accessor/mutator for myNearCatchUpFactor.
virtual void	setNearCatchUpFactor (DtReal nearCatchUpFactor)
	Accessor/mutator for myNearCatchUpFactor.
virtual DtReal	farCatchUpFactor () const
	Accessor/mutator for myFarCatchUpFactor.
virtual void	setFarCatchUpFactor (DtReal farCatchUpFactor)
	Accessor/mutator for myFarCatchUpFactor.
virtual DtReal	passedSlowDownFactor () const
	Accessor/mutator for myPassedSlowDownFactor.
virtual void	setPassedSlowDownFactor (DtReal passedSlowDownFactor)
	Accessor/mutator for myPassedSlowDownFactor.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtGroundFollowEntityDescriptor ()
	default constructor; not implemented
Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwReal	myNearCatchUpFactor
	Parameter Name: near-catch-up-factor Parameter Description: The speed the entity uses to catch up to the followed entity if it is 'near', but not 'at' the point at which it is supposed to be relative to the followed entity.
DtRwReal	myFarCatchUpFactor
	Parameter Name: far-catch-up-factor Parameter Description: The amount by which the ordered speed increases so that the entity can catch up to the followed entity if it is further away from the followed entity than the 'near' distance.
DtRwReal	myPassedSlowDownFactor
	Parameter Name: passed-slow-down-factor Parameter Description: Speed the entity is to use if it is closer to the followed entity than the specified following distance.

---

Detailed Description

A DtGroundMoveToDescriptor that has the speed ratios to use when at, near, or past the desired location relative to the followed entity.

End User Description: You can set the at-distance, near-distance, passed-slow-down-factor, near-catch-up-factor, and far-catch-up-factor parameters in the object parameters database.
Developer Description: The terms 'at' and 'near' are used with the same meaning as in the DtGroundMoveToDescriptor.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtGroundFollowEntityDescriptor::~DtGroundFollowEntityDescriptor

(

)

[virtual]

destructor

DtGroundFollowEntityDescriptor::DtGroundFollowEntityDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtGroundFollowEntityDescriptor& DtGroundFollowEntityDescriptor::operator=

(

const DtGroundFollowEntityDescriptor &

orig

)

assignment

virtual DtString DtGroundFollowEntityDescriptor::type

(

)

const [virtual]

Returns the type of descriptor.

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

Reimplemented from DtGroundMoveToDescriptor.

virtual DtReal DtGroundFollowEntityDescriptor::nearCatchUpFactor

(

)

const [virtual]

Accessor/mutator for myNearCatchUpFactor.

virtual void DtGroundFollowEntityDescriptor::setNearCatchUpFactor

(

DtReal

nearCatchUpFactor

)

[virtual]

Accessor/mutator for myNearCatchUpFactor.

virtual DtReal DtGroundFollowEntityDescriptor::farCatchUpFactor

(

)

const [virtual]

Accessor/mutator for myFarCatchUpFactor.

virtual void DtGroundFollowEntityDescriptor::setFarCatchUpFactor

(

DtReal

farCatchUpFactor

)

[virtual]

Accessor/mutator for myFarCatchUpFactor.

virtual DtReal DtGroundFollowEntityDescriptor::passedSlowDownFactor

(

)

const [virtual]

Accessor/mutator for myPassedSlowDownFactor.

virtual void DtGroundFollowEntityDescriptor::setPassedSlowDownFactor

(

DtReal

passedSlowDownFactor

)

[virtual]

Accessor/mutator for myPassedSlowDownFactor.

virtual DtComponentDescriptor* DtGroundFollowEntityDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtGroundMoveToDescriptor.

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

---

Member Data Documentation

DtRwReal DtGroundFollowEntityDescriptor::myNearCatchUpFactor [protected]

Parameter Name: near-catch-up-factor
Parameter Description: The speed the entity uses to catch up to the followed entity if it is 'near', but not 'at' the point at which it is supposed to be relative to the followed entity.

Parameter Default Value: 1.1

DtRwReal DtGroundFollowEntityDescriptor::myFarCatchUpFactor [protected]

Parameter Name: far-catch-up-factor Parameter Description: The amount by which the ordered speed increases so that the entity can catch up to the followed entity if it is further away from the followed entity than the 'near' distance.

Parameter Default Value: 1.25

DtRwReal DtGroundFollowEntityDescriptor::myPassedSlowDownFactor [protected]

Parameter Name: passed-slow-down-factor
Parameter Description: Speed the entity is to use if it is closer to the followed entity than the specified following distance.

The default slowdown factor is 0.1 times the speed of the followed entity.
Parameter Default Value: 0.1

---

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

• include/vrfobjparam/gndFlwEntDesc.h