DtOsgEarthCache.h

Go to the documentation of this file.

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


#pragma once

#include <vrvOsgEarth/vrvOsgEarth.h>
#include <osgEarth/Bounds>
#include <osgEarth/Progress>
#include <vrvUtil/DtVirtualBaseClass.h>

// Class Forward Declarations
namespace osgEarth
{
   class MapNode;
   namespace Util
   {
      class TileVisitor;
   }
}

namespace makVrv
{
   // Class Forward Declarations
   class DtDe;
   class DtOsgEarthCacheProgressCallback;

   class DT_DLL_VRVOSGEARTH DtOsgEarthCache
   {
   public:
      friend class DtOsgEarthCacheCreator;

      //let the WidgetProgressCallback emit updateProgress signal
      friend class DtWidgetProgressCallback;

      virtual void setMapNode(osgEarth::MapNode* mapNode);

      virtual void setLowestLod(int lowestLod);

      virtual int lowestLod() const;

      virtual void setHighestLod(int highestLod);

      virtual int highestLod() const;

      virtual void setBound(const osgEarth::Bounds& bound);

      virtual osgEarth::Bounds bound() const;

      virtual void setCacheImageLayers(bool val);

      virtual void setCacheElevationLayers(bool val);

      virtual void reset();

      virtual void startCache();

      virtual void apiCache();

      virtual void cancelCache();

      virtual bool isCanceled();

      virtual ~DtOsgEarthCache();

   public:

      boost::signalslib::signal<void(double,double)> signal_updateProgress;
      boost::signalslib::signal<void(std::string)> signal_updateProgressText;
      boost::signalslib::signal<void(bool)> signal_cacheFinished;

   private:

      DtOsgEarthCache() = delete;
      DtOsgEarthCache(const DtOsgEarthCache&) = delete;
      DtOsgEarthCache& operator=(const DtOsgEarthCache&) = delete;

   protected:

      DtOsgEarthCache(DtDe& de);

      class DT_DLL_VRVOSGEARTH DtOsgEarthCacheProgressCallback : public osgEarth::ProgressCallback
      {
      public:

         DtOsgEarthCacheProgressCallback(DtOsgEarthCache* osgEarthCache);

         virtual ~DtOsgEarthCacheProgressCallback();

         virtual bool reportProgress(
             double             current,
             double             total,
             unsigned           currentStage,
             unsigned           totalStages,
             const std::string& msg) override;

      protected:
         DtOsgEarthCache * myOsgEarthCache;
         int myCurrentProgress = 0;
         int myTotalStages = 0;
      };

   protected:
      DtDe & myDe;
      osgEarth::Bounds myBound;
      int myLowestLod;
      int myHighestLod;
      osgEarth::MapNode* myMapNode;
      osg::ref_ptr<DtOsgEarthCacheProgressCallback> myProgressCallback;

      bool myCanceled;
      bool myCacheImage;
      bool myCacheElevation;
   };

   class DT_DLL_VRVOSGEARTH DtOsgEarthCacheCreator
      : public DtVirtualBaseClass
   {
   public:
      static DtOsgEarthCacheCreator& instance(DtDe& de);
      static void registerInstance(DtDe& de, DtOsgEarthCacheCreator* creator);
      virtual DtOsgEarthCache* create(DtDe& de) const;
   };
}