formationState.h

Go to the documentation of this file.

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



#pragma once

#include "vrfutil/formationRecord.h"
#include "vrfutil/formation.h"
#include "vrfutil/rwUUID.h"
#include <vlutil/vlString.h>
#include <vector>
#include <map>
#include "geometry/extent.h"

class DtFormationQueryResult;
class DtFormationState;
class DtFormationQueryResultList;

typedef void (*DtFormationStateCallbackFcn)(
   const DtFormationState& formationState, void* usr);

struct DtFormationStateCallbackInfo
{
   DtFormationStateCallbackFcn myCallbackFunction;
   void* myUserData;
};

class DT_DLL_vrfutil DtFormationState
{
public:

   DtFormationState();

   DtFormationState(const DtFormationState& orig);

   DtFormationState& operator=(const DtFormationState& orig);

   virtual ~DtFormationState();

   virtual bool isValid() const;

   virtual bool setFormation(const DtFormation& formation);

   virtual bool assignEntitiesToFormation(const std::vector<DtUUID> entityList,
      const std::vector<int> promotionIds);

   virtual void setEntityListAndFormation(const std::vector<DtUUID>& entityList,
      const DtFormation& formation, const std::vector<int>& promotionIds);

   virtual bool lookup(const DtUUID& subordinate, DtFormationQueryResult& result) const;

   virtual int lookupFormationPromotionIDByEntity(const DtUUID& subordinate) const;

   virtual void queryAll(DtFormationQueryResultList& resultList) const;

   virtual const std::vector<DtUUID> entityList() const;

   virtual DtUUID formationLeader() const; 

   virtual double formationHalfLength() const;

   virtual DtExtent formationBodyExtent() const;

   virtual void print() const;

   virtual void addFormationStateChangedCallback(
      DtFormationStateCallbackFcn fcn, void* userData);

   virtual void removeFormationStateChangedCallback(
      DtFormationStateCallbackFcn fcn, void* userData);

   virtual void enableFormationCallbacks();
   virtual void disableFormationCallbacks();

   virtual void clearEntityList();

   void markModified();
   void clearModified();
   bool isModified() const
   {
      return myModified;
   }

   virtual void invokeFormationStateChangedCallbacks() const;

protected:
   virtual const DtFormationRecord* lookupFormationRecord(int promotionId) const;

   virtual DtVector lookupFollowOffset(const DtUUID& subordinate) const;

   virtual DtUUID lookupLeaderOfEntity(const DtUUID& subordinate) const;

   virtual void rebuildEntityToPositionInUnitMap();

   virtual const DtFormationRecord* generateAdditionalFormationRecord(int promotionId) const;

   void emptyFormationIndexToFormationRecordMap();

   virtual void createFormationRecords(const DtFormation& formation);

   virtual void resetFormationMap();

protected:

   DtFormation myFormation;

   typedef std::shared_ptr<const DtFormationRecord> SharedFormationRecord;


   mutable std::map<int, SharedFormationRecord> myFormPromIdToFormationRecordMap;

   typedef struct
   {
      DtVector offsetFromFormationLeader;
      DtVector offsetFromUnitCenter;
   } DerivedOffsets;

   std::map<DtUUID, DerivedOffsets> myEntityToDerivedOffsetsMap;

   std::map<int, DtUUID> myFormPromIdToEntityMap;
   std::map<DtUUID, int> myEntityToFormPromIdMap;

   double myCurrentFormationSpacing;

   std::vector<DtFormationStateCallbackInfo> myFormationStateChangedCallbackList;

   bool myCallbacksAreEnabled;
   bool myModified = false;
};