 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
Public Types | |
| enum | DtRotaryWingLandingControllerState { StateStartingLandingTask, StateMovingToLandingLocation, StateLanding } |
| State for the DtRotaryWingLandingController. More... | |
Public Member Functions | |
| DtRotaryWingFlightPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtRotaryWingFlightPSR (const DtRotaryWingFlightPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| virtual | ~DtRotaryWingFlightPSR () |
| destructor | |
| DtRotaryWingFlightPSR & | operator= (const DtRotaryWingFlightPSR &orig) |
| assignment operator | |
| virtual DtVrfProcessStateRepository * | clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const |
| returns a newly created copy of this object | |
| virtual DtString | type () const |
| Returns the string type of the repository, as defined in procSRTypes.h. | |
| virtual void | setControlObjectName (const DtString &objectName) |
| Get/set the name of the waypoint to move to. | |
| virtual const DtString & | controlObjectName () const |
| virtual void | setRouteName (const DtString &routeName) |
| Get/set the name of the route to follow. | |
| virtual const DtString & | routeName () const |
| virtual void | setRouteVertices (const DtLocalVectorIterator &routeIterator) |
| Set/get route vertices (local coordinates). | |
| virtual const DtLocalVertexList & | routeVertices () const |
| virtual void | emptyRouteVertices () |
| Empty route vertices. | |
| virtual DtLocalVectorIterator * | routeState () const |
| Get route state (an iterator over the route used to keep track of which point along the route we're heading toward). | |
| virtual void | setWasMovingToward (bool flag) |
| Get/set the flag indicating whether or not the last tick was moving. | |
| virtual bool | wasMovingToward () const |
| virtual void | setStartingPoint (const DtVector &startingPoint) |
| Get/set the starting point of the current segment of a route we're moving along. | |
| virtual const DtVector & | startingPoint () const |
| virtual void | setReverseFlag (bool flag) |
| Get/set the reverse patrol flag (along a route or between points). | |
| virtual bool | reverseFlag () const |
| virtual void | setWorldAimingPoint (const DtVector &pnt) |
| Get/set the point to which this entity is moving towards for a move to location task. | |
| virtual const DtVector & | worldAimingPoint () const |
| virtual void | setFirstWaypoint (const DtString &objectName) |
| Get/set the object name of the first waypoint we're patrolling between. | |
| virtual const DtString & | firstWaypoint () const |
| virtual void | setSecondWaypoint (const DtString &objectName) |
| Get/set the object name of the second waypoint we're patrolling between. | |
| virtual const DtString & | secondWaypoint () const |
| virtual void | setEntityToFollow (const DtString &objectName) |
| Get/set the object name of the entity to follow. | |
| virtual const DtString & | entityToFollow () const |
| virtual void | setFollowOffset (const DtVector &offset) |
| Get/set the following offset (in body coordinates of the entity to follow, in meters). | |
| virtual const DtVector & | followOffset () const |
| virtual void | setMovingToAltitude (bool movingToAlt) |
| Should be true when processing a move to altitude task. | |
| virtual bool | movingToAltitude () const |
| Should be true when processing a move to altitude task. | |
| virtual void | setMoveToAltitudeValue (double altitude) |
| Set the requested altitude from the move to altitude task. | |
| virtual double | moveToAltitudeValue () const |
| The requested altitude from the move to altitude task. | |
| virtual void | putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath()) |
| Override to set myCurrentVertex from route state before writing. | |
| virtual void | setLandingState (DtRotaryWingLandingControllerState state) |
| Accessor/Mutator for myLandingState. | |
| virtual DtRotaryWingLandingControllerState | landingState () const |
| Accessor/Mutator for myLandingState. | |
Static Public Member Functions | |
| static DtVrfProcessStateRepository * | creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry) |
| Returns a newly created instance of this class. | |
Protected Attributes | |
| DtRwString | myControlObjectName |
| Moved here from DtRotaryWingMoveToControllerComponent (rotWngMvToCtl.h). | |
| DtRwString | myRouteName |
| Moved here from DtRotaryWingMoveAlongControllerComponent (rotaryWingFlightPSR.h). | |
| DtLocalVectorIterator * | myRouteState |
| Route state used to get info about the current route we're trying to follow (e.g. | |
| DtLocalVertexList | myVertices |
| my copy of the current route | |
| DtRwInt | myCurrentVertex |
| Read/write variables to capture route state. | |
| DtRwBoolean | myWasMovingToward |
| A flag indicating whether or not the last tick was moving toward the current waypoint. | |
| DtRwVector | myStartingPoint |
| A vector indicating the starting point of the current segment. | |
| DtRwBoolean | myReverseFlag |
| Moved here from DtRotaryWingPatrolRouteController (rotWingPtrlRt.h). | |
| DtRwString | myFirstWaypoint |
| Moved here from DtRotaryWingPatrolBetweenController (rotWngPtlBtwn.h). | |
| DtRwString | mySecondWaypoint |
| DtRwString | myEntityToFollow |
| Set when a patrol between task is received. | |
| DtRwVector | myFollowOffsetVector |
| Following offset vector (in body coordinates of the entity to follow, in meters). | |
| DtRwVector | myWorldAimingPoint |
| World point for move to location tasks. | |
| DtRwBoolean | myMovingToAltitude |
| DtRwReal | myMoveToAltitudeValue |
| DtRwInt | myLandingState |
State for the DtRotaryWingLandingController.
| DtRotaryWingFlightPSR::DtRotaryWingFlightPSR | ( | DtVrfObject * | vrfObject, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtRotaryWingFlightPSR::DtRotaryWingFlightPSR | ( | const DtRotaryWingFlightPSR & | orig, |
| const DtString & | rwName = DtString::nullString(), |
||
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtRotaryWingFlightPSR::~DtRotaryWingFlightPSR | ( | ) | [virtual] |
destructor
| DtRotaryWingFlightPSR& DtRotaryWingFlightPSR::operator= | ( | const DtRotaryWingFlightPSR & | orig | ) |
assignment operator
| virtual DtVrfProcessStateRepository* DtRotaryWingFlightPSR::clone | ( | const DtString & | rwName = DtString::nullString(), |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) | const [virtual] |
returns a newly created copy of this object
Implements DtVrfProcessStateRepository.
| virtual DtString DtRotaryWingFlightPSR::type | ( | ) | const [virtual] |
Returns the string type of the repository, as defined in procSRTypes.h.
(DtVrfRotaryWingFlightProcessStateRepositoryType).
Implements DtVrfProcessStateRepository.
| virtual void DtRotaryWingFlightPSR::setControlObjectName | ( | const DtString & | objectName | ) | [virtual] |
Get/set the name of the waypoint to move to.
| virtual const DtString& DtRotaryWingFlightPSR::controlObjectName | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setRouteName | ( | const DtString & | routeName | ) | [virtual] |
Get/set the name of the route to follow.
| virtual const DtString& DtRotaryWingFlightPSR::routeName | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setRouteVertices | ( | const DtLocalVectorIterator & | routeIterator | ) | [virtual] |
Set/get route vertices (local coordinates).
Once route is set, can access routeState() to query and set current position along route.
| virtual const DtLocalVertexList& DtRotaryWingFlightPSR::routeVertices | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::emptyRouteVertices | ( | ) | [virtual] |
Empty route vertices.
| virtual DtLocalVectorIterator* DtRotaryWingFlightPSR::routeState | ( | ) | const [virtual] |
Get route state (an iterator over the route used to keep track of which point along the route we're heading toward).
| virtual void DtRotaryWingFlightPSR::setWasMovingToward | ( | bool | flag | ) | [virtual] |
Get/set the flag indicating whether or not the last tick was moving.
toward the current waypoint.
| virtual bool DtRotaryWingFlightPSR::wasMovingToward | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setStartingPoint | ( | const DtVector & | startingPoint | ) | [virtual] |
Get/set the starting point of the current segment of a route we're moving along.
| virtual const DtVector& DtRotaryWingFlightPSR::startingPoint | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setReverseFlag | ( | bool | flag | ) | [virtual] |
Get/set the reverse patrol flag (along a route or between points).
| virtual bool DtRotaryWingFlightPSR::reverseFlag | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setWorldAimingPoint | ( | const DtVector & | pnt | ) | [virtual] |
Get/set the point to which this entity is moving towards for a move to location task.
This point is only valid for that task and is set in world (geocentric) coordinates
| virtual const DtVector& DtRotaryWingFlightPSR::worldAimingPoint | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setFirstWaypoint | ( | const DtString & | objectName | ) | [virtual] |
Get/set the object name of the first waypoint we're patrolling between.
| virtual const DtString& DtRotaryWingFlightPSR::firstWaypoint | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setSecondWaypoint | ( | const DtString & | objectName | ) | [virtual] |
Get/set the object name of the second waypoint we're patrolling between.
| virtual const DtString& DtRotaryWingFlightPSR::secondWaypoint | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setEntityToFollow | ( | const DtString & | objectName | ) | [virtual] |
Get/set the object name of the entity to follow.
| virtual const DtString& DtRotaryWingFlightPSR::entityToFollow | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setFollowOffset | ( | const DtVector & | offset | ) | [virtual] |
Get/set the following offset (in body coordinates of the entity to follow, in meters).
| virtual const DtVector& DtRotaryWingFlightPSR::followOffset | ( | ) | const [virtual] |
| virtual void DtRotaryWingFlightPSR::setMovingToAltitude | ( | bool | movingToAlt | ) | [virtual] |
Should be true when processing a move to altitude task.
| virtual bool DtRotaryWingFlightPSR::movingToAltitude | ( | ) | const [virtual] |
Should be true when processing a move to altitude task.
| virtual void DtRotaryWingFlightPSR::setMoveToAltitudeValue | ( | double | altitude | ) | [virtual] |
Set the requested altitude from the move to altitude task.
| virtual double DtRotaryWingFlightPSR::moveToAltitudeValue | ( | ) | const [virtual] |
The requested altitude from the move to altitude task.
| virtual void DtRotaryWingFlightPSR::setLandingState | ( | DtRotaryWingLandingControllerState | state | ) | [virtual] |
Accessor/Mutator for myLandingState.
| virtual DtRotaryWingLandingControllerState DtRotaryWingFlightPSR::landingState | ( | ) | const [virtual] |
Accessor/Mutator for myLandingState.
| virtual void DtRotaryWingFlightPSR::putSelf | ( | FILE * | fp, |
| int | indentLevel = 0, |
||
| bool | writeUnspecified = false, |
||
| const DtFilename & | path = DtReaderWriter::appPath() |
||
| ) | [virtual] |
Override to set myCurrentVertex from route state before writing.
Reimplemented from DtReaderWriter.
| static DtVrfProcessStateRepository* DtRotaryWingFlightPSR::creator | ( | const DtString & | rwName, |
| DtVrfObject * | vrfObject, | ||
| DtReaderWriterRegistry * | parentRegistry | ||
| ) | [static] |
Returns a newly created instance of this class.
DtRwString DtRotaryWingFlightPSR::myControlObjectName [protected] |
Moved here from DtRotaryWingMoveToControllerComponent (rotWngMvToCtl.h).
If tasked() is true, this is the name of the control object we're moving to.
DtRwString DtRotaryWingFlightPSR::myRouteName [protected] |
Moved here from DtRotaryWingMoveAlongControllerComponent (rotaryWingFlightPSR.h).
If tasked() is true, this is the name of the control object we're moving to.
DtLocalVectorIterator* DtRotaryWingFlightPSR::myRouteState [protected] |
Route state used to get info about the current route we're trying to follow (e.g.
which vertex to move toward).
DtLocalVertexList DtRotaryWingFlightPSR::myVertices [protected] |
my copy of the current route
DtRwInt DtRotaryWingFlightPSR::myCurrentVertex [protected] |
Read/write variables to capture route state.
DtRwBoolean DtRotaryWingFlightPSR::myWasMovingToward [protected] |
A flag indicating whether or not the last tick was moving toward the current waypoint.
DtRwVector DtRotaryWingFlightPSR::myStartingPoint [protected] |
A vector indicating the starting point of the current segment.
DtRwBoolean DtRotaryWingFlightPSR::myReverseFlag [protected] |
Moved here from DtRotaryWingPatrolRouteController (rotWingPtrlRt.h).
DtRwString DtRotaryWingFlightPSR::myFirstWaypoint [protected] |
Moved here from DtRotaryWingPatrolBetweenController (rotWngPtlBtwn.h).
DtRwString DtRotaryWingFlightPSR::mySecondWaypoint [protected] |
DtRwString DtRotaryWingFlightPSR::myEntityToFollow [protected] |
Set when a patrol between task is received.
Reuse the myReverseFlag from DtRotaryWingPatrolRouteController. bool myReverseFlag; Moved here from DtRotaryWingFollowEntityController (rotWngFolwCtl.h)
Object name of an entity to follow.
Following offset vector (in body coordinates of the entity to follow, in meters).
DtRwVector DtRotaryWingFlightPSR::myWorldAimingPoint [protected] |
World point for move to location tasks.
DtRwBoolean DtRotaryWingFlightPSR::myMovingToAltitude [protected] |
DtRwReal DtRotaryWingFlightPSR::myMoveToAltitudeValue [protected] |
DtRwInt DtRotaryWingFlightPSR::myLandingState [protected] |