A raster overlay that directly accesses a Web Map Tile Service (WMTS) server. More...

#include <CesiumWebMapTileServiceRasterOverlay.h>

Inheritance diagram for UCesiumWebMapTileServiceRasterOverlay:

Public Member Functions
virtual void	Serialize (FArchive &Ar) override

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

Public Attributes
FString	BaseUrl
	The base URL of the Web Map Tile Service (WMTS).

FString	Layer
	The layer name for WMTS requests.

FString	Style
	The style name for WMTS requests.

FString	Format = "image/jpeg"
	The MIME type for images to retrieve from the server.

FString	TileMatrixSetID
	The tile matrix set identifier for WMTS requests.

FString	TileMatrixSetLabelPrefix
	The prefix to use for the tile matrix set labels.

bool	bSpecifyTileMatrixSetLabels = false
	Set this to true to specify tile matrix set labels manually.

TArray< FString >	TileMatrixSetLabels
	The manually specified tile matrix set labels.

bool	UseWebMercatorProjection_DEPRECATED

ECesiumWebMapTileServiceRasterOverlayProjection	Projection
	The type of projection used to project the WMTS imagery onto the globe.

bool	bSpecifyTilingScheme = false
	Set this to true to specify the quadtree tiling scheme according to the specified root tile numbers and projected bounding rectangle.

int32	RootTilesX = 1
	The number of tiles corresponding to TileCol, also known as TileMatrixWidth.

int32	RootTilesY = 1
	The number of tiles corresponding to TileRow, also known as TileMatrixHeight.

double	RectangleWest = -180
	The west boundary of the bounding rectangle used for the quadtree tiling scheme.

double	RectangleSouth = -90
	The south boundary of the bounding rectangle used for the quadtree tiling scheme.

double	RectangleEast = 180
	The east boundary of the bounding rectangle used for the quadtree tiling scheme.

double	RectangleNorth = 90
	The north boundary of the bounding rectangle used for the quadtree tiling scheme.

bool	bSpecifyZoomLevels = false
	Set this to true to directly specify the minimum and maximum zoom levels available from the server.

int32	MinimumLevel = 0
	Minimum zoom level.

int32	MaximumLevel = 25
	Maximum zoom level.

int32	TileWidth = 256
	The pixel width of the image tiles.

int32	TileHeight = 256
	The pixel height of the image tiles.

TMap< FString, FString >	RequestHeaders
	HTTP headers to be attached to each request made for this raster overlay.

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::RasterOverlay >	CreateOverlay (const CesiumRasterOverlays::RasterOverlayOptions &options={}) override

Protected Member Functions inherited from UCesiumRasterOverlay
Cesium3DTilesSelection::Tileset *	FindTileset () const

virtual void	OnAdd (Cesium3DTilesSelection::Tileset pTileset, CesiumRasterOverlays::RasterOverlay pOverlay)

virtual void	OnRemove (Cesium3DTilesSelection::Tileset pTileset, CesiumRasterOverlays::RasterOverlay pOverlay)

Additional Inherited Members
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 a Web Map Tile Service (WMTS) server.

If you're using a Web Map Tile Service via Cesium ion, use the "Cesium ion Raster Overlay" component instead.

Definition at line 33 of file CesiumWebMapTileServiceRasterOverlay.h.

Member Function Documentation

◆ CreateOverlay()

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

overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

◆ Serialize()

virtual void UCesiumWebMapTileServiceRasterOverlay::Serialize ( FArchive & Ar )

overridevirtual

Member Data Documentation

◆ BaseUrl

FString UCesiumWebMapTileServiceRasterOverlay::BaseUrl

The base URL of the Web Map Tile Service (WMTS).

This URL should not include query parameters. For example: https://tile.openstreetmap.org/{TileMatrix}/{TileCol}/{TileRow}.png

Definition at line 44 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ bSpecifyTileMatrixSetLabels

bool UCesiumWebMapTileServiceRasterOverlay::bSpecifyTileMatrixSetLabels = false

Set this to true to specify tile matrix set labels manually.

If false, the labels will be constructed from the specified levels and prefix (if one is specified).

Definition at line 89 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ bSpecifyTilingScheme

bool UCesiumWebMapTileServiceRasterOverlay::bSpecifyTilingScheme = false

Set this to true to specify the quadtree tiling scheme according to the specified root tile numbers and projected bounding rectangle.

If false, the tiling scheme will be deduced from the projection.

Definition at line 123 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ bSpecifyZoomLevels

bool UCesiumWebMapTileServiceRasterOverlay::bSpecifyZoomLevels = false

Set this to true to directly specify the minimum and maximum zoom levels available from the server.

If false, the minimum and maximum zoom levels will be retrieved from the server's tilemapresource.xml file.

Definition at line 224 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ Format

FString UCesiumWebMapTileServiceRasterOverlay::Format = "image/jpeg"

The MIME type for images to retrieve from the server.

Definition at line 62 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ Layer

FString UCesiumWebMapTileServiceRasterOverlay::Layer

The layer name for WMTS requests.

Definition at line 50 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ MaximumLevel

int32 UCesiumWebMapTileServiceRasterOverlay::MaximumLevel = 25

Maximum zoom level.

Definition at line 248 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ MinimumLevel

int32 UCesiumWebMapTileServiceRasterOverlay::MinimumLevel = 0

Minimum zoom level.

Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.

Definition at line 238 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ Projection

ECesiumWebMapTileServiceRasterOverlayProjection UCesiumWebMapTileServiceRasterOverlay::Projection

Initial value:

=

ECesiumWebMapTileServiceRasterOverlayProjection::WebMercator

@ WebMercator

The raster overlay is projected using Web Mercator.

The type of projection used to project the WMTS imagery onto the globe.

For instance, EPSG:4326 uses geographic projection and EPSG:3857 uses Web Mercator.

Definition at line 114 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ RectangleEast

double UCesiumWebMapTileServiceRasterOverlay::RectangleEast = 180

The east boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in longitude degrees in the range [-180, 180].

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 200 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ RectangleNorth

double UCesiumWebMapTileServiceRasterOverlay::RectangleNorth = 90

The north boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in latitude degrees in the range [-90, 90].

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 216 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ RectangleSouth

double UCesiumWebMapTileServiceRasterOverlay::RectangleSouth = -90

The south boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in latitude degrees in the range [-90, 90].

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 184 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ RectangleWest

double UCesiumWebMapTileServiceRasterOverlay::RectangleWest = -180

The west boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in longitude degrees in the range [-180, 180].

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 167 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ RequestHeaders

TMap<FString, FString> UCesiumWebMapTileServiceRasterOverlay::RequestHeaders

HTTP headers to be attached to each request made for this raster overlay.

Definition at line 274 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ RootTilesX

int32 UCesiumWebMapTileServiceRasterOverlay::RootTilesX = 1

The number of tiles corresponding to TileCol, also known as TileMatrixWidth.

If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the X direction.

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 137 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ RootTilesY

int32 UCesiumWebMapTileServiceRasterOverlay::RootTilesY = 1

The number of tiles corresponding to TileRow, also known as TileMatrixHeight.

If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the Y direction.

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 151 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ Style

FString UCesiumWebMapTileServiceRasterOverlay::Style

The style name for WMTS requests.

Definition at line 56 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ TileHeight

int32 UCesiumWebMapTileServiceRasterOverlay::TileHeight = 256

The pixel height of the image tiles.

Definition at line 268 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ TileMatrixSetID

FString UCesiumWebMapTileServiceRasterOverlay::TileMatrixSetID

The tile matrix set identifier for WMTS requests.

Definition at line 68 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ TileMatrixSetLabelPrefix

FString UCesiumWebMapTileServiceRasterOverlay::TileMatrixSetLabelPrefix

The prefix to use for the tile matrix set labels.

For instance, setting "EPSG:4326:" as prefix generates label list ["EPSG:4326:0", "EPSG:4326:1", "EPSG:4326:2", ...] Only applicable when "Specify Tile Matrix Set Labels" is false.

Definition at line 81 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ TileMatrixSetLabels

TArray<FString> UCesiumWebMapTileServiceRasterOverlay::TileMatrixSetLabels

The manually specified tile matrix set labels.

Only applicable when "Specify Tile Matrix Set Labels" is true.

Definition at line 101 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ TileWidth

int32 UCesiumWebMapTileServiceRasterOverlay::TileWidth = 256

The pixel width of the image tiles.

Definition at line 258 of file CesiumWebMapTileServiceRasterOverlay.h.

◆ UseWebMercatorProjection_DEPRECATED

bool UCesiumWebMapTileServiceRasterOverlay::UseWebMercatorProjection_DEPRECATED

Definition at line 106 of file CesiumWebMapTileServiceRasterOverlay.h.

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

Source/CesiumRuntime/Public/CesiumWebMapTileServiceRasterOverlay.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateOverlay()

◆ Serialize()

Member Data Documentation

◆ BaseUrl

◆ bSpecifyTileMatrixSetLabels

◆ bSpecifyTilingScheme

◆ bSpecifyZoomLevels

◆ Format

◆ Layer

◆ MaximumLevel

◆ MinimumLevel

◆ Projection

◆ RectangleEast

◆ RectangleNorth

◆ RectangleSouth

◆ RectangleWest

◆ RequestHeaders

◆ RootTilesX

◆ RootTilesY

◆ Style

◆ TileHeight

◆ TileMatrixSetID

◆ TileMatrixSetLabelPrefix

◆ TileMatrixSetLabels

◆ TileWidth

◆ UseWebMercatorProjection_DEPRECATED