include/vrfobjcore/formationState.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: formationState.h,v $ $Revision: 1.23 $ $State: Exp $
*******************************************************************************/


#ifndef DtFormationState_H_
#define DtFormationState_H_

#include "vrfobjcore/formationRecord.h"
#include <vlutil/vlString.h>
#include <vector>
#include <map>
#include "vrfobjcore/orgViewManagedObjList.h"

class DtFormation;
class DtFormationRecord;
class DtFormationQueryResult;
class DtFormationState;
class DtVrfObject;
class DtFormationQueryResultList;

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

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

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtFormationState
{
public:
   
   DtFormationState();

   DtFormationState(const DtFormationState& orig);
   
   DtFormationState& operator=(const DtFormationState& orig);
   
   virtual ~DtFormationState();

   virtual void setFormation(const DtFormation& formation);
   virtual void setFormation(const std::vector<DtFormationRecord*>& formation);

   virtual void addFormationRecord(const DtFormationRecord& formationRecord,
      int positionIndex);

   virtual void removeFormationRecord(int positionIndex);
      
   virtual void setEntityList(const std::vector<DtString>& entityList);

   virtual void setEntityListAndFormation(const std::vector<DtString>& entityList,
      const DtFormation& formation, const std::list<int>& formationPositions);

   virtual void setEntityListAndFormation(DtOrgViewManagedObjectListConstPtr entityList,
      const DtFormation& formation, const std::list<int>& formationPositions);

   virtual const std::vector<DtString>& entityList() const;

   virtual void clearEntityList();
   
   virtual bool lookup(const DtString& objectName, DtFormationQueryResult& result);

   virtual int lookupPromotionIndexByName(const DtString& objectName) const;

   virtual void queryAll(DtFormationQueryResultList& resultList);

   virtual DtString formationLeader() const;

   virtual double formationHalfLength() const;

   virtual void print();

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

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

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

   virtual bool isAvailableForFormation(const DtVrfObject*) const;

protected:

   virtual DtFormationRecord* lookupFormationRecord(int positionIndex);

   virtual DtVector lookupFollowOffset(const DtString& entity);

   virtual DtString lookupLeader(const DtString& entity);

   virtual void rebuildEntityToPositionMap();

   virtual DtFormationRecord* generateAdditionalFormationRecord(int positionIndex) const;

   void emptyPositionIndexToFormationRecordMap();

   virtual DtVector positionOffsetForPositionIndex(int positionIndex);

   virtual void invokeFormationStateChangedCallbacks() const;

protected:

   std::vector<DtString> myEntityList;
   std::map<int, DtFormationRecord*> myPositionIndexToFormationRecordMap;
   std::map<DtString, DtVector> myEntityToPositionMap;
   std::map<int, DtString> myPositionIndexToEntityMap;
   std::map<DtString, int> myEntityToPositionIndexMap;
   std::vector<DtFormationStateCallbackInfo> myFormationStateChangedCallbackList;

   bool myCallbacksAreEnabled;
};

#endif