 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
DtFlyAlongTask represents a Fly Along Route task for an entity to perform. More...
Public Member Functions | |
| DtFlyAlongTask () | |
| default constructor | |
| DtFlyAlongTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtFlyAlongTask (const DtString &writeName, const DtFlyAlongTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtFlyAlongTask & | operator= (const DtFlyAlongTask &orig) |
| assignment operator | |
| virtual | ~DtFlyAlongTask () |
| virtual int | type () const |
| Returns "move-along". | |
| virtual DtSimTask * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of this move-along task. | |
| virtual DtString | stringRep () const |
| Get a readable string representation of this task. | |
| virtual const DtString & | routeName () const |
| The string name of the route to be followed. | |
| virtual void | setRouteName (const DtString &rteName) |
| virtual void | setTraversalDirection (DtIteratorDirection traversalDirection) |
| [DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false. | |
| virtual DtIteratorDirection | traversalDirection () const |
| virtual void | setStartAtClosestPoint (bool startAtClosestPoint) |
| Flag indicating whether traversal should start at the beginning of route or at the closest point (which may be somewhere along the route). | |
| virtual bool | startAtClosestPoint () 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 void | setUseFixedPitch (bool) |
| virtual bool | useFixedPitch () const |
| 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 | |
| DtRwString | myRouteName |
| DtRwInt | myTraversalDirection |
| DtRwBoolean | myStartAtClosestPoint |
| DtRwBoolean | myUseFixedPitch |
DtFlyAlongTask represents a Fly Along Route task for an entity to perform.
It inherits read/writableness from SimTask, and includes the control point to move to. The string name of the route is specified as a parameter of the task. The route name refers to a DtRoute object. A route is a control object that contains an ordered list of vertices that represent a path for the entity to follow. Entities that implement this task move to the first vertex, then move successively from one vertex to the next. The task is considered complete when the entity reaches the last vertex in the route.
Only fixed wing pilots implement this task
task-type: DtFlyAlongType
parameters: route name - The string name of the route to be followed. To find the DtRoute object to which the name refers look up the name in the Object Manager.
If myUseFixedPitch is true, the controller will will using fixed pitch rather than the normal move along behavior
default constructor
| DtFlyAlongTask::DtFlyAlongTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtFlyAlongTask::DtFlyAlongTask | ( | const DtString & | writeName, |
| const DtFlyAlongTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtFlyAlongTask::~DtFlyAlongTask | ( | ) | [virtual] |
| const DtFlyAlongTask& DtFlyAlongTask::operator= | ( | const DtFlyAlongTask & | orig | ) |
assignment operator
| virtual int DtFlyAlongTask::type | ( | ) | const [virtual] |
Returns "move-along".
Implements DtSimTask.
| virtual DtSimTask* DtFlyAlongTask::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
Creates a copy of this move-along task.
Implements DtSimTask.
| virtual DtString DtFlyAlongTask::stringRep | ( | ) | const [virtual] |
Get a readable string representation of this task.
Implements DtSimTask.
| virtual const DtString& DtFlyAlongTask::routeName | ( | ) | const [virtual] |
The string name of the route to be followed.
| virtual void DtFlyAlongTask::setRouteName | ( | const DtString & | rteName | ) | [virtual] |
| virtual void DtFlyAlongTask::setTraversalDirection | ( | DtIteratorDirection | traversalDirection | ) | [virtual] |
[DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false.
| virtual DtIteratorDirection DtFlyAlongTask::traversalDirection | ( | ) | const [virtual] |
| virtual void DtFlyAlongTask::setStartAtClosestPoint | ( | bool | startAtClosestPoint | ) | [virtual] |
Flag indicating whether traversal should start at the beginning of route or at the closest point (which may be somewhere along the route).
Beginning is either 1st or last vertex, depending on traversal direction. By default, startAtClosestPoint is false.
| virtual bool DtFlyAlongTask::startAtClosestPoint | ( | ) | const [virtual] |
| virtual int DtFlyAlongTask::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 DtFlyAlongTask::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Fills in the task from the network buffer.
Reimplemented from DtSimTask.
| virtual void DtFlyAlongTask::setUseFixedPitch | ( | bool | ) | [virtual] |
| virtual bool DtFlyAlongTask::useFixedPitch | ( | ) | const [virtual] |
| virtual bool DtFlyAlongTask::setToNet | ( | ) | [virtual] |
Fills in the network buffer (created by base class simTask) with the task contents.
Reimplemented from DtSimTask.
| static DtSimTask* DtFlyAlongTask::creator | ( | ) | [static] |
DtRwString DtFlyAlongTask::myRouteName [protected] |
DtRwInt DtFlyAlongTask::myTraversalDirection [protected] |
DtRwBoolean DtFlyAlongTask::myStartAtClosestPoint [protected] |
DtRwBoolean DtFlyAlongTask::myUseFixedPitch [protected] |