include/vrfutil/formation.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: formation.h,v $ $Revision: 1.7 $ $State: Exp $
*******************************************************************************/



#ifndef DtFormation_H_
#define DtFormation_H_

#include "vrfutil/rwList.h"
#include <list>
#include <matrix/vlVector.h>

class DtFormationEntry;

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtFormation : public DtRwList
{
public:

   DtFormation();

   DtFormation(const DtString& name, DtReaderWriterRegistry* const 
      parentRegistry = 0);

   DtFormation(const DtFormation& orig);

   DtFormation& operator=(const DtFormation& orig);

   virtual ~DtFormation();

   virtual void addPosition(int promotionId, int leaderPromotionId, 
      const DtVector& positionOffset);

   virtual void removeAndDeleteAll();

   virtual const DtFormationEntry* getFormationEntryForPromotionId(int) const;
   virtual DtFormationEntry* getFormationEntryForPromotionId(int);

   virtual std::list<DtVector> formationPositions(int numEntitiesInFormation) const;

   bool operator==(const DtFormation&) const;
   bool operator!=(const DtFormation&) const;

   virtual void addEntry(DtFormationEntry * entry);

   virtual DtFormationEntry* createAndAddFormationEntry();

protected:

   virtual DtVector newFormationEntryOffset() const;

   virtual void removeEntry(DtFormationEntry * entry);

   virtual void copyList(const DtFormation& orig);

   virtual void emptyList();

   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);
};

#endif