DtAggregatedMoveToDescriptor Class Reference

DtAggregatedMoveToDescriptor; descriptor for the DtAggregatedMoveToDescriptor component. More...

Inheritance diagram for DtAggregatedMoveToDescriptor:

List of all members.

Public Member Functions
	DtAggregatedMoveToDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=0)
	real constructor
	DtAggregatedMoveToDescriptor (const DtAggregatedMoveToDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtAggregatedMoveToDescriptor ()
DtAggregatedMoveToDescriptor &	operator= (const DtAggregatedMoveToDescriptor &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.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtAggregatedMoveToDescriptor ()
	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.

---

Detailed Description

DtAggregatedMoveToDescriptor; descriptor for the DtAggregatedMoveToDescriptor component.

Instances of DtAggregatedMoveToDescriptor are used to specify the parameters for a DtHumanMoveToController component.

---

Constructor & Destructor Documentation

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

real constructor

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

copy constructor

virtual DtAggregatedMoveToDescriptor::~DtAggregatedMoveToDescriptor

(

)

[virtual]

DtAggregatedMoveToDescriptor::DtAggregatedMoveToDescriptor

(

)

[protected]

default constructor; not implemented

---

Member Function Documentation

DtAggregatedMoveToDescriptor& DtAggregatedMoveToDescriptor::operator=

(

const DtAggregatedMoveToDescriptor &

orig

)

assignment

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

DtAggregatedMoveToDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtComponentDescriptor* DtAggregatedMoveToDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtAggregatedMoveToDescriptor::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 DtAggregatedMoveToDescriptor::atDistance

(

)

const [virtual]

Accessor/mutator for myAtDistance.

virtual void DtAggregatedMoveToDescriptor::setAtDistance

(

double

distance

)

[virtual]

Accessor/mutator for myAtDistance.

---

Member Data Documentation

DtRwReal DtAggregatedMoveToDescriptor::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

---

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

• include/vrfobjparam/aggregatedMoveToDescriptor.h