RasterOverlayTile.h

#pragma once
 
#include <CesiumAsync/AsyncSystem.h>
#include <CesiumAsync/IAssetRequest.h>
#include <CesiumGeometry/Rectangle.h>
#include <CesiumUtility/IntrusivePointer.h>
#include <CesiumUtility/ReferenceCounted.h>
 
#include <vector>
 
namespace CesiumUtility {
struct Credit;
}
 
namespace CesiumImage {
struct ImageAsset;
}
 
namespace CesiumRasterOverlays {
 
class ActivatedRasterOverlay;
class RasterOverlay;
class RasterOverlayTileProvider;

class RasterOverlayTile final
    : public CesiumUtility::ReferenceCountedNonThreadSafe<RasterOverlayTile> {
public:
  enum class LoadState {
    Placeholder = -2,

    Failed = -1,

    Unloaded = 0,

    Loading = 1,

    Loaded = 2,

    Done = 3
  };

  enum class MoreDetailAvailable {

    No = 0,

    Yes = 1,

    Unknown = 2
  };

  RasterOverlayTile(ActivatedRasterOverlay& activatedOverlay) noexcept;

  RasterOverlayTile(
      ActivatedRasterOverlay& activatedOverlay,
      const glm::dvec2& targetScreenPixels,
      const CesiumGeometry::Rectangle& imageryRectangle) noexcept;

  ~RasterOverlayTile();

  ActivatedRasterOverlay& getActivatedOverlay() noexcept;

  const ActivatedRasterOverlay& getActivatedOverlay() const noexcept;

  RasterOverlayTileProvider& getTileProvider() noexcept;

  const RasterOverlayTileProvider& getTileProvider() const noexcept;

  const RasterOverlay& getOverlay() const noexcept;

  const CesiumGeometry::Rectangle& getRectangle() const noexcept {
    return this->_rectangle;
  }

  glm::dvec2 getTargetScreenPixels() const noexcept {
    return this->_targetScreenPixels;
  }

  LoadState getState() const noexcept { return this->_state; }

  const std::vector<CesiumUtility::Credit>& getCredits() const noexcept {
    return this->_tileCredits;
  }

  CesiumUtility::IntrusivePointer<const CesiumImage::ImageAsset>
  getImage() const noexcept {
    return this->_pImage;
  }

  CesiumUtility::IntrusivePointer<CesiumImage::ImageAsset> getImage() noexcept {
    return this->_pImage;
  }

  void loadInMainThread();

  void* getRendererResources() const noexcept {
    return this->_pRendererResources;
  }

  void setRendererResources(void* pValue) noexcept {
    this->_pRendererResources = pValue;
  }

  MoreDetailAvailable isMoreDetailAvailable() const noexcept {
    return this->_moreDetailAvailable;
  }

  void setState(LoadState newState) noexcept;
 
private:
  friend class ActivatedRasterOverlay;
 
  // This is a raw pointer instead of an IntrusivePointer in order to avoid
  // circular references, particularly among a placeholder tile provider and
  // placeholder tile. However, to avoid undefined behavior, the tile provider
  // is required to outlive the tile. In normal use, the RasterOverlayCollection
  // ensures that this is true.
  ActivatedRasterOverlay* _pActivatedOverlay;
  glm::dvec2 _targetScreenPixels;
  CesiumGeometry::Rectangle _rectangle;
  std::vector<CesiumUtility::Credit> _tileCredits;
  LoadState _state;
  CesiumUtility::IntrusivePointer<CesiumImage::ImageAsset> _pImage;
  void* _pRendererResources;
  MoreDetailAvailable _moreDetailAvailable;
};
} // namespace CesiumRasterOverlays