 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
File: railPathTask.h. More...
Public Member Functions | |
| DtRailPathTask () | |
| default constructor | |
| DtRailPathTask (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor If you have a task 'put' itself, the writeName will preface the task. | |
| DtRailPathTask (const DtString &writeName, const DtRailPathTask &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| const DtRailPathTask & | operator= (const DtRailPathTask &orig) |
| assignment operator | |
| virtual | ~DtRailPathTask () |
| virtual int | type () const |
| Returns "rail-path-task". | |
| virtual DtSimTask * | clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const |
| Creates a copy of this task. | |
| virtual DtString | stringRep () const |
| Get a readable string representation of this task. | |
| virtual void | setDestinationNameSpecified (bool specified) |
| virtual bool | destinationNameSpecified () const |
| virtual void | setDestinationName (const DtString &name) |
| virtual const DtString & | destinationName () const |
| virtual void | setDestination (const DtVector &destination) |
| virtual const DtVector & | destination () const |
| virtual void | setDestinationIsRoute (bool route) |
| virtual bool | destinationIsRoute () const |
| 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 in bytes of the network representation of the class. | |
| virtual bool | setFromNet (const char *contentBuffer, unsigned contentSize) |
| Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask). | |
| virtual bool | setToNet () |
| Calls netRep() to create the network buffer. | |
Static Public Member Functions | |
| static DtSimTask * | creator () |
Protected Attributes | |
| DtRwString | myDestinationObjectName |
| DtRwBoolean | myDestinationNameSpecified |
| DtRwVector | myDestination |
| DtRwBoolean | myDestinationIsRoute |
| DtRwInt | myTraversalDirection |
| DtRwBoolean | myStartAtClosestPoint |
File: railPathTask.h.
Class: DtRailPathTask DtRailPathTask represents a railPath task for an entity to perform. It inherits DtPathTask and has all the same parameters as that task.
This task can be used by any vehicle having a rail path planning controller. It indicates that the vehicle should plan a path to the specified object, and then move along that path to the object. The entity while on the path will switch to the rails movement system which locks the entity on to the path and optionally provide smooth turning around corners.
task-type: DtRailPathType
parameters: control point name - The string name of the control point to move toward. You can look up the DtVrfObject corresponding to this name in the Object Manager.
default constructor
| DtRailPathTask::DtRailPathTask | ( | const DtString & | writeName, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor If you have a task 'put' itself, the writeName will preface the task.
| DtRailPathTask::DtRailPathTask | ( | const DtString & | writeName, |
| const DtRailPathTask & | orig, | ||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtRailPathTask::~DtRailPathTask | ( | ) | [virtual] |
| const DtRailPathTask& DtRailPathTask::operator= | ( | const DtRailPathTask & | orig | ) |
assignment operator
| virtual int DtRailPathTask::type | ( | ) | const [virtual] |
Returns "rail-path-task".
Implements DtSimTask.
| virtual DtSimTask* DtRailPathTask::clone | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
Creates a copy of this task.
Implements DtSimTask.
| virtual DtString DtRailPathTask::stringRep | ( | ) | const [virtual] |
Get a readable string representation of this task.
Implements DtSimTask.
| virtual void DtRailPathTask::setDestinationNameSpecified | ( | bool | specified | ) | [virtual] |
| virtual bool DtRailPathTask::destinationNameSpecified | ( | ) | const [virtual] |
| virtual void DtRailPathTask::setDestinationName | ( | const DtString & | name | ) | [virtual] |
| virtual const DtString& DtRailPathTask::destinationName | ( | ) | const [virtual] |
| virtual void DtRailPathTask::setDestination | ( | const DtVector & | destination | ) | [virtual] |
| virtual const DtVector& DtRailPathTask::destination | ( | ) | const [virtual] |
| virtual void DtRailPathTask::setDestinationIsRoute | ( | bool | route | ) | [virtual] |
| virtual bool DtRailPathTask::destinationIsRoute | ( | ) | const [virtual] |
| virtual void DtRailPathTask::setTraversalDirection | ( | DtIteratorDirection | traversalDirection | ) | [virtual] |
[DtIteratorDirection::DtForward, DtIteratorDirection::DtReverse] By default, traversalDirection is false.
| virtual DtIteratorDirection DtRailPathTask::traversalDirection | ( | ) | const [virtual] |
| virtual void DtRailPathTask::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 DtRailPathTask::startAtClosestPoint | ( | ) | const [virtual] |
| virtual int DtRailPathTask::netRepSize | ( | ) | const [virtual] |
Returns the size in bytes of the network representation of the class.
This is the size in bytes of the DtNetSimTask structure. Derived classes should take into acount the size returned by this class when overriding (they should call down to this class and add the result to their additional size).
Reimplemented from DtSimTask.
| virtual bool DtRailPathTask::setFromNet | ( | const char * | contentBuffer, |
| unsigned | contentSize | ||
| ) | [virtual] |
Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask).
Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().
Reimplemented from DtSimTask.
| virtual bool DtRailPathTask::setToNet | ( | ) | [virtual] |
Calls netRep() to create the network buffer.
Casts the resulting myNetRep to type DtNetSimTask*, and then sets the mySubtask member in the DtNetSimTask from mySubtask. Derived classes should call down to the base class version of setToNet() at the start of the function (before doing any processing on the network representation) They can then start to fill in their network data, starting at the location myNetRep + DtSimTask::netRepSize().
Reimplemented from DtSimTask.
| static DtSimTask* DtRailPathTask::creator | ( | ) | [static] |
DtRwString DtRailPathTask::myDestinationObjectName [protected] |
DtRwVector DtRailPathTask::myDestination [protected] |
DtRwBoolean DtRailPathTask::myDestinationIsRoute [protected] |
DtRwInt DtRailPathTask::myTraversalDirection [protected] |
DtRwBoolean DtRailPathTask::myStartAtClosestPoint [protected] |