vrfNavAreaManager.h

Go to the documentation of this file.

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



#pragma once

#include <vector>
#include <map>

#include <matrix/vlVector.h>
#include <readerWriter/noArgumentCallbackList.h>
#include <vrfobjcore/vrfObjectReference.h>

class DtTerrainInterface;
class DtSimManager;
class DtVrfObject;
class DtLocalVertexList;
class DtNavArea;
class DtSimMessage;
class Coordinate_System;
class DtUUID;
class DtNavGenerationThreadCounter;

namespace makArchives
{
   class DtGenericTerrainRecord;
}

typedef void (*DtNavAreaRemovalCallbackFcn)(DtNavArea* area,
   void* usr);

#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtVrfNavAreaManager
{
public:
   
   DtVrfNavAreaManager(DtSimManager* manager);

   virtual ~DtVrfNavAreaManager();

   static void tickCallback(void* args);

   //Register callback on DtIfRequestNavAreaDebugPorts messages.
   virtual bool init();

   virtual void tick();

   virtual void setTerrainInterface(DtTerrainInterface* terrainInterface);

   static void genericRecordLoadedCallback(
      makArchives::DtGenericTerrainRecord* record, void *user);
   virtual void processGenericRecordLoaded(
      makArchives::DtGenericTerrainRecord* record);

   void loadObjectNavData(DtVrfObject* simObject);
   void removeObjectNavData(DtVrfObject* simObject);
   DtNavArea* areaForObject(const DtVrfObject* simObject) const;

   virtual void unloadAllNavData();

   virtual DtNavArea* findNavAreaForLocation(const DtVector& localPosition, const DtString& profile,
      DtSharedVrfObjectReference parentObject = DtSharedVrfObjectReference()) const;
   virtual std::vector<DtNavArea*> findNavAreasForLocation(const DtVector& localPosition, const DtString& profile,
      DtSharedVrfObjectReference parentObject = DtSharedVrfObjectReference()) const;
   virtual DtNavArea* findNavAreaForArea(const DtLocalVertexList* area, const DtString& profile,
      DtSharedVrfObjectReference parentObject = DtSharedVrfObjectReference()) const;

   virtual void addNavAreaAboutToBeRemovedCallback(
      DtNavAreaRemovalCallbackFcn fcn, void* usrData) const;

   virtual void removeNavAreaAboutToBeRemovedCallback(
      DtNavAreaRemovalCallbackFcn fcn, void* usrData) const;

   //If navArea debugging is on, send debug info for all navAreas.
   static void requestNavAreaStatusCallback(DtSimMessage*, void* usr);
   virtual void processRequestNavAreaStatus();

   static void requestSimObjectDebugPortsCallback(DtSimMessage* msg, void* usr);
   virtual void processRequestSimObjectDebugPortsCallback(DtUUID uuid);

   virtual void sendNavDataStatus();

   static void setGamewareWorkingMemorySize(int sizeInMb);
   static void setRegenerateNavigationDataAtRuntime(bool regen);
   static void setMaxRegenerationThreads(int threads);
   static void setRegenerationDelay(double delay);
   static void setQueryTimeBudget(double ms);

protected:

   static void objectAboutToBeRemovedCallback(const DtVrfObject* simObject, void* userData);
   virtual void processObjectAboutToBeRemoved(const DtVrfObject* simObject);

   virtual void invokeAreaAboutToBeDeletedCallbacks(DtNavArea*);

   static void navigationRegenUpdateCallback(void* usr);
   virtual void processNavigationRegenUpdate();

protected:
   DtTerrainInterface* myTerrainInterface;

   typedef std::vector<DtNavArea*> DtNavAreas;
   DtNavAreas myNavAreas;

   typedef std::map<const DtVrfObject*, DtNavArea*> DtObjectNavAreaMap;
   DtObjectNavAreaMap myObjectNavAreas;
   bool myNavigationInitialized;
   DtSimManager* mySimManager;
   Coordinate_System* myObjectCoordSys;

   DtNavGenerationThreadCounter* myNavGenThreadCounter;

   static int theGamewareWorkingMemorySize;
   static bool theRegenerateNavDataAtRuntime;
   static int theMaxRegenerationThreads;
   static double theRegenerationDelay;
   static double theQueryTimeBudget;

   typedef DtCallbackList<DtNavArea*> NavAreaAboutToBeRemovedList;
   mutable NavAreaAboutToBeRemovedList myNavAreaAboutToRemRemovedList;
};