The base class for a rasterized image that can be draped over a Cesium3DTilesSelection::Tileset. The image may be very, very high resolution, so only small pieces of it are mapped to the Tileset at a time. More...

#include <CesiumRasterOverlays/RasterOverlay.h>

Inheritance diagram for CesiumRasterOverlays::RasterOverlay:

Public Types
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.

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

CesiumUtility::IntrusivePointer< ActivatedRasterOverlay >	activate (const RasterOverlayExternals &externals, const CesiumGeospatial::Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84) const
	Activates this overlay.

CesiumUtility::IntrusivePointer< RasterOverlayTileProvider >	createPlaceholder (const RasterOverlayExternals &externals, 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.

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 =0
	Begins asynchronous creation of a tile provider for this overlay and eventually returns it via a Future.

Public Member Functions inherited from CesiumUtility::ReferenceCounted< T, false >
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.

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.

Detailed Description

The base class for a rasterized image that can be draped over a Cesium3DTilesSelection::Tileset. The image may be very, very high resolution, so only small pieces of it are mapped to the Tileset at a time.

Instances of this class can be added to the Cesium3DTilesSelection::RasterOverlayCollection that is returned by Cesium3DTilesSelection::Tileset::getOverlays.

Instances of this class must be allocated on the heap, and their lifetimes must be managed with CesiumUtility::IntrusivePointer.

See also: BingMapsRasterOverlay; IonRasterOverlay; TileMapServiceRasterOverlay; WebMapServiceRasterOverlay

Definition at line 136 of file RasterOverlay.h.

Member Typedef Documentation

◆ CreateTileProviderResult

using CesiumRasterOverlays::RasterOverlay::CreateTileProviderResult

Initial value:

 nonstd::expected<
      CesiumUtility::IntrusivePointer<RasterOverlayTileProvider>,
      RasterOverlayLoadFailureDetails>

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.

Definition at line 214 of file RasterOverlay.h.

Constructor & Destructor Documentation

◆ RasterOverlay()

CesiumRasterOverlays::RasterOverlay::RasterOverlay	(	const std::string &	name,
		const RasterOverlayOptions &	overlayOptions = RasterOverlayOptions() )

Creates a new instance.

Parameters

name	The user-given name of this overlay layer.
overlayOptions	The `RasterOverlayOptions` for this instance.

Member Function Documentation

◆ activate()

CesiumUtility::IntrusivePointer< ActivatedRasterOverlay > CesiumRasterOverlays::RasterOverlay::activate	(	const RasterOverlayExternals &	externals,
		const CesiumGeospatial::Ellipsoid &	ellipsoid = CesiumGeospatial::Ellipsoid::WGS84 ) const

Activates this overlay.

This method is called by a Cesium3DTilesSelection::RasterOverlayCollection when an overlay is added to it. The returned ActivatedRasterOverlay is used by the collection to manage the overlay.

Parameters

externals	The external interfaces for use by the raster overlay.
ellipsoid	The CesiumGeospatial::Ellipsoid.

Returns: The activated overlay.

◆ createPlaceholder()

CesiumUtility::IntrusivePointer< RasterOverlayTileProvider > CesiumRasterOverlays::RasterOverlay::createPlaceholder	(	const RasterOverlayExternals &	externals,
		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.

Parameters

externals	The external interfaces for use by the raster overlay.
ellipsoid	The `CesiumGeospatial::Ellipsoid`.

Returns: The placeholder.

◆ createTileProvider()

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

pure virtual

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.

◆ getAsyncDestructionCompleteEvent()

CesiumAsync::SharedFuture< void > & CesiumRasterOverlays::RasterOverlay::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.

Parameters

asyncSystem The AsyncSystem to use for the returned SharedFuture, if required. If this method is called multiple times, all invocations must pass CesiumAsync::AsyncSystem instances that compare equal to each other.

◆ getName()

const std::string & CesiumRasterOverlays::RasterOverlay::getName ( ) const

inlinenoexcept

Gets the name of this overlay.

Definition at line 165 of file RasterOverlay.h.

◆ getOptions() [1/2]

const RasterOverlayOptions & CesiumRasterOverlays::RasterOverlay::getOptions ( ) const

inlinenoexcept

Gets options for this overlay.

Definition at line 173 of file RasterOverlay.h.

◆ getOptions() [2/2]

RasterOverlayOptions & CesiumRasterOverlays::RasterOverlay::getOptions ( )

inlinenoexcept

Gets options for this overlay.

Definition at line 170 of file RasterOverlay.h.

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

/home/runner/work/cesium-native/cesium-native/CesiumRasterOverlays/include/CesiumRasterOverlays/RasterOverlay.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ CreateTileProviderResult

Constructor & Destructor Documentation

◆ RasterOverlay()

Member Function Documentation

◆ activate()

◆ createPlaceholder()

◆ createTileProvider()

◆ getAsyncDestructionCompleteEvent()

◆ getName()

◆ getOptions() [1/2]

◆ getOptions() [2/2]