DtDynamicTerrainRasterLibrary.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsg/vrvOsg.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <matrix/vlVector.h>

#include<osg/ref_ptr>

#include <tbb/spin_rw_mutex.h>
#include <string>
#include <map>

// Forward declarations
namespace osg
{
   class Image;
}

namespace osgEarth
{
   class LandCoverDictionary;
   class GeoExtent;
   class SpatialReference;
}

namespace makVrv
{
   typedef enum
   {
      RasterElevation,
      RasterLandCover,
      RasterOTWImagery
   } RasterImageType;

   class DtDe;
   class DtVrfSoilTypeToOsgEarthLandCoverMap;


   class DT_DLL_VRVOSG DtDynamicTerrainRasterLibrary
      : public DtVirtualBaseClass
   {
   protected:

      DtDynamicTerrainRasterLibrary(DtDe& de);

      friend class DtDynamicTerrainRasterLibraryCreator;

   public:
      // Type string
      static const std::string DEFORMATION_CRATER;
      static const std::string DEFORMATION_SCRAPE;

      virtual ~DtDynamicTerrainRasterLibrary();

      virtual void init();

      virtual osg::ref_ptr <osg::Image> getLandCoverRaster(
         osgEarth::LandCoverDictionary* landCoverDictionary, double& scaleFactorX, double& scaleFactorY,
         const std::string& deformationType, const std::string& craterType, int soilType, double heading = 0.0);

      virtual osg::ref_ptr <osg::Image> getElevationRaster(double& scaleFactorX, 
         double & scaleFactorY, const std::string& deformationType, const std::string& craterType, double heading = 0.0);

      virtual osg::ref_ptr <osg::Image> getElevationOtwImage(double& scaleFactorX, 
         double & scaleFactorY, const std::string& deformationType, const std::string& craterType, int soilType, double heading = 0.0);

      virtual osg::ref_ptr <osg::Image> getLandCoverOtwImage(double& scaleFactorX, double & scaleFactorY,
         const std::string& deformationType, const std::string& craterType, int soilType, double heading = 0.0);

      virtual osg::ref_ptr <osg::Image> getElevationAndLandCoverOtwImage(double& scaleFactorX,
         double& scaleFactorY, const std::string& deformationType, const std::string& craterType, int soilType, double heading = 0.0);

      osgEarth::GeoExtent calculateNewExtent(const DtVector& centerPoint, 
         osg::ref_ptr<const osgEarth::SpatialReference> srs, double minorAxis, double majorAxis,
         double heading, double scaleFactorX, double scaleFactorY);

   public:
       static std::string defaultCraterType();
       static std::string defaultCraterImageFilename();
       static std::string defaultCraterElevationFilename();
       static std::string craterTypeToElevationMapFilename();
       static std::string craterTypeToLandCoverMapFilename();
       static std::string elevationOtwMapFilename();
       static std::string landCoverOtwMapFilename();
       static std::string elevationAndLandCoverOtwMapFilename();

       virtual osg::ref_ptr <osg::Image> createLandCoverFromSdfElevationImage(
          osgEarth::LandCoverDictionary* landCoverDictionary, osg::ref_ptr <osg::Image> img,
          const std::string& landCover) const;

   protected:
   
      typedef std::map<std::string, osg::ref_ptr <osg::Image> > StrToImgMap;
      typedef std::map<std::string, std::string> StrToStrMap;

      // The key is the crater type.  The StrToStrMap maps
      // soil type names to filenames
      typedef std::map<std::string, StrToStrMap> OtwImageMap;

      virtual osg::ref_ptr<osg::Image> rotateImage(double & scaleFactorX, double & scaleFactorY, 
         const osg::ref_ptr<osg::Image> & templateImg, double heading, RasterImageType imgType = RasterElevation);

      virtual osg::ref_ptr<osg::Image> allocateImageAndInitialize(int s, int t, RasterImageType imgType);

      virtual osg::ref_ptr <osg::Image> loadRasterToCache(StrToImgMap& rasterCache,
         const std::string& deformationType, const std::string& craterType, const StrToStrMap& keyToFilenameMap);

      virtual osg::ref_ptr <osg::Image> loadOtwImageToCache(StrToImgMap& imageCache,
         const std::string& deformationType, const std::string& craterType, const std::string& soilTypeName,
         const OtwImageMap& keysToFilenameMap);

      virtual osg::ref_ptr <osg::Image> createLandCoverFromImage(
         osgEarth::LandCoverDictionary* landCoverDictionary, osg::ref_ptr <osg::Image> img, 
         const std::string& landCover, bool terrainDeformation=false) const;

      virtual osg::ref_ptr <osg::Image> getOtwImage(StrToImgMap& imgCache, 
         const OtwImageMap& keysToFilenameMap, double& scaleFactorX, double & scaleFactorY, 
         const std::string& deformationType, const std::string& craterType, int soilType, double heading);

      virtual std::string lookupRasterFileAndResolvePath(const std::string& deformationType, 
         const std::string& craterType, const StrToStrMap& keyToFilenameMap) const;

      virtual std::string lookupOtwImageFileAndResolvePath(const std::string& deformationType, 
         const std::string& craterType, const std::string& soilTypeName, const OtwImageMap& keysToFilenameMap) const;

      virtual bool populateRasterMap(const std::string& deformationType, StrToStrMap & mapToPopulate, const std::string& rasterFilename);

      virtual bool populateImageMap(const std::string& deformationType, OtwImageMap& mapToPopulate, const std::string& imageMapFilename);

      virtual std::string otwImageCacheKey(const std::string& deformationType,
         const std::string& craterType, const std::string& soilTypeName) const;

   private:

      DtDynamicTerrainRasterLibrary();

      DtDynamicTerrainRasterLibrary(const DtDynamicTerrainRasterLibrary& orig);

      DtDynamicTerrainRasterLibrary& operator=(const DtDynamicTerrainRasterLibrary&);

   protected:

      static const std::string theDefaultCraterType;
      static const std::string theDefaultCraterImageFilename;
      static const std::string theDefaultCraterElevationFilename;
      // Craters
      static const std::string theCraterTypeToElevationMapFilename;
      static const std::string theCraterTypeToLandCoverMapFilename;
      static const std::string theElevationOtwMapFilename;
      static const std::string theLandCoverOtwMapFilename;
      static const std::string theElevationAndLandCoverOtwMapFilename;
      // Scrapes
      static const std::string theScrapeTypeToElevationMapFilename;
      static const std::string theScrapeTypeToLandCoverMapFilename;
      static const std::string theScrapeElevationOtwMapFilename;
      static const std::string theScrapeLandCoverOtwMapFilename;
      static const std::string theScrapeElevationAndLandCoverOtwMapFilename;
   protected:

      bool myIsInitialized;

      tbb::spin_rw_mutex myLandCoverCacheMutex;
      tbb::spin_rw_mutex myElevationRasterCacheMutex;
      tbb::spin_rw_mutex myOtwImageCacheMutex;
      tbb::spin_rw_mutex myInitMutex;

      // Used to cache ref_ptrs to images that were created for specific types of land cover codes
      // key is crater type + land cover code 
      StrToImgMap myLandCoverImageCache;

      // Used to cache ref_ptrs to images for land cover that have not been modified for
      // a specific land cover code. 
      StrToImgMap myLandCoverElevationRasterCache;

      // Cache for ref_ptrs to images for elevation rasters
      StrToImgMap myElevationRasterCache;

      // Cache for ref_ptrs to OTW images used with the elevation effect type
      StrToImgMap myElevationOtwImageCache;

      // Cache for ref_ptrs to OTW images used with the soil type effect type
      StrToImgMap myLandCoverOtwImageCache;

      // Cache for ref_ptrs to OTW images used with the elevation and soil type effect type
      StrToImgMap myElevationAndLandCoverOtwImageCache;

      // Map Deformation (crater, tank scrap) type to raster filenames for use with osgEarth decal elevation layer
      StrToStrMap myDeformationTypeToElevationFilenameMap;

      // Map Deformation (crater, tank scrap) type to raster filenames for use with osgEarth decal land cover layer
      StrToStrMap myDeformationTypeToLandCoverFilenameMap;

      // Map Deformation (crater, tank scrap) type and soil type to visual images for osgEarth decal image layer
      // when effect type is DtTerrainCraterElevationEffect
      OtwImageMap myDeformationTypeAndSoilTypeToOtwFilenameForElevationMap;

      // Map Deformation (crater, tank scrap) type and soil type to visual images for osgEarth decal image layer
      // when effect type is DtTerrainCraterSoilEffect
      OtwImageMap myDeformationTypeAndSoilTypeToOtwFilenameForLandCoverMap;

      // Map Deformation (crater, tank scrap) type and soil type to visual images for osgEarth decal image layer
      // when effect type is DtTerrainCraterElevAndSoilEffect
      OtwImageMap myDeformationTypeAndSoilTypeToOtwFilenameForElevationAndLandCoverMap;

      DtDe& myDe;

      // External soil type to osgEarth land cover name mapper
      DtVrfSoilTypeToOsgEarthLandCoverMap* mySoilTypeToLandCoverMap;
   };


   class DT_DLL_VRVOSG DtDynamicTerrainRasterLibraryCreator
      : public DtVirtualBaseClass
   {
   public:

      DtDynamicTerrainRasterLibraryCreator();

      virtual ~DtDynamicTerrainRasterLibraryCreator();

      static DtDynamicTerrainRasterLibraryCreator& instance(DtDe& de);

      static void registerInstance(DtDe& de, DtDynamicTerrainRasterLibraryCreator* creatorInstance);

      virtual DtDynamicTerrainRasterLibrary* create(DtDe& de);
   };

}