CesiumForUnity.CesiumAzureMapsRasterOverlay Class Reference

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

Inheritance diagram for CesiumForUnity.CesiumAzureMapsRasterOverlay:

Protected Member Functions
override partial void	AddToTileset (Cesium3DTileset tileset)
override partial void	RemoveFromTileset (Cesium3DTileset tileset)
Protected Member Functions inherited from CesiumForUnity.CesiumRasterOverlay
void	AddToTileset (Cesium3DTileset tileset)
	When implemented in a derived class, adds the raster overlay to the given tileset.
void	RemoveFromTileset (Cesium3DTileset tileset)
	When implemented in a derived class, removes the raster overlay from the given tileset.

Properties
string	key [get, set]
	The Azure Maps subscription key to use.
string	apiVersion [get, set]
	The version number of Azure Maps API.
AzureMapsTilesetId	tilesetId [get, set]
	The tileset ID to use.
string	language [get, set]
	The language in which search results should be returned.
string	view [get, set]
	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.
Properties inherited from CesiumForUnity.CesiumRasterOverlay
string	materialKey [get, set]
	The key to use to match this overlay to the corresponding parameters in the tileset's material.
bool	showCreditsOnScreen [get, set]
	Whether or not to force this raster overlay's credits to be shown on the main screen.
float	maximumScreenSpaceError [get, set]
	The maximum number of pixels of error when rendering this overlay.
int	maximumTextureSize [get, set]
	The maximum texel size of raster overlay textures, in either direction.
int	maximumSimultaneousTileLoads [get, set]
	The maximum number of overlay tiles that may simultaneously be in the process of loading.
long	subTileCacheBytes [get, set]
	The maximum number of bytes to use to cache sub-tiles in memory.

Additional Inherited Members
Public Member Functions inherited from CesiumForUnity.CesiumRasterOverlay
delegate void	RasterOverlayLoadFailureDelegate (CesiumRasterOverlayLoadFailureDetails details)
	Encapsulates a method that receives details of a raster overlay load failure.
void	AddToTileset ()
	Adds this raster overlay to the Cesium3DTileset on the same game object.
void	RemoveFromTileset ()
	Removes this raster overlay from the Cesium3DTileset on the same game object.
void	Refresh ()
	Refreshes this overlay by calling RemoveFromTileset followed by AddToTileset.
Static Package Functions inherited from CesiumForUnity.CesiumRasterOverlay
Events inherited from CesiumForUnity.CesiumRasterOverlay
static RasterOverlayLoadFailureDelegate	OnCesiumRasterOverlayLoadFailure
	An event that is raised when the raster overlay encounters an error that prevents it from loading.

Detailed Description

A raster overlay that directly accesses Azure Maps.

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

Definition at line 91 of file CesiumAzureMapsRasterOverlay.cs.

Member Function Documentation

AddToTileset()

override partial void CesiumForUnity.CesiumAzureMapsRasterOverlay.AddToTileset ( Cesium3DTileset tileset )

protected

RemoveFromTileset()

override partial void CesiumForUnity.CesiumAzureMapsRasterOverlay.RemoveFromTileset ( Cesium3DTileset tileset )

protected

Property Documentation

apiVersion

string CesiumForUnity.CesiumAzureMapsRasterOverlay.apiVersion

getset

The version number of Azure Maps API.

Definition at line 113 of file CesiumAzureMapsRasterOverlay.cs.

key

string CesiumForUnity.CesiumAzureMapsRasterOverlay.key

getset

The Azure Maps subscription key to use.

Definition at line 99 of file CesiumAzureMapsRasterOverlay.cs.

language

string CesiumForUnity.CesiumAzureMapsRasterOverlay.language

getset

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 148 of file CesiumAzureMapsRasterOverlay.cs.

tilesetId

AzureMapsTilesetId CesiumForUnity.CesiumAzureMapsRasterOverlay.tilesetId

getset

The tileset ID to use.

Definition at line 129 of file CesiumAzureMapsRasterOverlay.cs.

view

string CesiumForUnity.CesiumAzureMapsRasterOverlay.view

getset

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 180 of file CesiumAzureMapsRasterOverlay.cs.

---

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

• Runtime/CesiumAzureMapsRasterOverlay.cs