VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Attributes
DtFormationQueryResult Class Reference

Public Member Functions

 DtFormationQueryResult ()
 DtFormationQueryResult (const DtFormationQueryResult &orig)
DtFormationQueryResultoperator= (const DtFormationQueryResult &orig)
virtual void setEntity (const DtString &entity)
virtual const DtStringentity () const
virtual void setPosition (const DtVector &position)
 Position of entity in body coordinates of aggregate.
virtual const DtVectorposition () const
virtual void setLeadingEntity (const DtString &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 DtStringleadingEntity () const
virtual void setFollowOffset (const DtVector &followOffset)
 Offset relative to leading entity, in body coordinates of leading entity.
virtual const DtVectorfollowOffset () 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
 The name of the formation that a sub-aggregate in this formation position should assume.

Protected Attributes

DtString myEntity
DtVector myPosition
DtString 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 DtString entity)
virtual
virtual const DtString& 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 DtString 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 DtString& 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

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

Member Data Documentation

DtString DtFormationQueryResult::myEntity
protected
DtVector DtFormationQueryResult::myPosition
protected
DtString 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:

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)