DtFormationRecord is a structure with the same information as a DtFormationEntry (an element of a DtFormation list) but used within the DtFormationState that is maintained as part of aggregate state.

Public Member Functions
	DtFormationRecord ()

	DtFormationRecord (const DtFormationRecord &orig)

DtFormationRecord &	operator= (const DtFormationRecord &orig)

virtual DtFormationRecord *	clone () const

virtual void	setPositionIndex (int index)

virtual int	positionIndex () const

virtual void	setLeadingPositionIndex (int index)

virtual int	leadingPositionIndex () const

virtual void	setPositionRelativeToLeader (const DtVector &position)

virtual const DtVector &	positionRelativeToLeader () const

virtual void	setSubordinateFormation (const DtString &formationName)

virtual DtString	subordinateFormation () const

Protected Attributes
int	myFormationPromotionId

int	myLeaderPromotionId

DtVector	myPositionRelativeToLeader

DtString	mySubordinateFormation

Constructor & Destructor Documentation

DtFormationRecord::DtFormationRecord ( )

DtFormationRecord::DtFormationRecord ( const DtFormationRecord & orig )

Member Function Documentation

DtFormationRecord& DtFormationRecord::operator= ( const DtFormationRecord & orig )

virtual DtFormationRecord* DtFormationRecord::clone ( ) const

virtual

derived classes must implement a clone member function

virtual void DtFormationRecord::setPositionIndex ( int index )

virtual

virtual int DtFormationRecord::positionIndex ( ) const

virtual

virtual void DtFormationRecord::setLeadingPositionIndex ( int index )

virtual

Formation promotion ID of the formation slot that leads this one.

virtual int DtFormationRecord::leadingPositionIndex ( ) const

virtual

virtual void DtFormationRecord::setPositionRelativeToLeader ( const DtVector & position )

virtual

Offset position to leader in body coordinates (and relative to heading of the unit).

virtual const DtVector& DtFormationRecord::positionRelativeToLeader ( ) const

virtual

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

virtual

virtual DtString DtFormationRecord::subordinateFormation ( ) const

virtual

int DtFormationRecord::myFormationPromotionId

protected

int DtFormationRecord::myLeaderPromotionId

protected

DtVector DtFormationRecord::myPositionRelativeToLeader

protected

DtString DtFormationRecord::mySubordinateFormation

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfutil/formationRecord.h