Cesium for Unity 1.19.0
Loading...
Searching...
No Matches
CesiumForUnity.CesiumGoogleMapTilesRasterOverlay Class Reference

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

Inheritance diagram for CesiumForUnity.CesiumGoogleMapTilesRasterOverlay:
CesiumForUnity.CesiumRasterOverlay

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 apiKey [get, set]
 The Google Map Tiles API key to use.
 
GoogleMapTilesMapType mapType [get, set]
 The type of base map.
 
string language [get, set]
 An IETF language tag that specifies the language used to display information on the tiles.
 
string region [get, set]
 A Common Locale Data Repository region identifier (two uppercase letters) that represents the physical location of the user.
 
GoogleMapTilesScale scale [get, set]
 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 [get, set]
 Specifies whether to return high-resolution tiles.
 
List< GoogleMapTilesLayerTypelayerTypes [get, set]
 The layer types to be added to the map.
 
List< string > styles [get, set]
 A list of JSON style objects that specify the appearance and detail level of map features such as roads, parks, and built-up areas.
 
bool overlay [get, set]
 Specifies whether layerTypes are rendered as a separate overlay, or combined with the base imagery.
 
- 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 Google Map Tiles (2D).

If you're using Google Map Tiles via Cesium ion, use CesiumIonRasterOverlay instead.

Definition at line 88 of file CesiumGoogleMapsTilesRasterOverlay.cs.

Member Function Documentation

◆ AddToTileset()

override partial void CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.AddToTileset ( Cesium3DTileset tileset)
protected

◆ RemoveFromTileset()

override partial void CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.RemoveFromTileset ( Cesium3DTileset tileset)
protected

Property Documentation

◆ apiKey

string CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.apiKey
getset

The Google Map Tiles API key to use.

Definition at line 97 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ highDpi

bool CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.highDpi
getset

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 201 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ language

string CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.language
getset

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 131 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ layerTypes

List<GoogleMapTilesLayerType> CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.layerTypes
getset

The layer types to be added to the map.

Definition at line 216 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ mapType

GoogleMapTilesMapType CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.mapType
getset

The type of base map.

Definition at line 113 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ overlay

bool CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.overlay
getset

Specifies whether layerTypes are 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 266 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ region

string CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.region
getset

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

For example, US.

Definition at line 148 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ scale

GoogleMapTilesScale CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.scale
getset

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 169 of file CesiumGoogleMapsTilesRasterOverlay.cs.

◆ styles

List<string> CesiumForUnity.CesiumGoogleMapTilesRasterOverlay.styles
getset

A list 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 GoogleMapTilesMapType.Roadmap.

For the complete style syntax, see the Style Reference.

Definition at line 245 of file CesiumGoogleMapsTilesRasterOverlay.cs.


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