CesiumRasterOverlays::BingMapsRasterOverlay Class Referencefinal
A RasterOverlay that uses Bing Maps as the source for the imagery data. More...
#include <CesiumRasterOverlays/BingMapsRasterOverlay.h>
Inheritance diagram for CesiumRasterOverlays::BingMapsRasterOverlay:
Public Member Functions | |
| BingMapsRasterOverlay (const std::string &name, const std::string &url, const std::string &key, const std::string &mapStyle=BingMapsStyle::AERIAL, const std::string &culture="", const CesiumGeospatial::Ellipsoid &ellipsoid=CesiumGeospatial::Ellipsoid::WGS84, const RasterOverlayOptions &overlayOptions={}) | |
| Creates a new instance. More... | |
| 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. More... | |
 Public Member Functions inherited from CesiumRasterOverlays::RasterOverlay | |
| RasterOverlay (const std::string &name, const RasterOverlayOptions &overlayOptions=RasterOverlayOptions()) | |
| Creates a new instance. More... | |
| 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. More... | |
| 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. More... | |
| 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 CESIUM_DEFAULT_ELLIPSOID) const |
| Create a placeholder tile provider can be used in place of the real one while createTileProvider completes asynchronously. More... | |
| 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 = nonstd::expected< CesiumUtility::IntrusivePointer< RasterOverlayTileProvider >, RasterOverlayLoadFailureDetails > |
Detailed Description
A RasterOverlay that uses Bing Maps as the source for the imagery data.
Definition at line 82 of file BingMapsRasterOverlay.h.
Constructor & Destructor Documentation
◆ BingMapsRasterOverlay()
| CesiumRasterOverlays::BingMapsRasterOverlay::BingMapsRasterOverlay | ( | const std::string & | name, |
| const std::string & | url, | ||
| const std::string & | key, | ||
| const std::string & | mapStyle = BingMapsStyle::AERIAL, |
||
| const std::string & | culture = "", |
||
| const CesiumGeospatial::Ellipsoid & | ellipsoid = CesiumGeospatial::Ellipsoid::WGS84, |
||
| const RasterOverlayOptions & | overlayOptions = {} |
||
| ) |
Creates a new instance.
- Parameters
-
name The user-given name of this overlay layer. url The url of the Bing Maps server hosting the imagery. key The Bing Maps key for your application, which can be created at https://www.bingmapsportal.com/. mapStyle The type of Bing Maps imagery to load. A value from BingMapsStyle, with BingMapsStyle::AERIAL being the default. culture The culture to use when requesting Bing Maps imagery. Not all cultures are supported. See http://msdn.microsoft.com/en-us/library/hh441729.aspx for information on the supported cultures. ellipsoid The ellipsoid. Default value: CesiumGeospatial::Ellipsoid::WGS84. overlayOptions The RasterOverlayOptions for this instance.
Member Function Documentation
◆ createTileProvider()
|
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 CreditSystem to use when creating a per-TileProvider 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/BingMapsRasterOverlay.h
