formation.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2021 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include <readerWriter/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() override; 

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

   virtual void removeAndDeleteAll() override;

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

   virtual const DtFormationEntry* getFormationEntryForUnitIndex(int) const;

   virtual int promotionIdForIndex(const int index) const;

   virtual std::string subFormationForIndex(const int index) const;

   virtual std::list<DtVector> formationPositions(const int numPositions = 0, 
      int* leaderIndex = 0) const;

   virtual std::list<DtVector> formationPositionsFromUnit(const int numPositions = 0,
      int* leaderIndex = 0) const;

   typedef std::pair<DtVector, int> PositionData;

   virtual std::vector<PositionData> promotedPositions(const int numPositions = 0) const;

   virtual std::vector<PositionData> promotedPositionsFromUnit(const int numPositions = 0) const;

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

   virtual void addEntry(DtFormationEntry * entry);

   virtual DtFormationEntry* createAndAddFormationEntry();

   virtual bool isValid() const;

   virtual double standardSpacing() const;

protected:

   virtual void computeAndSetStandardSpacing();

   virtual DtVector newFormationEntryOffset(const DtVector& lastOffset) const;

   virtual void removeEntry(DtFormationEntry * entry);

   virtual void copyList(const DtFormation& orig);

   virtual void emptyList();

   virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;

protected:
   double myStandardSpacing;
};