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

#include <CesiumAzureMapsRasterOverlay.h>

Inheritance diagram for UCesiumAzureMapsRasterOverlay:

Public Attributes
FString	Key
	The Azure Maps subscription key to use.

FString	ApiVersion = "2024-04-01"
	The version number of Azure Maps API.

EAzureMapsTilesetId	TilesetId = EAzureMapsTilesetId::BaseRoad
	The tileset ID to use.

FString	Language = "en-US"
	The language in which search results should be returned.

FString	View = "US"
	The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions.

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 Azure Maps.

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

Definition at line 90 of file CesiumAzureMapsRasterOverlay.h.

Member Function Documentation

◆ CreateOverlay()

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

overrideprotectedvirtual

Reimplemented from UCesiumRasterOverlay.

Member Data Documentation

◆ ApiVersion

FString UCesiumAzureMapsRasterOverlay::ApiVersion = "2024-04-01"

The version number of Azure Maps API.

Definition at line 105 of file CesiumAzureMapsRasterOverlay.h.

◆ Key

FString UCesiumAzureMapsRasterOverlay::Key

The Azure Maps subscription key to use.

Definition at line 99 of file CesiumAzureMapsRasterOverlay.h.

◆ Language

FString UCesiumAzureMapsRasterOverlay::Language = "en-US"

The language in which search results should be returned.

This should be one of the supported IETF language tags, case insensitive. When data in the specified language is not available for a specific field, default language is used.

Definition at line 120 of file CesiumAzureMapsRasterOverlay.h.

◆ TilesetId

EAzureMapsTilesetId UCesiumAzureMapsRasterOverlay::TilesetId = EAzureMapsTilesetId::BaseRoad

The tileset ID to use.

Definition at line 111 of file CesiumAzureMapsRasterOverlay.h.

◆ View

FString UCesiumAzureMapsRasterOverlay::View = "US"

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions.

Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to "Unified" even if you haven't defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set 'View=Auto', which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Definition at line 141 of file CesiumAzureMapsRasterOverlay.h.

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

Source/CesiumRuntime/Public/CesiumAzureMapsRasterOverlay.h

Public Attributes

Protected Member Functions

Additional Inherited Members