VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ~DtFormationQueryResult ()
 
virtual void setEntity (const DtUUID &entity)
 
virtual const DtUUIDentity () const
 
virtual void setPosition (const DtVector &position)
 
virtual const DtVectorposition () const
 
virtual void setLeadingEntity (const DtUUID &entity)
 
virtual const DtUUIDleadingEntity () const
 
virtual void setFollowOffset (const DtVector &followOffset)
 
virtual const DtVectorfollowOffset () const
 
virtual void setOffsetFromFormationLeader (const DtVector &formationOffset)
 
virtual const DtVectoroffsetFromFormationLeader () const
 
virtual void setFormationLeader (const DtUUID &leader)
 
virtual const DtUUIDformationLeader () const
 
virtual void setPositionIndex (int positionIndex)
 
virtual int positionIndex () const
 
virtual void setSubordinateFormation (const DtString &formationName)
 
virtual DtString subordinateFormation () const
 

Protected Attributes

DtUUID myEntity
 
DtVector myPosition
 
DtUUID myLeadingEntity
 
DtVector myFollowOffset
 
DtVector myFormationLeaderOffset
 
DtUUID myFormationLeader
 
int myPositionIndex
 
DtString mySubordinateFormation
 

Constructor & Destructor Documentation

DtFormationQueryResult::DtFormationQueryResult ( )
DtFormationQueryResult::DtFormationQueryResult ( const DtFormationQueryResult orig)
virtual DtFormationQueryResult::~DtFormationQueryResult ( )
virtual

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::setOffsetFromFormationLeader ( const DtVector formationOffset)
virtual

Offset relative to the formation leader, i.e. the one with the lowest position index in the formation state.

virtual const DtVector& DtFormationQueryResult::offsetFromFormationLeader ( ) const
virtual
virtual void DtFormationQueryResult::setFormationLeader ( const DtUUID leader)
virtual

The leader of the formation. Note that it is possible for none of the subordinates to have promotion ID 0 (e.g. that subordinate was destroyed and the unit has not reorganized), so this is not necessarily the subordinate with promotion ID 0.

virtual const DtUUID& DtFormationQueryResult::formationLeader ( ) 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

DtUUID DtFormationQueryResult::myEntity
protected
DtVector DtFormationQueryResult::myPosition
protected
DtUUID DtFormationQueryResult::myLeadingEntity
protected

Relative to unit.

DtVector DtFormationQueryResult::myFollowOffset
protected
DtVector DtFormationQueryResult::myFormationLeaderOffset
protected
DtUUID DtFormationQueryResult::myFormationLeader
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 Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)