Namespace: Esri::GameEngine::Map
Class: Esri/GameEngine/Map/ArcGISBasemap
Since: 1.0.0
Implements: ArcGISLoadable
Summary
Public class that will contain a basemap.
Constructors
ArcGISBasemap()
Creates an empty ArcGISBasemap. Basemap is created in a loaded state.
Since 1.0.0
ArcGISBasemap(ArcGISBasemapStyle, const FString&)
Creates a basemap with a style.
Since 1.1.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
basemap | No | The basemap style. | |
APIKey | Yes | API key used to load data. |
ArcGISBasemap(const FString&, ArcGISLayerType, const FString&)
Creates an ArcGISBasemap from a URI and ArcGISLayerType.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
source | Yes | ArcGISLayer source. | |
type | No | Layer type definition. | |
APIKey | Yes | API key used to load data. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | API key will be sent with every request for ArcGIS location services and/or private content items. | ||
ArcGISCollection<ArcGISLayer> | No | No | The base layers. | |
No | No | This property will help the user to identify the layer on his application. | ||
ArcGISCollection<ArcGISLayer> | No | No | The reference layers. | |
No | Yes | Source property is read-only, it will be set up on the constructor. |
APIKey
FString GetAPIKey() const
API key will be sent with every request for ArcGIS location services and/or private content items.
BaseLayers
ArcGISCollection<ArcGISLayer> GetBaseLayers() const
void SetBaseLayers(const ArcGISCollection<ArcGISLayer>& baseLayers)
The base layers.
The ArcGISCollection<ArcGISLayer> is specific to each ArcGISMap or ArcGISBasemap. It is not possible to reuse ArcGISCollection<ArcGISLayer> instances between maps or basemaps. Create a new layer collection using ArcGISCollection<ArcGISLayer>.
Name
FString GetName() const
void SetName(const FString& name)
This property will help the user to identify the layer on his application.
ReferenceLayers
ArcGISCollection<ArcGISLayer> GetReferenceLayers() const
void SetReferenceLayers(const ArcGISCollection<ArcGISLayer>& referenceLayers)
The reference layers.
The ArcGISCollection<ArcGISLayer> is specific to each ArcGISMap or ArcGISBasemap. It is not possible to reuse ArcGISCollection<ArcGISLayer> instances between maps or basemaps. Create a new layer collection using ArcGISCollection<ArcGISLayer>.