A raster overlay that loads tiles from a templated URL. More...

#include <CesiumUrlTemplateRasterOverlay.h>

Inheritance diagram for UCesiumUrlTemplateRasterOverlay:

Public Attributes
FString	TemplateUrl
	The URL containing template parameters that will be substituted when loading tiles.

ECesiumUrlTemplateRasterOverlayProjection	Projection
	The type of projection used to project the 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
	If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the X direction.

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

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.

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
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 loads tiles from a templated URL.

Definition at line 31 of file CesiumUrlTemplateRasterOverlay.h.

Member Function Documentation

◆ CreateOverlay()

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

overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

Member Data Documentation

◆ bSpecifyTilingScheme

bool UCesiumUrlTemplateRasterOverlay::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 86 of file CesiumUrlTemplateRasterOverlay.h.

◆ MaximumLevel

int32 UCesiumUrlTemplateRasterOverlay::MaximumLevel = 25

Maximum zoom level.

Definition at line 201 of file CesiumUrlTemplateRasterOverlay.h.

◆ MinimumLevel

int32 UCesiumUrlTemplateRasterOverlay::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 191 of file CesiumUrlTemplateRasterOverlay.h.

◆ Projection

ECesiumUrlTemplateRasterOverlayProjection UCesiumUrlTemplateRasterOverlay::Projection

Initial value:

=

ECesiumUrlTemplateRasterOverlayProjection::WebMercator

@ WebMercator

The raster overlay is projected using Web Mercator.

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

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

Definition at line 77 of file CesiumUrlTemplateRasterOverlay.h.

◆ RectangleEast

double UCesiumUrlTemplateRasterOverlay::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 161 of file CesiumUrlTemplateRasterOverlay.h.

◆ RectangleNorth

double UCesiumUrlTemplateRasterOverlay::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 177 of file CesiumUrlTemplateRasterOverlay.h.

◆ RectangleSouth

double UCesiumUrlTemplateRasterOverlay::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 145 of file CesiumUrlTemplateRasterOverlay.h.

◆ RectangleWest

double UCesiumUrlTemplateRasterOverlay::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 128 of file CesiumUrlTemplateRasterOverlay.h.

◆ RequestHeaders

TMap<FString, FString> UCesiumUrlTemplateRasterOverlay::RequestHeaders

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

Definition at line 227 of file CesiumUrlTemplateRasterOverlay.h.

◆ RootTilesX

int32 UCesiumUrlTemplateRasterOverlay::RootTilesX = 1

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 99 of file CesiumUrlTemplateRasterOverlay.h.

◆ RootTilesY

int32 UCesiumUrlTemplateRasterOverlay::RootTilesY = 1

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 112 of file CesiumUrlTemplateRasterOverlay.h.

◆ TemplateUrl

FString UCesiumUrlTemplateRasterOverlay::TemplateUrl

The URL containing template parameters that will be substituted when loading tiles.

The following template parameters are supported in url:

{x} - The tile X coordinate in the tiling scheme, where 0 is the westernmost tile.
{y} - The tile Y coordinate in the tiling scheme, where 0 is the nothernmost tile.
{z} - The level of the tile in the tiling scheme, where 0 is the root of the quadtree pyramid.
{reverseX} - The tile X coordinate in the tiling scheme, where 0 is the easternmost tile.
{reverseY} - The tile Y coordinate in the tiling scheme, where 0 is the southernmost tile.
{reverseZ} - The tile Z coordinate in the tiling scheme, where 0 is equivalent to urlTemplateOptions.maximumLevel.
{westDegrees} - The western edge of the tile in geodetic degrees.
{southDegrees} - The southern edge of the tile in geodetic degrees.
{eastDegrees} - The eastern edge of the tile in geodetic degrees.
{northDegrees} - The northern edge of the tile in geodetic degrees.
{minimumX} - The minimum X coordinate of the tile's projected coordinates.
{minimumY} - The minimum Y coordinate of the tile's projected coordinates.
{maximumX} - The maximum X coordinate of the tile's projected coordinates.
{maximumY} - The maximum Y coordinate of the tile's projected coordinates.
{width} - The width of each tile in pixels.
{height} - The height of each tile in pixels.

Definition at line 69 of file CesiumUrlTemplateRasterOverlay.h.

◆ TileHeight

int32 UCesiumUrlTemplateRasterOverlay::TileHeight = 256

The pixel height of the image tiles.

Definition at line 221 of file CesiumUrlTemplateRasterOverlay.h.

◆ TileWidth

int32 UCesiumUrlTemplateRasterOverlay::TileWidth = 256

The pixel width of the image tiles.

Definition at line 211 of file CesiumUrlTemplateRasterOverlay.h.

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

Source/CesiumRuntime/Public/CesiumUrlTemplateRasterOverlay.h

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateOverlay()

Member Data Documentation

◆ bSpecifyTilingScheme

◆ MaximumLevel

◆ MinimumLevel

◆ Projection

◆ RectangleEast

◆ RectangleNorth

◆ RectangleSouth

◆ RectangleWest

◆ RequestHeaders

◆ RootTilesX

◆ RootTilesY

◆ TemplateUrl

◆ TileHeight

◆ TileWidth