RasterOverlayCollection.h

#pragma once
 
#include <Cesium3DTilesSelection/Library.h>
#include <Cesium3DTilesSelection/LoadedTileEnumerator.h>
#include <Cesium3DTilesSelection/TilesetExternals.h>
#include <CesiumGeospatial/Ellipsoid.h>
#include <CesiumRasterOverlays/RasterOverlay.h>
#include <CesiumRasterOverlays/RasterOverlayTileProvider.h>
#include <CesiumUtility/IntrusivePointer.h>
#include <CesiumUtility/ReferenceCounted.h>
#include <CesiumUtility/Tracing.h>
 
#include <memory>
#include <span>
#include <vector>
 
namespace Cesium3DTilesSelection {
 
class LoadedTileEnumerator;

class CESIUM3DTILESSELECTION_API RasterOverlayCollection final {
public:
  RasterOverlayCollection(
      const LoadedTileEnumerator& loadedTiles,
      const TilesetExternals& externals,
      const CesiumGeospatial::Ellipsoid& ellipsoid
          CESIUM_DEFAULT_ELLIPSOID) noexcept;

  void setLoadedTileEnumerator(const LoadedTileEnumerator& loadedTiles);

  RasterOverlayCollection(const RasterOverlayCollection& rhs) = delete;

  RasterOverlayCollection(RasterOverlayCollection&& rhs) noexcept = default;

  RasterOverlayCollection&
  operator=(const RasterOverlayCollection& rhs) = delete;

  RasterOverlayCollection&
  operator=(RasterOverlayCollection&& rhs) noexcept = default;
 
  ~RasterOverlayCollection() noexcept;

  void add(const CesiumUtility::IntrusivePointer<
           CesiumRasterOverlays::RasterOverlay>& pOverlay);

  void remove(const CesiumUtility::IntrusivePointer<
              CesiumRasterOverlays::RasterOverlay>& pOverlay) noexcept;

  const std::vector<
      CesiumUtility::IntrusivePointer<CesiumRasterOverlays::RasterOverlay>>&
  getOverlays() const;

  const std::vector<CesiumUtility::IntrusivePointer<
      CesiumRasterOverlays::RasterOverlayTileProvider>>&
  getTileProviders() const;

  const std::vector<CesiumUtility::IntrusivePointer<
      CesiumRasterOverlays::RasterOverlayTileProvider>>&
  getPlaceholderTileProviders() const;

  CesiumRasterOverlays::RasterOverlayTileProvider* findTileProviderForOverlay(
      CesiumRasterOverlays::RasterOverlay& overlay) noexcept;

  const CesiumRasterOverlays::RasterOverlayTileProvider*
  findTileProviderForOverlay(
      const CesiumRasterOverlays::RasterOverlay& overlay) const noexcept;

  CesiumRasterOverlays::RasterOverlayTileProvider*
  findPlaceholderTileProviderForOverlay(
      CesiumRasterOverlays::RasterOverlay& overlay) noexcept;

  const CesiumRasterOverlays::RasterOverlayTileProvider*
  findPlaceholderTileProviderForOverlay(
      const CesiumRasterOverlays::RasterOverlay& overlay) const noexcept;

  typedef std::vector<CesiumUtility::IntrusivePointer<
      CesiumRasterOverlays::RasterOverlay>>::const_iterator const_iterator;

  const_iterator begin() const noexcept;

  const_iterator end() const noexcept;

  size_t size() const noexcept;
 
private:
  // We store the list of overlays and tile providers in this separate class
  // so that we can separate its lifetime from the lifetime of the
  // RasterOverlayCollection. We need to do this because the async operations
  // that create tile providers from overlays need to have somewhere to write
  // the result. And we can't extend the lifetime of the entire
  // RasterOverlayCollection until the async operations complete because the
  // RasterOverlayCollection has a LoadedTileEnumerator, which is owned
  // externally and may become invalid before the async operations complete.
  struct OverlayList
      : public CesiumUtility::ReferenceCountedNonThreadSafe<OverlayList> {
    std::vector<
        CesiumUtility::IntrusivePointer<CesiumRasterOverlays::RasterOverlay>>
        overlays{};
    std::vector<CesiumUtility::IntrusivePointer<
        CesiumRasterOverlays::RasterOverlayTileProvider>>
        tileProviders{};
    std::vector<CesiumUtility::IntrusivePointer<
        CesiumRasterOverlays::RasterOverlayTileProvider>>
        placeholders{};
  };
 
  LoadedTileEnumerator _loadedTiles;
  TilesetExternals _externals;
  CesiumGeospatial::Ellipsoid _ellipsoid;
  CesiumUtility::IntrusivePointer<OverlayList> _pOverlays;
  CESIUM_TRACE_DECLARE_TRACK_SET(_loadingSlots, "Raster Overlay Loading Slot")
};
 
} // namespace Cesium3DTilesSelection