DtFormationQueryResult Class Reference

Public Member Functions
	DtFormationQueryResult ()
	DtFormationQueryResult (const DtFormationQueryResult &orig)
DtFormationQueryResult &	operator= (const DtFormationQueryResult &orig)
virtual void	setEntity (const DtUUID &entity)
virtual const DtUUID &	entity () const
virtual void	setPosition (const DtVector &position)
	Position of entity in body coordinates of aggregate.
virtual const DtVector &	position () const
virtual void	setLeadingEntity (const DtUUID &entity)
	Entity this entity is 'following' in formation (may be an emtpy string, for overall leader in formation – the overall leader isn't following anyone).
virtual const DtUUID &	leadingEntity () const
virtual void	setFollowOffset (const DtVector &followOffset)
	Offset relative to leading entity, in body coordinates of leading entity.
virtual const DtVector &	followOffset () const
virtual void	setPositionIndex (int positionIndex)
virtual int	positionIndex () const
virtual void	setSubordinateFormation (const DtString &formationName)
	The name of the formation that a sub-aggregate in this formation position should assume.
virtual DtString	subordinateFormation () const

Protected Attributes
DtUUID	myEntity
DtVector	myPosition
DtUUID	myLeadingEntity
DtVector	myFollowOffset
int	myPositionIndex
DtString	mySubordinateFormation

Constructor & Destructor Documentation

DtFormationQueryResult::DtFormationQueryResult

(

)

DtFormationQueryResult::DtFormationQueryResult

(

const DtFormationQueryResult &

orig

)

Member Function Documentation

DtFormationQueryResult& DtFormationQueryResult::operator=

(

const DtFormationQueryResult &

orig

)

virtual void DtFormationQueryResult::setEntity ( const DtUUID &  entity )

virtual

virtual const DtUUID& DtFormationQueryResult::entity ( ) const

virtual

virtual void DtFormationQueryResult::setPosition ( const DtVector &  position )

virtual

Position of entity in body coordinates of aggregate.

virtual const DtVector& DtFormationQueryResult::position ( ) const

virtual

virtual void DtFormationQueryResult::setLeadingEntity ( const DtUUID &  entity )

virtual

Entity this entity is 'following' in formation (may be an emtpy string, for overall leader in formation – the overall leader isn't following anyone).

virtual const DtUUID& DtFormationQueryResult::leadingEntity ( ) const

virtual

virtual void DtFormationQueryResult::setFollowOffset ( const DtVector &  followOffset )

virtual

Offset relative to leading entity, in body coordinates of leading entity.

virtual const DtVector& DtFormationQueryResult::followOffset ( ) const

virtual

virtual void DtFormationQueryResult::setPositionIndex ( int  positionIndex )

virtual

virtual int DtFormationQueryResult::positionIndex ( ) const

virtual

virtual void DtFormationQueryResult::setSubordinateFormation ( const DtString &  formationName )

virtual

The name of the formation that a sub-aggregate in this formation position should assume.

virtual DtString DtFormationQueryResult::subordinateFormation ( ) const

virtual

Member Data Documentation

DtUUID DtFormationQueryResult::myEntity

protected

DtVector DtFormationQueryResult::myPosition

protected

DtUUID DtFormationQueryResult::myLeadingEntity

protected

DtVector DtFormationQueryResult::myFollowOffset

protected

int DtFormationQueryResult::myPositionIndex

protected

DtString DtFormationQueryResult::mySubordinateFormation

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/formationQueryResult.h