Holds the parameters for starting a new Google Maps Tiles session. More...

#include <CesiumRasterOverlays/GoogleMapTilesRasterOverlay.h>

Public Attributes
std::string	key
	The Google Map Tiles API key to use.

std::string	mapType {"satellite"}
	The type of base map. See GoogleMapTilesMapType for standard values.

std::string	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.

std::string	region {"US"}
	A Common Locale Data Repository region identifier (two uppercase letters) that represents the physical location of the user. For example, `US`.

std::optional< std::string >	imageFormat {}
	Specifies the file format to return. See GoogleMapTilesImageFormat for standard values.

std::optional< std::string >	scale {}
	Scales-up the size of map elements (such as road labels), while retaining the tile size and coverage area of the default tile. See GoogleMapTilesScale for standard value.

std::optional< bool >	highDpi {}
	Specifies whether to return high-resolution tiles.

std::optional< std::vector< std::string > >	layerTypes {}
	An array of values that specifies the layer types added to the map. See GoogleMapTilesLayerType for standard values.

std::optional< CesiumUtility::JsonValue::Array >	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.

std::optional< bool >	overlay {}
	A boolean value that specifies whether layerTypes should be rendered as a separate overlay, or combined with the base imagery.

std::string	apiBaseUrl {"https://tile.googleapis.com/"}
	The base URL for the Google Maps Tiles API.

Detailed Description

Holds the parameters for starting a new Google Maps Tiles session.

Definition at line 158 of file GoogleMapTilesRasterOverlay.h.

Member Data Documentation

◆ apiBaseUrl

std::string CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::apiBaseUrl {"https://tile.googleapis.com/"}

The base URL for the Google Maps Tiles API.

Definition at line 251 of file GoogleMapTilesRasterOverlay.h.

◆ highDpi

std::optional<bool> CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::highDpi {}

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 GoogleMapTilesScale::scaleFactor2x or GoogleMapTilesScale::scaleFactor4x. It has no effect on GoogleMapTilesScale::scaleFactor1x scale tiles.

Definition at line 219 of file GoogleMapTilesRasterOverlay.h.

◆ imageFormat

std::optional<std::string> CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::imageFormat {}

Specifies the file format to return. See GoogleMapTilesImageFormat for standard values.

If you don't specify an imageFormat, then the best format for the tile is chosen automatically.

Definition at line 192 of file GoogleMapTilesRasterOverlay.h.

◆ key

std::string CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::key

The Google Map Tiles API key to use.

Definition at line 162 of file GoogleMapTilesRasterOverlay.h.

◆ language

std::string CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::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 176 of file GoogleMapTilesRasterOverlay.h.

◆ layerTypes

std::optional<std::vector<std::string> > CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::layerTypes {}

An array of values that specifies the layer types added to the map. See GoogleMapTilesLayerType for standard values.

Definition at line 225 of file GoogleMapTilesRasterOverlay.h.

◆ mapType

std::string CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::mapType {"satellite"}

The type of base map. See GoogleMapTilesMapType for standard values.

Definition at line 168 of file GoogleMapTilesRasterOverlay.h.

◆ overlay

std::optional<bool> CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::overlay {}

A boolean value that specifies whether layerTypes should be 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 246 of file GoogleMapTilesRasterOverlay.h.

◆ region

std::string CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::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 183 of file GoogleMapTilesRasterOverlay.h.

◆ scale

std::optional<std::string> CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::scale {}

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

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

Definition at line 202 of file GoogleMapTilesRasterOverlay.h.

◆ styles

std::optional<CesiumUtility::JsonValue::Array> CesiumRasterOverlays::GoogleMapTilesNewSessionParameters::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 map type is GoogleMapTilesMapType::roadmap. For the complete style syntax, see the Style Reference.

Definition at line 237 of file GoogleMapTilesRasterOverlay.h.

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

/home/runner/work/cesium-native/cesium-native/CesiumRasterOverlays/include/CesiumRasterOverlays/GoogleMapTilesRasterOverlay.h

Public Attributes