A raster overlay that directly accesses Google Map Tiles (2D). More...

#include <CesiumGoogleMapTilesRasterOverlay.h>

Inheritance diagram for UCesiumGoogleMapTilesRasterOverlay:

Public Attributes
FString	Key
	The Google Map Tiles API key to use.

EGoogleMapTilesMapType	MapType = EGoogleMapTilesMapType::Satellite
	The type of base map.

FString	Language = "en-US"
	An IETF language tag that specifies the language used to display information on the tiles.

FString	Region = "US"
	A Common Locale Data Repository region identifier (two uppercase letters) that represents the physical location of the user.

EGoogleMapTilesScale	Scale = EGoogleMapTilesScale::ScaleFactor1x
	Scales-up the size of map elements (such as road labels), while retaining the tile size and coverage area of the default tile.

bool	HighDPI = false
	Specifies whether to return high-resolution tiles.

TArray< EGoogleMapTilesLayerType >	LayerTypes
	The layer types to be added to the map.

TArray< FString >	Styles
	An array of JSON style objects that specify the appearance and detail level of map features such as roads, parks, and built-up areas.

bool	Overlay = false
	Specifies whether `LayerTypes` rendered as a separate overlay, or combined with the base imagery.

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 directly accesses Google Map Tiles (2D).

If you're using Google Map Tiles via Cesium ion, use the "Cesium ion Raster Overlay" component instead.

Definition at line 82 of file CesiumGoogleMapTilesRasterOverlay.h.

Member Function Documentation

◆ CreateOverlay()

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

overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

Member Data Documentation

◆ HighDPI

bool UCesiumGoogleMapTilesRasterOverlay::HighDPI = false

Specifies whether to return high-resolution tiles.

If the scale-factor is increased, highDpi is used to increase the size of the tile. Normally, increasing the scale factor enlarges the resulting tile into an image of the same size, which lowers quality. With highDpi, the resulting size is also increased, preserving quality. DPI stands for Dots per Inch, and High DPI means the tile renders using more dots per inch than normal. If true, then the number of pixels in each of the x and y dimensions is multiplied by the scale factor (that is , 2x or 4x). The coverage area of the tile remains unchanged. This parameter works only with Scale values of 2x or 4x. It has no effect on 1x scale tiles.

Definition at line 138 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ Key

FString UCesiumGoogleMapTilesRasterOverlay::Key

The Google Map Tiles API key to use.

Definition at line 91 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ Language

FString UCesiumGoogleMapTilesRasterOverlay::Language = "en-US"

An IETF language tag that specifies the language used to display information on the tiles.

For example, en-US specifies the English language as spoken in the United States.

Definition at line 105 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ LayerTypes

TArray<EGoogleMapTilesLayerType> UCesiumGoogleMapTilesRasterOverlay::LayerTypes

The layer types to be added to the map.

Definition at line 144 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ MapType

EGoogleMapTilesMapType UCesiumGoogleMapTilesRasterOverlay::MapType = EGoogleMapTilesMapType::Satellite

The type of base map.

Definition at line 97 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ Overlay

bool UCesiumGoogleMapTilesRasterOverlay::Overlay = false

Specifies whether LayerTypes rendered as a separate overlay, or combined with the base imagery.

When true, the base map isn't displayed. If you haven't defined any LayerTypes, then this value is ignored.

Definition at line 166 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ Region

FString UCesiumGoogleMapTilesRasterOverlay::Region = "US"

A Common Locale Data Repository region identifier (two uppercase letters) that represents the physical location of the user.

For example, US.

Definition at line 112 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ Scale

EGoogleMapTilesScale UCesiumGoogleMapTilesRasterOverlay::Scale = EGoogleMapTilesScale::ScaleFactor1x

Scales-up the size of map elements (such as road labels), while retaining the tile size and coverage area of the default tile.

Increasing the scale also reduces the number of labels on the map, which reduces clutter.

Definition at line 122 of file CesiumGoogleMapTilesRasterOverlay.h.

◆ Styles

TArray<FString> UCesiumGoogleMapTilesRasterOverlay::Styles

An array of JSON style objects that specify the appearance and detail level of map features such as roads, parks, and built-up areas.

Styling is used to customize the standard Google base map. The styles parameter is valid only if the MapType is Roadmap. For the complete style syntax, see the Style Reference.

Definition at line 156 of file CesiumGoogleMapTilesRasterOverlay.h.

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

Source/CesiumRuntime/Public/CesiumGoogleMapTilesRasterOverlay.h

Public Attributes

Protected Member Functions

Additional Inherited Members