navigationAreasManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/guiSimObject.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrfutil/rwNavGenConfig.h>
#include <vrfutil/rwNavRuntimeConfig.h>
#include <vrfutil/rwUUID.h>
#include <vrfutil/rwTemplatedMap.h>
#include <vlutil/vlFilename.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtSelectionManager.h>
#include <vrvUtil/DtUnicode.h>
#include <vlutil/vlPerformanceStats.h>
#include <vrfmsgs/ifLoadedNavAreasResponse.h>

namespace makVrv
{
   class DtDe;
}

class QProcess;
class DtSimMessage;

#define DtDebugPortExtendedDataKey "DtDebugPortExtendedDataKey"

namespace makVrf
{
   class DtEnvironmentalFacadeCollection;

   class DT_DLL_VRFGUICORE DtNavigationAreasManager : public makVrv::DtVirtualBaseClass
   {
   public:
      enum Status
      {
         Unknown = -1,
         Generated,
         NeedsGeneration,
         Generating,
         ScheduledForGeneration
      };

      typedef std::map<std::string, DtNavSectorIndices> DtNavSectorIndicesByBackEnd;

      struct NavigationArea
      {
         DtRwNavGenConfig configuration;
         DtRwNavGenConfig originalConfiguration;
         DtRwNavRuntimeConfig runtimeConfiguration;
         DtRwNavRuntimeConfig originalRuntimeConfiguration;
         DtEnvironmentalFacadeCollection* area;
         Status status;
         std::string runtimeConfigurationFilename;
         std::string originalRuntimeConfigurationFilename;
         makVrv::DtSignalConnectionManager* connections = nullptr;
         DtNavSectorIndicesByBackEnd sectorsBeingRegenerated;
         DtNavSectorIndicesByBackEnd sectorsQueuedForRegeneration;
         bool hasRuntimeConfig = false;
      };

      typedef std::map<makVrv::DtUniqueID, NavigationArea> NavigationAreas;

      struct SimObjectNavigationArea
      {
         std::map<int, int> debugPorts;
         std::list<std::string> profiles;
         std::string status;
      };

      typedef std::map<DtUUID, SimObjectNavigationArea> SimObjectNavigationAreas;

   public:
      DtNavigationAreasManager(makVrv::DtDe&);

      virtual ~DtNavigationAreasManager() override;

      static DtNavigationAreasManager& instance(makVrv::DtDe& de);

      static void registerInstance(makVrv::DtDe&, DtNavigationAreasManager*);

      virtual bool addNavigationArea(const DtFilename&, makVrv::DtUniqueID* resID = 0);

      virtual int profilesToGenerate(makVrv::DtUniqueID) const;

      virtual DtEnvironmentalFacadeCollection* createNavigationArea(const NavigationArea&) const;
      
      virtual void selectNavigationAreas(const std::set<makVrv::DtUniqueID>&, bool selectOnMap = true);
      const std::set<makVrv::DtUniqueID>& selectedNavigationAreas() const;

      virtual Status status(makVrv::DtUniqueID);

      virtual void reset();

      virtual void delayedReset();

      virtual const DtNavSectorIndicesByBackEnd& sectorsBeingRegenerated(makVrv::DtUniqueID) const;

      virtual const DtNavSectorIndicesByBackEnd& sectorsQueuedForRegeneration(makVrv::DtUniqueID) const;

      virtual void revertNavigationArea(makVrv::DtUniqueID);

      virtual bool isModified(makVrv::DtUniqueID) const;

      virtual Status navDataGenerated(const NavigationArea&) const;

      virtual void generateNavigationArea(makVrv::DtUniqueID);

      virtual void regenerateAllUngeneratedAreas();

      virtual void saveConfigurations();

      virtual makVrv::DtUniqueID generatingNavigationArea() const;

      virtual void generateAllNavigationAreas();

      virtual bool generatingAnyNavigationArea();

      virtual void removeCurrentFromGeneration();

      virtual void removeAllFromGeneration();

      virtual void removeNavigationAreaForGeneration(makVrv::DtUniqueID);

      virtual bool scheduledForGeneration(makVrv::DtUniqueID) const;

      virtual bool isNavigationArea(makVrv::DtUniqueID) const;

      virtual makVrv::DtUniqueID navigationAreaForConfigurationFile(const DtFilename&) const;

      virtual void setShowNavigationAreas(bool);
      virtual bool showNavigationAreas() const;

      virtual void setShowProgressOnGenerationStart(bool b);
      virtual bool showProgressOnGenerationStart() const;

      virtual void removeNavigationArea(makVrv::DtUniqueID, bool ask = false, bool removeFromTerrain = true);

      virtual void setGenerationCheckDelta(double);
      double generationCheckDelta() const;

      virtual std::map<DtString, DtFilename> profilesAndOutputDirectoriesFor(makVrv::DtUniqueID id) const;

      const NavigationAreas& navigationAreas() const { return myNavigationAreas; };

      virtual void setMaximumNavigationAreaCellSize(double length, double width);
      virtual void getMaximumNavigationAreaCellSize(double& length, double& width);

      virtual bool needsRegeneration() const;

      virtual bool startGenerationProcess(makVrv::DtUniqueID, makVrv::DtUnicode& error);

      virtual std::vector<DtVector> convertRuntimeExtentToLocations(const DtRwNavRuntimeConfig&,
         bool& valid) const;

      virtual DtFilename navDataRuntimeDirectory(const NavigationArea&) const;
      virtual DtFilename navDataRuntimeDirectory(makVrv::DtUniqueID) const;

      virtual bool checkValidExtent(const std::vector<DtVector>&) const;

      virtual DtVector convertToLocalNavigationArea(const DtVector& geocentric) const;

      bool generationHadErrors() const
      {
         return myGenerationHadErrors;
      }

      SimObjectNavigationAreas& simObjectNavAreas() { return mySimObjectNavAreas; };

      //
      boost::signals2::signal<void (bool)> signal_showNavigationAreasChanged;
      boost::signals2::signal<void ()> signal_areasCleared;
      boost::signals2::signal<void (makVrv::DtUniqueID, NavigationArea, bool)> signal_navigationAreaAdded;
      boost::signals2::signal<void (makVrv::DtUniqueID)> signal_navigationAreaRemoved;
      boost::signals2::signal<void (makVrv::DtUniqueID, NavigationArea)> signal_navigationAreaUpdated;
      boost::signals2::signal<void (makVrv::DtUniqueID, makVrv::DtUnicode)> signal_generationError;
      boost::signals2::signal<void (makVrv::DtUniqueID, makVrv::DtUnicode)> signal_startingGeneration;
      boost::signals2::signal<void ()> signal_generationComplete;
      boost::signals2::signal<void (makVrv::DtUniqueID)> signal_generationRequested;
      boost::signals2::signal<void (makVrv::DtUniqueID, const DtFilename&)> signal_profileGenerated;
      boost::signals2::signal<void ()> signal_navigationAreaGenerationProcessStarted;
      boost::signals2::signal<void (QProcess*)> signal_generatorProcessStarted;
      boost::signals2::signal<void ()> signal_generatorProcessCompleted;
      boost::signals2::signal<void (makVrv::DtUniqueID, int)> signal_removedFromGeneration;

   protected:
      virtual void resetNavAreaColors();
      virtual void initExistingNavigationAreas();
      virtual void slot_navigationAreasCleared(bool removeFromTerrain = true);
      virtual void showNavigationArea(const NavigationArea&);
      virtual void initialize();

      virtual void navigationAreaUpdated(DtSimObjectReference);
      virtual void navigationAreaAdded(DtSimObjectReference);

      virtual void tick();

      virtual void navAreaDebugPortsReceived(DtSimMessage*);
      virtual void simObjectNavareaDebugPortsReceived(DtSimMessage*);

      virtual void detachIfAttachedToNavigationArea(makVrv::DtUniqueID);

      virtual void slot_onCurrentSelectionChanged(const makVrv::DtSelectionManager::IdSet& selected,
         const makVrv::DtSelectionManager::IdSet& deselected);

      virtual void setTerrainClearing(bool);

   protected:
      makVrv::DtDe& myDe;
      makVrv::DtSignalConnectionManager myConnectionManager;
      makVrv::DtSignalConnectionManager myInitializeConnectionManager;

      boost::signals2::connection myDelayedResetConnection;
      boost::signals2::connection myNavigationAreasManagerTickConnection;

      NavigationAreas myNavigationAreas;

      std::set<makVrv::DtUniqueID> mySelectedNavigationAreas;

      typedef std::vector<makVrv::DtUniqueID> NavigationAreasToGenerate;
      NavigationAreasToGenerate myNavigationAreasToGenerate;

      QProcess*   myNavigationGenerationProcess;

      makVrv::DtUniqueID myGeneratingNavigationArea;

      std::vector<std::string> myProfilesToGenerate;
      DtTimedSection myTimedSection;
      double myTimeSinceLastCheck;
      double myGenerationCheckDelta;
      bool myGenerationHadErrors;

      SimObjectNavigationAreas mySimObjectNavAreas;

      bool myTerrainClearing;
   };
}