DtEntityRouteFollowingData Class Reference

DtEntityRouteFollowingData is a utility class that holds information associated with an entity following a route. More...

Public Member Functions
	DtEntityRouteFollowingData ()
	default constructor More...
virtual	~DtEntityRouteFollowingData ()
	destructor More...
	DtEntityRouteFollowingData (const DtEntityRouteFollowingData &orig)
	copy constructor More...
DtEntityRouteFollowingData &	operator= (const DtEntityRouteFollowingData &orig)
	assignment operator More...
virtual void	setEntityPosition (const DtVector &position)
	geocentric position of a given entity More...
virtual const DtVector &	entityPosition () const
virtual void	setLeadEntityPosition (const DtVector &position)
	geocentric position of the entity the above entity is following More...
virtual const DtVector &	leadEntityPosition () const
virtual void	setEntityRoute (const DtVertexList *route)
	list of DtRwVector*s representing geocentric vertices along route More...
virtual const DtVertexList *	entityRoute () const
virtual void	setLeadEntityRoute (const DtVertexList *route)
	list of DtRwVector*s representing geocentric vertices along route More...
virtual const DtVertexList *	leadEntityRoute () const
virtual void	setFollowOffset (const DtVector &bodyFollowOffset)
	following offset of entity relative to lead entity (in lead entity's body coordinates) More...
virtual const DtVector &	followOffset () const
virtual void	setEntityLastWaypointIndex (int index)
	last point entity most recently achieved along its route More...
virtual int	entityLastWaypointIndex () const
virtual void	setLeadEntityLastWaypointIndex (int index)
	last point lead entity most recently achieved along its route More...
virtual int	leadEntityLastWaypointIndex () const
virtual void	setEntityTraversalDirection (DtIteratorDirection traversalDirection)
	direction of traversal of entity along its route More...
virtual DtIteratorDirection	entityTraversalDirection () const
virtual void	setLeadEntityTraversalDirection (DtIteratorDirection traversalDirection)
	direction of traversal of lead entity along its route More...
virtual DtIteratorDirection	leadEntityTraversalDirection () const

Protected Attributes
DtVector	myEntityPosition
DtVector	myLeadEntityPosition
const DtVertexList *	myEntityRoute
const DtVertexList *	myLeadEntityRoute
DtVector	myFollowOffset
int	myEntityLastWaypointIndex
int	myLeadEntityLastWaypointIndex
DtIteratorDirection	myEntityTraversalDirection
DtIteratorDirection	myLeadEntityTraversalDirection

Detailed Description

DtEntityRouteFollowingData is a utility class that holds information associated with an entity following a route.

Constructor & Destructor Documentation

DtEntityRouteFollowingData::DtEntityRouteFollowingData

(

)

default constructor

virtual DtEntityRouteFollowingData::~DtEntityRouteFollowingData ( )

virtual

destructor

DtEntityRouteFollowingData::DtEntityRouteFollowingData

(

const DtEntityRouteFollowingData &

orig

)

copy constructor

Member Function Documentation

DtEntityRouteFollowingData& DtEntityRouteFollowingData::operator=

(

const DtEntityRouteFollowingData &

orig

)

assignment operator

virtual void DtEntityRouteFollowingData::setEntityPosition ( const DtVector &  position )

virtual

geocentric position of a given entity

virtual const DtVector& DtEntityRouteFollowingData::entityPosition ( ) const

virtual

virtual void DtEntityRouteFollowingData::setLeadEntityPosition ( const DtVector &  position )

virtual

geocentric position of the entity the above entity is following

virtual const DtVector& DtEntityRouteFollowingData::leadEntityPosition ( ) const

virtual

virtual void DtEntityRouteFollowingData::setEntityRoute ( const DtVertexList *  route )

virtual

list of DtRwVector*s representing geocentric vertices along route

virtual const DtVertexList* DtEntityRouteFollowingData::entityRoute ( ) const

virtual

virtual void DtEntityRouteFollowingData::setLeadEntityRoute ( const DtVertexList *  route )

virtual

list of DtRwVector*s representing geocentric vertices along route

virtual const DtVertexList* DtEntityRouteFollowingData::leadEntityRoute ( ) const

virtual

virtual void DtEntityRouteFollowingData::setFollowOffset ( const DtVector &  bodyFollowOffset )

virtual

following offset of entity relative to lead entity (in lead entity's body coordinates)

virtual const DtVector& DtEntityRouteFollowingData::followOffset ( ) const

virtual

virtual void DtEntityRouteFollowingData::setEntityLastWaypointIndex ( int  index )

virtual

last point entity most recently achieved along its route

virtual int DtEntityRouteFollowingData::entityLastWaypointIndex ( ) const

virtual

virtual void DtEntityRouteFollowingData::setLeadEntityLastWaypointIndex ( int  index )

virtual

last point lead entity most recently achieved along its route

virtual int DtEntityRouteFollowingData::leadEntityLastWaypointIndex ( ) const

virtual

virtual void DtEntityRouteFollowingData::setEntityTraversalDirection ( DtIteratorDirection  traversalDirection )

virtual

direction of traversal of entity along its route

virtual DtIteratorDirection DtEntityRouteFollowingData::entityTraversalDirection ( ) const

virtual

virtual void DtEntityRouteFollowingData::setLeadEntityTraversalDirection ( DtIteratorDirection  traversalDirection )

virtual

direction of traversal of lead entity along its route

virtual DtIteratorDirection DtEntityRouteFollowingData::leadEntityTraversalDirection ( ) const

virtual

Member Data Documentation

DtVector DtEntityRouteFollowingData::myEntityPosition

protected

DtVector DtEntityRouteFollowingData::myLeadEntityPosition

protected

const DtVertexList* DtEntityRouteFollowingData::myEntityRoute

protected

const DtVertexList* DtEntityRouteFollowingData::myLeadEntityRoute

protected

DtVector DtEntityRouteFollowingData::myFollowOffset

protected

int DtEntityRouteFollowingData::myEntityLastWaypointIndex

protected

int DtEntityRouteFollowingData::myLeadEntityLastWaypointIndex

protected

DtIteratorDirection DtEntityRouteFollowingData::myEntityTraversalDirection

protected

DtIteratorDirection DtEntityRouteFollowingData::myLeadEntityTraversalDirection

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfmodel/entityRouteFollowingData.h