CesiumVectorOverlays::VectorTilesRasterOverlay Class Reference

A raster overlay made from rasterizing a vector tiles tileset. More...

#include <CesiumVectorOverlays/VectorTilesRasterOverlay.h>

Inheritance diagram for CesiumVectorOverlays::VectorTilesRasterOverlay:

Public Member Functions
	VectorTilesRasterOverlay (const std::string &name, const std::string &url, const VectorTilesRasterOverlayOptions &vectorOptions={}, const CesiumRasterOverlays::RasterOverlayOptions &overlayOptions={})
	Creates a new VectorTilesRasterOverlay from a URL.
	VectorTilesRasterOverlay (const std::string &name, int64_t ionAssetID, const std::string &ionAccessToken, const std::string &ionAssetEndpointUrl="https://api.cesium.com/", const VectorTilesRasterOverlayOptions &vectorOptions={}, const CesiumRasterOverlays::RasterOverlayOptions &overlayOptions={})
	Creates a new VectorTilesRasterOverlay from a Cesium ion asset.
virtual CesiumAsync::Future< CreateTileProviderResult >	createTileProvider (const CesiumRasterOverlays::CreateRasterOverlayTileProviderParameters &parameters) 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.
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.
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.

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 raster overlay made from rasterizing a vector tiles tileset.

Definition at line 27 of file VectorTilesRasterOverlay.h.

Constructor & Destructor Documentation

VectorTilesRasterOverlay() [1/2]

CesiumVectorOverlays::VectorTilesRasterOverlay::VectorTilesRasterOverlay	(	const std::string &	name,
		const std::string &	url,
		const VectorTilesRasterOverlayOptions &	vectorOptions = {},
		const CesiumRasterOverlays::RasterOverlayOptions &	overlayOptions = {} )

Creates a new VectorTilesRasterOverlay from a URL.

Parameters

name	The user-given name of this layer.
url	The URL of the tileset to load.
vectorOptions	Options to configure this VectorTilesRasterOverlay.
overlayOptions	Options to use for this RasterOverlay.

VectorTilesRasterOverlay() [2/2]

CesiumVectorOverlays::VectorTilesRasterOverlay::VectorTilesRasterOverlay	(	const std::string &	name,
		int64_t	ionAssetID,
		const std::string &	ionAccessToken,
		const std::string &	ionAssetEndpointUrl = "https://api.cesium.com/",
		const VectorTilesRasterOverlayOptions &	vectorOptions = {},
		const CesiumRasterOverlays::RasterOverlayOptions &	overlayOptions = {} )

Creates a new VectorTilesRasterOverlay from a Cesium ion asset.

Parameters

name	The user-given name of this layer.
ionAssetID	The ion asset ID of the tileset.
ionAccessToken	The ion access token to use to access the tileset.
ionAssetEndpointUrl	The ion asset endpoint URL to use to access the tileset.
vectorOptions	Options to configure this VectorTilesRasterOverlay.
overlayOptions	Options to use for this RasterOverlay.

Member Function Documentation

createTileProvider()

virtual CesiumAsync::Future< CreateTileProviderResult > CesiumVectorOverlays::VectorTilesRasterOverlay::createTileProvider ( const CesiumRasterOverlays::CreateRasterOverlayTileProviderParameters & parameters ) const

overridevirtual

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

Parameters

parameters

The parameters for creating the tile provider.

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/CesiumVectorOverlays/include/CesiumVectorOverlays/VectorTilesRasterOverlay.h