DtTerrain.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtForest.h>
#include <vrvCore/DtTerrainPatch.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/DtSignalConnectionManager.h>

#include <matrix/vlVector.h>

#include <makArchives/DtTerrainRecord.h>

#include <vrvUtil/signalslib.h>

#include <string>
#include <list>
#include <vector>

namespace makArchives 
{ 
   class DtFeatureLayerRecord;
   class DtOceanLayerRecord;
   class DtTerrainPatchRecord;
}

namespace makVrv
{
   class DtBuoyOrBeaconFacade;
   class DtDe;
   class DtFeature;
   class DtFeatureLayer;
   class DtModelAgent;
   class DtOceanLayer;
   class DtDynamicFeatureLayer;
   class DtProp;
   class DtTerrainPatchObjectAgent;
   class DtTerrainPatchObject;
   class DtTerrainSignaler;
   class DtTexturedQuad;
   class DtBuoyBeaconLayer;
   class DtStreamedFeatureLayer;
   class DtNavigationLightManager;
   class DtNavigationFeatureManager;
   class DtLightPointUpdater;

   class DT_DLL_VRVCORE DtTerrain : private DtSignalConnectionManager
   {

   public:

      typedef std::list<DtTerrainPatch*> TerrainPatches;
      typedef std::list<DtFeatureLayer*> FeatureLayers;
      typedef std::list<DtOceanLayer*> OceanLayers;

      typedef std::map<int, makArchives::DtTerrainOperationRecord> TerrainOperationsMap;

      DtTerrain(DtDe& de, DtAgentManagerInterface& sceneManagerInterface);

      virtual ~DtTerrain();

      void clear(bool reload=false);



      bool globalScaleTerrain() const;

      void updateGlobalScaleTerrain();

      virtual void getRecord(makArchives::DtTerrainRecord& rec) const;

      virtual void setFromRecord(const makArchives::DtTerrainRecord& rec, bool clearFirst=true);

      virtual void reloadTerrain();




      virtual DtTerrainPatch& addTerrainPatch(const makArchives::DtTerrainPatchRecord& rec);

      virtual DtTerrainPatch& addTerrainPatch(const std::string& terrainDefinitionName, bool minimapOnly=false, 
         const DtTerrainPatch::DtPageableTerrainPatchRecord& pageableTerrainPatchRecord=DtTerrainPatch::DtPageableTerrainPatchRecord());

      virtual DtTerrainPatch* findTerrainPatch(const std::string& terrainDefinitionName);

      virtual DtTerrainPatch* findTerrainPatch(DtUniqueID id);

      virtual bool removeTerrainPatch(const std::string& terrainDefinitionName, bool minimapOnly=false);

      const TerrainPatches& terrainPatches() const;

      TerrainPatches& terrainPatches();

      size_t numberOfTerrainPatches() const;

      bool lightPointsEnabled() const;



      virtual const TerrainOperationsMap& terrainOperationsMap() const;




      virtual DtFeatureLayer& addFeatureLayer(const makArchives::DtFeatureLayerRecord& rec, 
         makArchives::DtTerrainOperationRecord::TargetApplication target = 
         makArchives::DtTerrainOperationRecord::VisualizationAndSimulation);

      virtual DtFeatureLayer& addFeatureLayer(const std::string& featureLayerFilename, 
         makArchives::DtTerrainOperationRecord::TargetApplication target = 
         makArchives::DtTerrainOperationRecord::VisualizationAndSimulation );

      virtual void removeFeatureLayer(const std::string& featureLayerFilename);

      virtual const FeatureLayers& featureLayers() const;

      virtual FeatureLayers& featureLayers();

      virtual DtFeatureLayer* findFeatureLayer(const std::string& featureLayerFilename);

      virtual DtStreamedFeatureLayer& streamedFeatureLayer();

      virtual DtBuoyBeaconLayer& buoyBeaconLayer();

      virtual DtDynamicFeatureLayer& dynamicFeatureLayer();

      virtual DtNavigationLightManager& navigationLightManager();

      virtual DtNavigationFeatureManager& navigationDaymarkManager();

      virtual DtNavigationFeatureManager& navigationTopmarkManager();




      virtual DtOceanLayer& addOceanLayer( const makArchives::DtOceanLayerRecord& rec );

       virtual DtOceanLayer& addOceanLayer( const std::string& layerName );

      virtual void removeOceanLayer( const std::string& layerName );

      virtual const OceanLayers& oceanLayers() const;

      virtual OceanLayers& oceanLayers();

      virtual DtOceanLayer* findOceanLayer( const std::string& layerName );

      virtual void onOceanNodesExtracted( DtTerrainPatchObject& patchObject );



      std::string generatePropName(const std::string& propType);




      virtual DtForest& forest();

      bool isPropNameUsed(const std::string& propName) const;

      virtual bool getTerrainIntersection(double x, double y, double z,
         double upX, double upY, double upZ, double& retX, double& retY, 
         double& retZ );
         
      virtual void clearElevationCache();



      virtual bool exportTerrainAndProps(const std::string&);


      virtual const std::string* findOptionalParameter(const std::string& name) const;

      virtual void setOptionalParameter(const std::string& name, const std::string& value);

      virtual void setOptionalParameters(const makArchives::DtTerrainRecord::OptionalParameterMap&);

      virtual void removeOptionalParameter(const std::string& name);

      const makArchives::DtTerrainRecord::OptionalParameterMap& optionalParameters() const;

      virtual const std::string& description();

      virtual void setDescription(const std::string& description);

      virtual bool useICO() const;

      virtual void setUseICO(bool flag);

      virtual unsigned int maxPagedLODs() const;

      virtual void setMaxPagedLODs( unsigned int maxPagedLODs );

      virtual bool reloadingTerrain() { return myReloadingTerrain;}

   protected:

      void executeTerrainOperation(const makArchives::DtTerrainOperationRecord& operation, 
         const makArchives::DtTerrainRecord& terrainRec);

      void addTerrainOperationRecord(const makArchives::DtTerrainOperationRecord& operation);

      void removeTerrainOperationRecord( const makArchives::DtTerrainOperationRecord& operation);

      void removeTerrainOperationRecord(int id);

      void clearTerrainOperations();

      void slot_handleIsDayChanged(bool isDay);

      virtual bool checkIfTerrainOperationRecordsMatch
         (const makArchives::DtTerrainOperationRecord& left,
         const makArchives::DtTerrainOperationRecord& right);

      virtual void connectForestAndOceanSignals(void);

   protected:
      typedef std::map<std::string,int> PropNameMap;

      DtDe& myDe;
      DtTerrainSignaler& mySignaler;
      DtAgentManagerInterface& myAgentManagerInterface;

      TerrainPatches myTerrainPatches;
      FeatureLayers myFeatureLayers;
      OceanLayers myOceanLayers;
      DtForest * myForest;
      DtBuoyBeaconLayer* myBuoyLayer;
      DtStreamedFeatureLayer* myStreamedFeatureLayer;
      DtDynamicFeatureLayer* myDynamicFeatureLayer;
      DtNavigationLightManager* myNavigationLightManager;
      DtNavigationFeatureManager* myNavigationDaymarkManager;
      DtNavigationFeatureManager* myNavigationTopmarkManager;
            
      TerrainOperationsMap myTerrainOperationsMap;
      int myNextTerrainOperationId;
      bool myGlobalScaleFlag;
            
      PropNameMap myPropNameMap;

      makArchives::DtTerrainRecord::OptionalParameterMap myOptionalParameters;
      makArchives::DtTerrainRecord::GenericRecords myGenericRecords;

      std::string myDescription;

      bool myUseICO;
      unsigned int myMaxPagedLODs;

      bool myReloadingTerrain;

      DtTexturedQuad* myLogo;
   };

   class DT_DLL_VRVCORE DtTerrainSignaler : public DtVirtualBaseClass
   {
   public:

      static DtTerrainSignaler& instance(DtDe& de);

      virtual ~DtTerrainSignaler();

      //@name Signals

      boost::signalslib::signal< void(const makArchives::DtTerrainRecord&) > signal_terrainLoaded;

      boost::signalslib::signal< void(unsigned int) > signal_terrainMaxPagedLODChanged;

      boost::signalslib::signal< void (const DtTerrainPatch&) > signal_terrainPatchAdded;

      boost::signalslib::signal< void (const DtTerrainPatch&) > signal_terrainPatchToBeDeleted;

      boost::signalslib::signal< void (const DtFeatureLayer&) > signal_featureLayerAdded;

      boost::signalslib::signal< void (const DtFeatureLayer&) > signal_featureLayerToBeDeleted;

      boost::signalslib::signal< void (const DtOceanLayer&) > signal_oceanLayerAdded;

      boost::signalslib::signal< void (const DtOceanLayer&) > signal_oceanLayerToBeDeleted;

      boost::signalslib::signal< void(const std::string&) > signal_oceanLayerDeleted;

      boost::signalslib::signal< void (const DtOceanLayer&, double) > signal_oceanLayerSeaLevelChanged;

      boost::signalslib::signal< void (const DtOceanLayer&, int) > signal_oceanLayerLodRangeChanged;

      boost::signalslib::signal<void (bool reload) > signal_terrainToBeCleared;

      boost::signalslib::signal< void () > signal_terrainCleared;

      boost::signalslib::signal< void (DtProp& prop) > signal_propCreated;

      boost::signalslib::signal< void (const DtProp& prop) > signal_propAboutToBeDestroyed;

      boost::signalslib::signal< void (DtBuoyOrBeaconFacade& buoy, 
         const DtVector& initialPosition) > signal_buoyOrBeaconCreated;

      boost::signalslib::signal< void (const DtBuoyOrBeaconFacade& buoy) > 
         signal_buoyOrBeaconAboutToBeDestroyed;

      boost::signalslib::signal< void (const DtProp& prop, double x, double y, double z) > 
         signal_propPositionAboutToChange;

      boost::signalslib::signal< void (const DtProp& prop, double x, double y, double z, double w) > signal_propOrientationAboutToChange;

      boost::signalslib::signal< void (const DtFeature&) > signal_featureAdded;

      boost::signalslib::signal< void (const DtFeature&) > signal_featureToBeDeleted;

      boost::signalslib::signal< void(int id, const makArchives::DtTerrainOperationRecord& rec) > signal_terrainOperationAdded;

      boost::signalslib::signal< void(int id) > signal_terrainOperationRemoved;

      boost::signalslib::signal< void(bool) > signal_terrainIsGlobalScaleChanged;


   protected:
      DtTerrainSignaler();
   };


   class DT_DLL_VRVCORE DtTerrainCreator : public DtVirtualBaseClass
   {

   public:
      static DtTerrainCreator& instance(DtDe& de);

      static void registerInstance(DtDe& de, DtTerrainCreator* instance);     
      
      virtual DtTerrain* create( DtDe& de, 
         DtAgentManagerInterface& agentManager );
   };

}