RasterOverlayTileProvider.h

#pragma once
 
#include <CesiumAsync/IAssetAccessor.h>
#include <CesiumGeospatial/Projection.h>
#include <CesiumGltfReader/GltfReader.h>
#include <CesiumRasterOverlays/Library.h>
#include <CesiumRasterOverlays/RasterOverlayExternals.h>
#include <CesiumUtility/Assert.h>
#include <CesiumUtility/CreditSystem.h>
#include <CesiumUtility/ErrorList.h>
#include <CesiumUtility/IntrusivePointer.h>
#include <CesiumUtility/ReferenceCounted.h>
#include <CesiumUtility/Tracing.h>
 
#include <spdlog/fwd.h>
 
#include <optional>
 
namespace CesiumUtility {
class CreditReferencer;
}
 
namespace CesiumRasterOverlays {
 
class RasterOverlay;
class RasterOverlayTile;
class IPrepareRasterOverlayRendererResources;

struct CESIUMRASTEROVERLAYS_API LoadedRasterOverlayImage {
  CesiumUtility::IntrusivePointer<CesiumGltf::ImageAsset> pImage{nullptr};

  CesiumGeometry::Rectangle rectangle{};

  std::vector<CesiumUtility::Credit> credits{};

  CesiumUtility::ErrorList errorList{};

  bool moreDetailAvailable = false;

  int64_t getSizeBytes() const {
    int64_t accum = 0;
    accum += int64_t(sizeof(LoadedRasterOverlayImage));
    accum += int64_t(this->credits.capacity() * sizeof(CesiumUtility::Credit));
    if (this->pImage) {
      accum += this->pImage->getSizeBytes();
    }
    return accum;
  }
};

struct LoadTileImageFromUrlOptions {
  CesiumGeometry::Rectangle rectangle{};

  std::vector<CesiumUtility::Credit> credits{};

  bool moreDetailAvailable = true;

  bool allowEmptyImages = false;
};
 
class RasterOverlayTileProvider;

class CESIUMRASTEROVERLAYS_API RasterOverlayTileProvider
    : public CesiumUtility::ReferenceCountedNonThreadSafe<
          RasterOverlayTileProvider> {
public:
  RasterOverlayTileProvider(
      const CesiumUtility::IntrusivePointer<const RasterOverlay>& pOwner,
      const RasterOverlayExternals& externals,
      const CesiumGeospatial::Projection& projection,
      const CesiumGeometry::Rectangle& coverageRectangle) noexcept;

  RasterOverlayTileProvider(
      const CesiumUtility::IntrusivePointer<const RasterOverlay>& pOwner,
      const CesiumAsync::AsyncSystem& asyncSystem,
      const std::shared_ptr<CesiumAsync::IAssetAccessor>& pAssetAccessor,
      const std::shared_ptr<CesiumUtility::CreditSystem>& pCreditSystem,
      std::optional<CesiumUtility::Credit> credit,
      const std::shared_ptr<IPrepareRasterOverlayRendererResources>&
          pPrepareRendererResources,
      const std::shared_ptr<spdlog::logger>& pLogger,
      const CesiumGeospatial::Projection& projection,
      const CesiumGeometry::Rectangle& coverageRectangle) noexcept;

  virtual ~RasterOverlayTileProvider() noexcept;

  CesiumAsync::SharedFuture<void>& getAsyncDestructionCompleteEvent();

  RasterOverlay& getOwner() noexcept;

  const RasterOverlay& getOwner() const noexcept;

  const RasterOverlayExternals& getExternals() const noexcept;

  const std::shared_ptr<CesiumAsync::IAssetAccessor>&
  getAssetAccessor() const noexcept;

  const std::shared_ptr<CesiumUtility::CreditSystem>&
  getCreditSystem() const noexcept;

  const CesiumAsync::AsyncSystem& getAsyncSystem() const noexcept;

  const std::shared_ptr<IPrepareRasterOverlayRendererResources>&
  getPrepareRendererResources() const noexcept;

  const std::shared_ptr<spdlog::logger>& getLogger() const noexcept;

  const CesiumGeospatial::Projection& getProjection() const noexcept;

  const CesiumGeometry::Rectangle& getCoverageRectangle() const noexcept;

  [[deprecated(
      "Use addCredits instead.")]] const std::optional<CesiumUtility::Credit>&
  getCredit() const noexcept;

  virtual CesiumAsync::Future<LoadedRasterOverlayImage>
  loadTileImage(const RasterOverlayTile& overlayTile) = 0;

  virtual void
  addCredits(CesiumUtility::CreditReferencer& creditReferencer) noexcept;
 
protected:
  CesiumAsync::Future<LoadedRasterOverlayImage> loadTileImageFromUrl(
      const std::string& url,
      const std::vector<CesiumAsync::IAssetAccessor::THeader>& headers = {},
      LoadTileImageFromUrlOptions&& options = {}) const;
 
private:
  struct DestructionCompleteDetails {
    CesiumAsync::Promise<void> promise;
    CesiumAsync::SharedFuture<void> future;
  };
 
  CesiumUtility::IntrusivePointer<RasterOverlay> _pOwner;
  RasterOverlayExternals _externals;
  std::optional<CesiumUtility::Credit> _credit;
  CesiumGeospatial::Projection _projection;
  CesiumGeometry::Rectangle _coverageRectangle;
  std::optional<DestructionCompleteDetails> _destructionCompleteDetails;
};
} // namespace CesiumRasterOverlays