Cesium for Unreal 2.15.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UCesiumBingMapsRasterOverlay Class Reference

A raster overlay that directly accesses Bing Maps. More...

#include <CesiumBingMapsRasterOverlay.h>

Inheritance diagram for UCesiumBingMapsRasterOverlay:
UCesiumRasterOverlay

Public Attributes

FString BingMapsKey
 The Bing Maps API key to use.
 
EBingMapsStyle MapStyle = EBingMapsStyle::Aerial
 The map style to use.
 
- Public Attributes inherited from UCesiumRasterOverlay
FString MaterialLayerKey = "Overlay0"
 The key to use to match this overlay to a material layer.
 
FRasterOverlayRendererOptions rendererOptions
 Sets the texture filter and texture group of raster tile images.
 

Protected Member Functions

virtual std::unique_ptr< CesiumRasterOverlays::RasterOverlayCreateOverlay (const CesiumRasterOverlays::RasterOverlayOptions &options={}) override
 
- Protected Member Functions inherited from UCesiumRasterOverlay
Cesium3DTilesSelection::TilesetFindTileset () const
 
virtual void OnAdd (Cesium3DTilesSelection::Tileset *pTileset, CesiumRasterOverlays::RasterOverlay *pOverlay)
 
virtual void OnRemove (Cesium3DTilesSelection::Tileset *pTileset, CesiumRasterOverlays::RasterOverlay *pOverlay)
 

Additional Inherited Members

- Public Member Functions inherited from UCesiumRasterOverlay
 UCesiumRasterOverlay ()
 
void AddToTileset ()
 Displays this raster overlay on its owning Cesium 3D Tileset Actor, without changing its activation state.
 
void RemoveFromTileset ()
 Stops displaying this raster overlay on its owning Cesium 3D Tileset Actor.
 
void Refresh ()
 Refreshes this overlay by removing from its owning Cesium 3D Tileset Actor and re-adding it.
 
double GetMaximumScreenSpaceError () const
 
void SetMaximumScreenSpaceError (double Value)
 
int32 GetMaximumTextureSize () const
 
void SetMaximumTextureSize (int32 Value)
 
int32 GetMaximumSimultaneousTileLoads () const
 
void SetMaximumSimultaneousTileLoads (int32 Value)
 
int64 GetSubTileCacheBytes () const
 
void SetSubTileCacheBytes (int64 Value)
 
virtual void Activate (bool bReset) override
 Activates this raster overlay, which will display it on the Cesium3DTileset to which the component is attached, if it isn't already displayed.
 
virtual void Deactivate () override
 Deactivates this raster overlay.
 
virtual void OnComponentDestroyed (bool bDestroyingHierarchy) override
 
virtual bool IsReadyForFinishDestroy () override
 
- Protected Attributes inherited from UCesiumRasterOverlay
double MaximumScreenSpaceError = 2.0
 The maximum number of pixels of error when rendering this overlay.
 
int32 MaximumTextureSize = 2048
 The maximum texel size of raster overlay textures, in either direction.
 
int32 MaximumSimultaneousTileLoads = 20
 The maximum number of overlay tiles that may simultaneously be in the process of loading.
 
int64 SubTileCacheBytes = 16 * 1024 * 1024
 The maximum number of bytes to use to cache sub-tiles in memory.
 
bool ShowCreditsOnScreen
 Whether or not to show credits of this raster overlay on screen.
 

Detailed Description

A raster overlay that directly accesses Bing Maps.

If you're using Bing Maps via Cesium ion, use the "Cesium ion Raster Overlay" component instead.

Definition at line 26 of file CesiumBingMapsRasterOverlay.h.

Member Function Documentation

◆ CreateOverlay()

virtual std::unique_ptr< CesiumRasterOverlays::RasterOverlay > UCesiumBingMapsRasterOverlay::CreateOverlay ( const CesiumRasterOverlays::RasterOverlayOptions & options = {})
overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

Member Data Documentation

◆ BingMapsKey

FString UCesiumBingMapsRasterOverlay::BingMapsKey

The Bing Maps API key to use.

Definition at line 35 of file CesiumBingMapsRasterOverlay.h.

◆ MapStyle

EBingMapsStyle UCesiumBingMapsRasterOverlay::MapStyle = EBingMapsStyle::Aerial

The map style to use.

Definition at line 41 of file CesiumBingMapsRasterOverlay.h.


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