DtMoveToLocationTask Class Reference

DtMoveToLocationTask represents a moveToLocation task for an entity to perform. More...

Inheritance diagram for DtMoveToLocationTask:

List of all members.

Public Member Functions
	DtMoveToLocationTask ()
	default constructor
	DtMoveToLocationTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0)
	constructor If you have a task 'put' itself, the writeName will preface the task.
	DtMoveToLocationTask (const DtString &writeName, const DtMoveToLocationTask &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
const DtMoveToLocationTask &	operator= (const DtMoveToLocationTask &orig)
	assignment operator
virtual	~DtMoveToLocationTask ()
virtual int	type () const
	Returns "move-towards" DtMoveToLocationTaskType.
virtual DtSimTask *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
	Creates a copy of this movetoLocation task.
virtual DtString	stringRep () const
	Get a readable string representation of this task.
virtual const DtVector &	aimingPoint () const
	Set/get the point to move towards.
virtual void	setAimingPoint (const DtVector &point)
virtual void	setContinueFlag (bool flag)
	Give the user the option to not slow down on approach of the control point.
virtual bool	continueFlag () const
virtual int	netRepSize () const
	Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Fills in the task from the network buffer.
virtual bool	setToNet ()
	Fills in the network buffer (created by base class simTask) with the task contents.
Static Public Member Functions
static DtSimTask *	creator ()
Protected Attributes
DtRwVector	myAimingPoint
DtRwBoolean	myContinueFlag

---

Detailed Description

DtMoveToLocationTask represents a moveToLocation task for an entity to perform.

It inherits read/writableness from SimTask, and includes the aiming point to move towards.

---

Constructor & Destructor Documentation

DtMoveToLocationTask::DtMoveToLocationTask

(

)

default constructor

DtMoveToLocationTask::DtMoveToLocationTask	(	const DtString &	writeName,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor If you have a task 'put' itself, the writeName will preface the task.

DtMoveToLocationTask::DtMoveToLocationTask	(	const DtString &	writeName,
		const DtMoveToLocationTask &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtMoveToLocationTask::~DtMoveToLocationTask

(

)

[virtual]

---

Member Function Documentation

const DtMoveToLocationTask& DtMoveToLocationTask::operator=

(

const DtMoveToLocationTask &

orig

)

assignment operator

virtual int DtMoveToLocationTask::type

(

)

const [virtual]

Returns "move-towards" DtMoveToLocationTaskType.

Implements DtSimTask.

Reimplemented in DtPlanAndMoveToLocationTask.

virtual DtSimTask* DtMoveToLocationTask::clone	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Creates a copy of this movetoLocation task.

Implements DtSimTask.

Reimplemented in DtPlanAndMoveToLocationTask.

virtual DtString DtMoveToLocationTask::stringRep

(

)

const [virtual]

Get a readable string representation of this task.

Implements DtSimTask.

Reimplemented in DtPlanAndMoveToLocationTask.

virtual const DtVector& DtMoveToLocationTask::aimingPoint

(

)

const [virtual]

Set/get the point to move towards.

Specified in geocentric coordinates.

virtual void DtMoveToLocationTask::setAimingPoint

(

const DtVector &

point

)

[virtual]

virtual void DtMoveToLocationTask::setContinueFlag

(

bool

flag

)

[virtual]

Give the user the option to not slow down on approach of the control point.

This is useful when the user wants the entity to keep moving once it reaches the point, especially usefule when the move task is just a subtask of a more complex movement task.

virtual bool DtMoveToLocationTask::continueFlag

(

)

const [virtual]

virtual int DtMoveToLocationTask::netRepSize

(

)

const [virtual]

Returns the size of the full network representation (control object name included) padded to an 8-byte boundary.

Reimplemented from DtSimTask.

virtual bool DtMoveToLocationTask::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Fills in the task from the network buffer.

Reimplemented from DtSimTask.

virtual bool DtMoveToLocationTask::setToNet

(

)

[virtual]

Fills in the network buffer (created by base class simTask) with the task contents.

Reimplemented from DtSimTask.

static DtSimTask* DtMoveToLocationTask::creator

(

)

[static]

Reimplemented in DtPlanAndMoveToLocationTask.

---

Member Data Documentation

DtRwVector DtMoveToLocationTask::myAimingPoint [protected]

DtRwBoolean DtMoveToLocationTask::myContinueFlag [protected]

---

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

• include/vrftasks/moveToLocTask.h