ASR::ControlGroup Class Reference

#include <ControlGroup.h>

Collaboration diagram for ASR::ControlGroup:

[legend]List of all members.

Public Member Functions
	ControlGroup ()
	~ControlGroup ()
int	addUnit (Unit *unit)
void	removeUnit (size_t index)
void	removeUnit (Unit *unit)
int	getUnitIndex (Unit *unit)
size_t	getNumUnits ()
Unit *	getUnit (int index)
Unit *	getLeaderUnit ()
Vector3	getFormationCenter ()
Vector3	getUnitOffset (size_t index)
Vector3	getUnitOffset (Unit *unit)
Vector3	getUnitDestination (int index)
Vector3	getUnitDestination (Unit *unit)
void	setDestination (const Vector3 &dest)
void	update ()
	Recalculates information regarding unit position and orientation for the formation layout.
Protected Member Functions
void	_updateFormation ()
void	_calcCenter ()
void	_calcOrientation ()
	Determines the orientation of the group based on the center of the current positions and the destination.
Private Types
typedef vector< Unit * >	UnitList
Private Attributes
bool	mDirty
Formation *	mCurFormation
UnitList	mUnits
Vector3	mFormationCenter
Vector3	mDestination
Vector3	mForward
Vector3	mRight

---

Detailed Description

Definition at line 17 of file ControlGroup.h.

---

Member Typedef Documentation

typedef vector<Unit*> ASR::ControlGroup::UnitList [private]

Definition at line 25 of file ControlGroup.h.

---

Constructor & Destructor Documentation

ASR::ControlGroup::ControlGroup

(

)

Definition at line 17 of file ControlGroup.cpp.

References mCurFormation, mDirty, and mUnits.

                : mForward ( Vector3::ZERO ), mRight ( Vector3::ZERO )
        {
                mCurFormation = new LineFormation ();
                mUnits.clear ();
                mDirty = false;
        }

ASR::ControlGroup::~ControlGroup

(

)

Definition at line 27 of file ControlGroup.cpp.

References mCurFormation, and mUnits.

        {
                delete mCurFormation;
                mUnits.clear ();
        }

---

Member Function Documentation

void ASR::ControlGroup::_calcCenter

(

)

[protected]

Definition at line 92 of file ControlGroup.cpp.

References mFormationCenter, and mUnits.

Referenced by _updateFormation(), and update().

        {
                UnitList::iterator iter;
                Vector3 total = Vector3::ZERO;

                if ( mUnits.size () == 0 )
                        return;

                for ( iter = mUnits.begin(); iter != mUnits.end(); iter++ )
                {
                        total += Vector3( (*iter)->getPosition ().x, 0.0f, (*iter)->getPosition ().z );
                }

                mFormationCenter = total / mUnits.size();
        }

void ASR::ControlGroup::_calcOrientation

(

)

[protected]

Determines the orientation of the group based on the center of the current positions and the destination.

This assumes that the current center of formation is valid as well as having a valid destination.

Definition at line 221 of file ControlGroup.cpp.

References mDestination, mFormationCenter, mForward, and mRight.

Referenced by _updateFormation(), and update().

        {
                mForward = mDestination - mFormationCenter;
                mForward.normalise ();

                // X-axis heavy
                if ( Math::Abs(mForward.x) >= Math::Abs(mForward.z) )
                        mForward.y = mForward.z = 0.0f;
                // Z-axis heavy
                else
                        mForward.y = mForward.x = 0.0f;

                mForward.normalise ();
        
                mRight = mForward.crossProduct ( -Vector3::UNIT_Y );
                mRight.normalise ();
        }

void ASR::ControlGroup::_updateFormation

(

)

[protected]

Definition at line 82 of file ControlGroup.cpp.

References _calcCenter(), _calcOrientation(), and mDirty.

Referenced by getFormationCenter(), and getUnitDestination().

        {
                _calcCenter ();
                _calcOrientation ();

                mDirty = false;
        }

int ASR::ControlGroup::addUnit

(

Unit *

unit

)

Definition at line 35 of file ControlGroup.cpp.

References mDirty, and mUnits.

Referenced by ASR::UnitSelecter::_createActiveGroup().

        {
                mUnits.push_back ( unit );
                mDirty = true;
                return mUnits.size() - 1;
        }

Vector3 ASR::ControlGroup::getFormationCenter

(

)

Definition at line 72 of file ControlGroup.cpp.

References _updateFormation(), mDirty, and mFormationCenter.

Referenced by getUnitOffset().

        {
                if ( mDirty )
                        _updateFormation ();

                return mFormationCenter;
        }

Unit * ASR::ControlGroup::getLeaderUnit

(

)

Definition at line 154 of file ControlGroup.cpp.

References mUnits.

Referenced by ASR::UnitSelecter::_moveUnits().

        {
                assert ( !mUnits.empty() );
                return mUnits[0];
        }

size_t ASR::ControlGroup::getNumUnits

(

)

Definition at line 214 of file ControlGroup.cpp.

References mUnits.

Referenced by ASR::UnitSelecter::_moveUnits(), ASR::UnitSelecter::_unselectCurrect(), and ASR::UnitSelecter::_unselectDeadUnits().

        {
                return mUnits.size();
        }

Unit * ASR::ControlGroup::getUnit

(

int

index

)

Definition at line 206 of file ControlGroup.cpp.

References mUnits.

Referenced by ASR::UnitSelecter::_unselectCurrect(), and ASR::UnitSelecter::_unselectDeadUnits().

        {
                OgreAssert ( index < mUnits.size (), "Unit index out of bounds" );
                return mUnits[index];
        }

Vector3 ASR::ControlGroup::getUnitDestination

(

Unit *

unit

)

Definition at line 162 of file ControlGroup.cpp.

References _updateFormation(), getUnitDestination(), getUnitIndex(), and mDirty.

        {
                if ( mDirty )
                        _updateFormation ();

                int index = getUnitIndex ( unit );

                return getUnitDestination ( index );
        }

Vector3 ASR::ControlGroup::getUnitDestination

(

int

index

)

Definition at line 174 of file ControlGroup.cpp.

References mDestination, mForward, mRight, and mUnits.

Referenced by getUnitDestination().

        {
                OgreAssert ( index < mUnits.size (), "Unit index out of bounds" );

                //update ();

                // TODO
                //              Ask the Formation for the offset
                //              Currently just returning a huge line
                int xPos;
                if ( (index % 5) % 2 == 0 )
                        xPos = (index % 5) / 2;
                else
                        xPos = -( (index % 5) + 1 ) / 2;

                int zPos;
                zPos = -(index / 5);

                // TODO
                //              Take the orientation of the ControlGroup into account
                //              Use the "right" vector as well as the negated "forward"
                //              vector (mOrientation)
                //              Possibly snap to 90° rotations ala Starcraft
                Vector3 xOffset = mRight * 30;
                Vector3 zOffset = mForward * 30;

                Vector3 localPos = mDestination + ( xOffset * xPos ) + ( zOffset * zPos );
                return localPos;
        }

int ASR::ControlGroup::getUnitIndex

(

Unit *

unit

)

Definition at line 130 of file ControlGroup.cpp.

References mUnits.

Referenced by getUnitDestination(), and getUnitOffset().

        {
                for ( size_t i = 0; i < mUnits.size(); i++ )
                {
                        if ( mUnits[i] == unit )
                                return i;
                }

                throw Exception ( Exception::ERR_ITEM_NOT_FOUND, "Unit not found", "ControlGroup::getUnitIndex" );
        }

Vector3 ASR::ControlGroup::getUnitOffset

(

Unit *

unit

)

Definition at line 110 of file ControlGroup.cpp.

References getFormationCenter(), and getUnitIndex().

        {
                int index = getUnitIndex ( unit );

                // TODO
                //              Ask the Formation for the offset
                //              Currently just returning a huge line
                int position;
                if ( index % 2 == 0 )
                        position = index / 2;
                else
                        int position = -( index + 1 ) / 2;

                Vector3 singleOffset ( 0, 0, 10 );
                Vector3 localPos = getFormationCenter () + ( singleOffset * position );
                return localPos;
        }

Vector3 ASR::ControlGroup::getUnitOffset

(

size_t

index

)

void ASR::ControlGroup::removeUnit

(

Unit *

unit

)

Definition at line 60 of file ControlGroup.cpp.

References mDirty, and mUnits.

        {
                UnitList::iterator iter = find ( mUnits.begin(), mUnits.end(), unit );
                if ( iter == mUnits.end () )
                        throw Exception ( Exception::ERR_ITEM_NOT_FOUND, "Unit not found", "ControlGroup::removeUnit" );

                mUnits.erase ( iter );
                mDirty = true;
        }

void ASR::ControlGroup::removeUnit

(

size_t

index

)

Definition at line 44 of file ControlGroup.cpp.

References mDirty, and mUnits.

Referenced by ASR::UnitSelecter::_unselectDeadUnits().

        {
                assert ( index < mUnits.size() && index <= 0 );
                UnitList::iterator iter = mUnits.begin();
                
                for ( size_t i = 0; i < index; i++ )
                {
                        iter++;
                }

                mUnits.erase ( iter );
                mDirty = true;
        }

void ASR::ControlGroup::setDestination

(

const Vector3 &

dest

)

Definition at line 143 of file ControlGroup.cpp.

References mDestination.

Referenced by ASR::UnitSelecter::_moveUnits().

        {
                // TODO
                //      Figure out a path for each and every unit in this list
                //      using their offsets. We just move each unit as close
                //      to where it is supposed to be as possible
                mDestination = dest;
        }

void ASR::ControlGroup::update

(

)

Recalculates information regarding unit position and orientation for the formation layout.

This doesn't actually change the units positioning but does setup the ControlGroup to allow for proper calculation of the orientation and center of formation values.

Definition at line 241 of file ControlGroup.cpp.

References _calcCenter(), and _calcOrientation().

        {
                _calcCenter ();
                _calcOrientation ();
        }

---

Member Data Documentation

Formation* ASR::ControlGroup::mCurFormation [private]

Definition at line 23 of file ControlGroup.h.

Referenced by ControlGroup(), and ~ControlGroup().

Vector3 ASR::ControlGroup::mDestination [private]

Definition at line 29 of file ControlGroup.h.

Referenced by _calcOrientation(), getUnitDestination(), and setDestination().

bool ASR::ControlGroup::mDirty [private]

Definition at line 22 of file ControlGroup.h.

Referenced by _updateFormation(), addUnit(), ControlGroup(), getFormationCenter(), getUnitDestination(), and removeUnit().

Vector3 ASR::ControlGroup::mFormationCenter [private]

Definition at line 28 of file ControlGroup.h.

Referenced by _calcCenter(), _calcOrientation(), and getFormationCenter().

Vector3 ASR::ControlGroup::mForward [private]

Definition at line 31 of file ControlGroup.h.

Referenced by _calcOrientation(), and getUnitDestination().

Vector3 ASR::ControlGroup::mRight [private]

Definition at line 32 of file ControlGroup.h.

Referenced by _calcOrientation(), and getUnitDestination().

UnitList ASR::ControlGroup::mUnits [private]

Definition at line 26 of file ControlGroup.h.

Referenced by _calcCenter(), addUnit(), ControlGroup(), getLeaderUnit(), getNumUnits(), getUnit(), getUnitDestination(), getUnitIndex(), removeUnit(), and ~ControlGroup().

---

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

• D:/simple_rts/include/ControlGroup.h
• D:/simple_rts/src/ControlGroup.cpp

---