osgEarthTerrainSourceTracker.h

Go to the documentation of this file.

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


#pragma once

#include <vantageTerrainImplementation/terrainSourceTracker.h>
#include <vantageTerrainImplementation/pageInVisitor.h>
#include <vantageTerrainImplementation/bulletUtil.h>
#include <vantageTerrainImplementation/vantageTerrainImplementationDefines.h>
#include <vantageTerrainImplementation/vantageTerrainImplementationUtil.h>
#include <vantageTerrainImplementation/tileData.h>
#include <vantageTerrainImplementation/tileSpatialIndex.h>
#include <vantageTerrainImplementation/terrainUtil.h>

#include <terrainInterface/terrainProcessPolygonsBox.h>

#include <vrfutil/vertexList.h>

//Mak Terrain Toolkit includes
#include <geometry/sphere.h>

#include <osgTerrain/TerrainTile>
#include <osgEarth/LandCoverLayer>
#include <osgEarth/Profile>
#include <osgEarth/TileKey>
#include <osgEarth/MapNode>
#include <osgEarth/TerrainTileModel>
#include <osgEarthProcedural/LifeMapLayer>

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

#include <boost/ptr_container/ptr_vector.hpp>

#include <tbb/spin_rw_mutex.h>
#include <tbb/task_arena.h>
#include <vrfutil/RTree.h>

#undef final

class DtPageInTilesCommand;
class DtPageOutTilesCommand;
class DtVantageTerrainEngine;
class DtPoint;
class DtGeodeticCoord;
class DtTerrainPagingChord;
class DtTerrainPagingSphere;
class DtTerrainPagingShape;
class DtOsgEarthTerrainSourceTracker;
class DtOsgEarthTerrainSourcePager;
class DtTerrainIntersectOptions;
class DtTerrainIntersectStatus;

namespace makVrf
{
   class DtSurfaceCharacteristicMap;
}

class DT_DLL_vantageTerrainImplementation DtOsgEarthTerrainSourceTracker : public DtTerrainSourceTracker
{
public:
   class OsgEarthTileDataCallback;
   typedef boost::ptr_vector<TileSpatialIndex> TileRoots;

   static const unsigned int theGuiMaxRenderLod;

   DtOsgEarthTerrainSourceTracker(
      DtVantageTerrainEngine*, DtPagerCommandQueue* commandQueue, 
      osgEarth::MapNode* mapNode);

   virtual DtTerrainCategoryMask terrainCategories() const override;

   virtual bool useRawElevation() const override;

   virtual bool useLandCoverData() const override;

   virtual bool useLifeMapLayer() const override;

   unsigned getHighestLodForLandCover() const;

   void setLandCoverSurfaceCharacteristicsMapper(makVrf::DtSurfaceCharacteristicMap * mapper);

   virtual void getSoilFromString(const std::string & soilType, DtSurface& surface) const override;

   virtual const osg::ref_ptr<osgEarth::LandCoverLayer> getBestLandCoverLayer(const osgEarth::TileKey& key) const;

   virtual boost::optional<DtTerrainIntersectOptions::Fidelity> intersectFidelity() const override;

   virtual unsigned maxLOD() const override;
   virtual void setMaxLOD(unsigned);

   virtual unsigned getMaxLODForBilinearIntersection() const override;
   virtual void setMaxLODForBilinearIntersection(unsigned);

   virtual double triangleOutputMergeTolerance() const override;
   virtual void setTriangleOutputMergeTolerance(double tol);
   virtual double intersetionTriangleMergeTolerance() const override;
   virtual void setIntersectionTriangleMergeTolerance(double tol);

   virtual unsigned minElevationIndexLOD() const override;
   virtual void setMinElevationIndexLOD(unsigned);
   virtual unsigned maxElevationIndexLOD() const override;
   virtual void setMaxElevationIndexLOD(unsigned);

   virtual double maxChordLengthBeforeSplitSquared() const;
   virtual void setMaxChordLengthBeforeSplit(double);

   virtual unsigned maxElevationChordSplitTestLOD() const;
   virtual void setMaxElevationChordSplitTestLOD(unsigned);

   virtual unsigned tileCount() const;

   virtual unsigned cellCount() const;

   virtual bool init(DtTerrainSourcePager&) override;

   virtual void addPagedInTile(
      const osgEarth::TileKey& tilekey,
      const std::shared_ptr<DtTileData>& tileData);

   virtual void removePagedInTile(const osgEarth::TileKey tileKey);

   virtual bool dataAvailable(DtPagingMetaDataPtr metaData, 
      DtTerrainPagingGeometryPtr geometry) override;

   virtual bool findHeightFieldIntersections(
      DtTerrainIntersectStatus& status,
      const DtChord& chord,
      DtVrfChordIntersectRecordList& intList,
      const DtTerrainIntersectOptions& options);

   virtual bool halveChordAndFindHeightFieldIntrx(
      const DtChord& chord, DtChord convertedChord,
      const DtTerrainIntersectOptions& options,
      DtTerrainIntersectStatus& status, 
      DtVrfChordIntersectRecordList& intList);

   virtual bool splitChordAt180AndFindHeightFieldIntrx(
      const DtChord& chord, 
      const DtTerrainIntersectOptions& options,
      DtTerrainIntersectStatus& status,
      DtVrfChordIntersectRecordList& intList);

   virtual void processTriangles(
      DtTriangleOutputInterface& output,
      const DtTerrainProcessPolygonsBox& box);

   virtual void pageInData(DtPagingMetaDataPtr metaData,
      DtTerrainPagingGeometryPtr geometry) override;

   virtual DtTerrainIntersectIDType findOldestPagedData(unsigned int& numTrianglesOut) override;

   virtual void pageOutOldestData(const int priority) override;

   virtual bool canPageOutData(DtTerrainIntersectIDType intersectId) override;


   virtual osgEarth::TileKey getBestTileKey(const osgEarth::TileKey&) const override;

   virtual void findMissingTiles(const DtTerrainPagingGeometryPtr& geometry, DtTileKeyList& tiles) const;

   void findPagedInTilesWithinExtent(std::vector<osgEarth::TileKey> & tileKeysPagedIn, const osgEarth::GeoExtent & extent) const;

   void findPagesAtLodWithinExtents(std::vector<osgEarth::TileKey> &tileKeysFound, const osgEarth::GeoExtent & extent, unsigned lod) const;

   virtual void writeIndex(IndexInterface&, IndexOutputInterface&) const;
   virtual bool writeIndexLayers(IndexInterface&, unsigned precision) const;

   struct DT_DLL_vantageTerrainImplementation TrackerMetric
   {
      std::vector<std::string> myPagedInTileKey;
      std::vector<std::string> myPagedOutTileKey;
      int myTileKeySize;
      int myPagedInRequest;
      int myPagedOutRequest;
      unsigned int myFindHeightFieldIntersections;
   };

   virtual std::vector<IndexConfig<DtOsgEarthTerrainSourceTracker>> getIndexConfigInfoForLayer(
      const osgEarth::ElevationLayer& layer) const;

   virtual void readIndex(
      IndexInputInterface&,
      unsigned layerNumber,
      const IndexConfig<DtOsgEarthTerrainSourceTracker>& idxConfig);

   virtual bool readIndexLayers(osgEarth::ElevationLayerVector& flattenedElevationLayers);

   virtual void enableMetrics(bool value);

   virtual void getMetrics(TrackerMetric& trackerMetric) const;

   virtual DtOsgEarthTerrainSourcePager* getOsgEarthTerrainSourcePager() { return  myOsgearthPager; }


protected:

   virtual DtPageInTilesCommand* createPageInTilesCommand(
      DtPagingMetaDataPtr metaData);

   virtual DtPageOutTilesCommand* createPageOutTilesCommand(
      DtPagingMetaDataPtr metaData);
    
   virtual bool aboveAllTerrain(
      const DtChord& geocentricChord,
      const DtChord& geodeticCoord) const;

   virtual bool shortEnoughForIntersection(
      const DtChord& geocentricChord,
      const DtChord& geodeticChord,
      double chordLengthSq) const;

   virtual bool crosses180Lon(const DtChord& geodeticChord) const;

   virtual bool findData(
      const DtTerrainPagingGeometry* geometry,
      std::vector< std::shared_ptr<DtTileData> >& data,
      const DtPagingMetaDataPtr& metaData = DtPagingMetaDataPtr(),
      OsgEarthTileDataCallback* callback = nullptr) const;

   virtual bool findData(
      const DtTerrainPagingGeometry* geometry,
      std::vector< std::shared_ptr<DtTileData> >& data,
      OsgEarthTileDataCallback* callback) const;

   virtual void findMissing(
      const DtTerrainPagingGeometry& geometry,
      DtTileKeyList& missing) const;

   virtual std::shared_ptr<DtTileData> findOldest() const;
   virtual std::shared_ptr<DtTileData> findOldestUnlocked() const;

   virtual void resetMetrics();

   osgEarth::ElevationLayerVector myElevationLayers;

   osgEarth::ElevationLayerVector myFlattenedElevationLayers;

   makVrf::DtSurfaceCharacteristicMap * myLandCoverCharacteristicsMap;

   std::vector<osg::ref_ptr<osgEarth::LandCoverLayer> > myLandCoverLayers;
   std::vector<osg::ref_ptr<osgEarth::Procedural::LifeMapLayer> > myLifeMapLayers;

   unsigned myHighestLodForLandCover;
   
   const bool myUseRawElevation;

   bool myUseLandCover;
   bool myUseLifeMapLayer;

   unsigned int myMaxLOD;

   unsigned int myMaxLODForBilinearIntersection;

   double myTriangleOutputMergeTolerance;
   double myIntersetionTriangleMergeTolerance;

   unsigned myMinElevationIndexLOD;
   unsigned myMaxElevationIndexLOD;

   double myMaxChordLengthBeforeSplitSquared;

   unsigned myMaxElevationChordSplitLOD;

   TileRoots myTileSpatialIndexRoots;

   const double myWorldWidth;
   
   DtTerrainIntersectOptions::Fidelity myFidelity;

   std::weak_ptr<DtTileData> myOldestData;
   std::weak_ptr<DtTileData> myOldestLandData;

   tbb::task_arena myArena;

   bool myWarnedAboutCsType;

   typedef makVrf::RTree<std::shared_ptr<osgEarth::DataExtent>, double, 2> DtLayerExtentTree;
   std::map<std::string, std::shared_ptr<DtLayerExtentTree> > myLayerExtentTrees;

   bool myRecordMetrics;
   
   TrackerMetric myTrackerMetrics;
   
   DtOsgEarthTerrainSourcePager* myOsgearthPager;
};

class DT_DLL_vantageTerrainImplementation DtOsgEarthTerrainSourceTracker::OsgEarthTileDataCallback : public TileDataCallback
{
public:
   explicit OsgEarthTileDataCallback();

   virtual bool operator()(const std::shared_ptr<DtTileData>& tile) override = 0;

private:
   friend class DtOsgEarthTerrainSourceTracker;
};