CesiumRasterOverlays::IonRasterOverlay Class Reference

A RasterOverlay that obtains imagery data from Cesium ion. More...

#include <CesiumRasterOverlays/IonRasterOverlay.h>

Inheritance diagram for CesiumRasterOverlays::IonRasterOverlay:

Public Member Functions
	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.

Protected Member Functions
	IonRasterOverlay (const std::string &name, const std::string &overlayUrl, const std::string &ionAccessToken, bool needsAuthHeader, const RasterOverlayOptions &overlayOptions={})
	Creates a new 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.

Detailed Description

A RasterOverlay that obtains imagery data from Cesium ion.

Definition at line 15 of file IonRasterOverlay.h.

Constructor & Destructor Documentation

IonRasterOverlay() [1/2]

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.

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

Parameters

name	The user-given name of this overlay layer.
ionAssetID	The asset ID.
ionAccessToken	The access token.
overlayOptions	The RasterOverlayOptions for this instance.
ionAssetEndpointUrl	The URL of the ion endpoint to make our requests to.

IonRasterOverlay() [2/2]

CesiumRasterOverlays::IonRasterOverlay::IonRasterOverlay ( const std::string & name, const std::string & overlayUrl, const std::string & ionAccessToken, bool needsAuthHeader, const RasterOverlayOptions & overlayOptions = {} )

protected

Creates a new instance.

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

Parameters

name	The user-given name of this overlay layer.
overlayUrl	The URL that the raster overlay requests will be made to.
ionAccessToken	The access token.
needsAuthHeader	If true, the access token will be passed through the Authorization header. If false, it will be assumed to be in the provided overlayUrl.
overlayOptions	The RasterOverlayOptions for this instance.

Member Function Documentation

createTileProvider()

virtual CesiumAsync::Future< CreateTileProviderResult > CesiumRasterOverlays::IonRasterOverlay::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

overridevirtual

Begins asynchronous creation of a tile provider for this overlay and eventually returns it via a Future.

Parameters

asyncSystem	The async system used to do work in threads.
pAssetAccessor	The interface used to download assets like overlay metadata and tiles.
pCreditSystem	The CesiumUtility::CreditSystem to use when creating a per-TileProvider CesiumUtility::Credit.
pPrepareRendererResources	The interface used to prepare raster images for rendering.
pLogger	The logger to which to send messages about the tile provider and tiles.
pOwner	The overlay that owns this overlay, or nullptr if this overlay is not aggregated.

Returns

The future that resolves to the tile provider when it is ready, or to error details in the case of an error.

Implements CesiumRasterOverlays::RasterOverlay.

---

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

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