CesiumRasterOverlays::ITwinCesiumCuratedContentRasterOverlay Class Reference

A RasterOverlay that obtains imagery data from the iTwin Cesium Curated Content API. More...

#include <CesiumRasterOverlays/ITwinCesiumCuratedContentRasterOverlay.h>

Inheritance diagram for CesiumRasterOverlays::ITwinCesiumCuratedContentRasterOverlay:

Public Member Functions
	ITwinCesiumCuratedContentRasterOverlay (const std::string &name, int64_t assetID, const std::string &iTwinAccessToken, const RasterOverlayOptions &overlayOptions={})
	Creates a new instance.
Public Member Functions inherited from CesiumRasterOverlays::IonRasterOverlay
	IonRasterOverlay (const std::string &name, int64_t ionAssetID, const std::string &ionAccessToken, const RasterOverlayOptions &overlayOptions={}, const std::string &ionAssetEndpointUrl="https://api.cesium.com/")
	Creates a new instance.
virtual CesiumAsync::Future< CreateTileProviderResult >	createTileProvider (const CesiumAsync::AsyncSystem &asyncSystem, const std::shared_ptr< CesiumAsync::IAssetAccessor > &pAssetAccessor, const std::shared_ptr< CesiumUtility::CreditSystem > &pCreditSystem, const std::shared_ptr< IPrepareRasterOverlayRendererResources > &pPrepareRendererResources, const std::shared_ptr< spdlog::logger > &pLogger, CesiumUtility::IntrusivePointer< const RasterOverlay > pOwner) const override
	Begins asynchronous creation of a tile provider for this overlay and eventually returns it via a Future.
Public Member Functions inherited from CesiumRasterOverlays::RasterOverlay
	RasterOverlay (const std::string &name, const RasterOverlayOptions &overlayOptions=RasterOverlayOptions())
	Creates a new instance.
CesiumAsync::SharedFuture< void > &	getAsyncDestructionCompleteEvent (const CesiumAsync::AsyncSystem &asyncSystem)
	A future that resolves when this RasterOverlay has been destroyed (i.e. its destructor has been called) and all async operations that it was executing have completed.
const std::string &	getName () const noexcept
	Gets the name of this overlay.
RasterOverlayOptions &	getOptions () noexcept
	Gets options for this overlay.
const RasterOverlayOptions &	getOptions () const noexcept
	Gets options for this overlay.
const std::vector< CesiumUtility::Credit > &	getCredits () const noexcept
	Gets the credits for this overlay.
std::vector< CesiumUtility::Credit > &	getCredits () noexcept
	Gets the credits for this overlay.
CesiumUtility::IntrusivePointer< RasterOverlayTileProvider >	createPlaceholder (const CesiumAsync::AsyncSystem &asyncSystem, const std::shared_ptr< CesiumAsync::IAssetAccessor > &pAssetAccessor, const CesiumGeospatial::Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84) const
	Create a placeholder tile provider can be used in place of the real one while createTileProvider completes asynchronously.
Public Member Functions inherited from CesiumUtility::ReferenceCounted< T, isThreadSafe >
void	addReference () const
	Adds a counted reference to this object. Use CesiumUtility::IntrusivePointer instead of calling this method directly.
void	releaseReference () const
	Removes a counted reference from this object. When the last reference is removed, this method will delete this instance. Use CesiumUtility::IntrusivePointer instead of calling this method directly.
std::int32_t	getReferenceCount () const noexcept
	Returns the current reference count of this instance.

Additional Inherited Members
Public Types inherited from CesiumRasterOverlays::RasterOverlay
using	CreateTileProviderResult
	A result from a call to createTileProvider. This is expected to be an IntrusivePointer to a RasterOverlayTileProvider, but may be a RasterOverlayLoadFailureDetails if creating the tile provider wasn't successful.
Protected Member Functions inherited from CesiumRasterOverlays::IonRasterOverlay
	IonRasterOverlay (const std::string &name, const std::string &overlayUrl, const std::string &ionAccessToken, bool needsAuthHeader, const RasterOverlayOptions &overlayOptions={})
	Creates a new instance.

Detailed Description

A RasterOverlay that obtains imagery data from the iTwin Cesium Curated Content API.

Definition at line 16 of file ITwinCesiumCuratedContentRasterOverlay.h.

Constructor & Destructor Documentation

ITwinCesiumCuratedContentRasterOverlay()

CesiumRasterOverlays::ITwinCesiumCuratedContentRasterOverlay::ITwinCesiumCuratedContentRasterOverlay	(	const std::string &	name,
		int64_t	assetID,
		const std::string &	iTwinAccessToken,
		const RasterOverlayOptions &	overlayOptions = {} )

Creates a new instance.

The tiles that are provided by this instance will contain imagery data that was obtained from the iTwin CCC asset with the given ID, accessed with the given access token.

Parameters

name	The user-given name of this overlay layer.
assetID	The asset ID.
iTwinAccessToken	The access token.
overlayOptions	The RasterOverlayOptions for this instance.

---

The documentation for this class was generated from the following file:

• /home/runner/work/cesium-native/cesium-native/CesiumRasterOverlays/include/CesiumRasterOverlays/ITwinCesiumCuratedContentRasterOverlay.h