ArcGISBasemap

Namespace: Esri::GameEngine::Map
Class: Esri/GameEngine/Map/ArcGISBasemap
Since: 1.0.0
Implements: ArcGISInstanceId, 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
`basemapStyle`	`ArcGISBasemapStyle`	`No`	The basemap style.
`APIKey`	`FString`	`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`	`FString`	`Yes`	ArcGISLayer source.
`type`	`ArcGISLayerType`	`No`	Layer type definition.
`APIKey`	`FString`	`Yes`	API key used to load data.

ArcGISBasemap(const FString&, const FString&)

Creates an ArcGISBasemap from a basemap URI.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`source`	`FString`	`Yes`	ArcGISBasemap source.
`APIKey`	`FString`	`Yes`	API key used to load data.

Properties

Property	Type	Nullable	Readonly	Summary
`APIKey`	`FString`	`No`	`Yes`	API key will be sent with every request for ArcGIS location services and/or private content items.
`BaseLayers`	`ArcGISCollection<ArcGISLayer>`	`No`	`No`	The base layers.
`Name`	`FString`	`No`	`No`	This property will help the user to identify the layer on his application.
`ReferenceLayers`	`ArcGISCollection<ArcGISLayer>`	`No`	`No`	The reference layers.
`Source`	`FString`	`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 is specific to each ArcGISMap or ArcGISBasemap. It is not possible to reuse ArcGISCollection instances between maps or basemaps. Create a new layer collection using ArcGISCollection.

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.

Source

FString GetSource() const

Source property is read-only, it will be set up on the constructor.

Methods

Signature	Return Type	Summary
Equals(const ArcGISBasemap&)	bool	Tests if this basemap is equal to a second ArcGISBasemap object.

Equals

bool Equals(const ArcGISBasemap& otherBasemap) const

Tests if this basemap is equal to a second ArcGISBasemap object.

Since 2.1.0

Arguments

Name	Type	Const	Summary
`otherBasemap`	`ArcGISBasemap`	`Yes`	The other basemap.

Returns bool

True if the comparison succeeds and the objects are equal, false otherwise.