ArcGISElevationSource

Namespace: Esri::GameEngine::Elevation::Base
Class: Esri/GameEngine/Elevation/Base/ArcGISElevationSource
Since: 1.0.0
Implements: ArcGISInstanceId, ArcGISLoadable

Summary

Abstract base class for all ElevationSources.

Constructors

ArcGISElevationSource(const FString&, ArcGISElevationSourceType, const FString&)

Creates a new elevation source.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`source`	`FString`	`Yes`	Elevation source.
`type`	`ArcGISElevationSourceType`	`No`	ArcGISElevationSource type definition.
`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.
`Extent`	`ArcGISExtentRectangle`	`Yes`	`Yes`	The full extent of this ArcGISElevationSource, which is the extent where all ArcGISElevationSource data is contained.
`IsEnabled`	`bool`	`No`	`No`	Define if this elevation source is enabled or not.
`Name`	`FString`	`No`	`No`	Identifier for elevation source.
`Source`	`FString`	`No`	`Yes`	Source property is read-only, it will be set up on the constructor.
`SpatialReference`	`ArcGISSpatialReference`	`Yes`	`Yes`	The spatial reference of the elevation source.

APIKey

FString GetAPIKey() const

API key will be sent with every request for ArcGIS location services and/or private content items.

Extent

ArcGISExtentRectangle GetExtent() const

The full extent of this ArcGISElevationSource, which is the extent where all ArcGISElevationSource data is contained.

You can use this to zoom to all of the data contained in this ArcGISElevationSource.

IsEnabled

bool GetIsEnabled() const

void SetIsEnabled(bool isEnabled)

Define if this elevation source is enabled or not.

Name

FString GetName() const

void SetName(const FString& name)

Identifier for elevation source.

Source

FString GetSource() const

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

SpatialReference

ArcGISSpatialReference GetSpatialReference() const

The spatial reference of the elevation source.

ArcGISImageElevationSource ArcGISSpatialReference must match the ArcGISSpatialReference of the ArcGISMap. ArcGISImageElevationSource tiling scheme must be compatible with the tiling scheme of the ArcGISMap. If any of the above constraints are violated, an ArcGISElevationSourceViewState error is generated.

Methods

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

Equals

bool Equals(const ArcGISElevationSource& otherElevationSource) const

Tests if this elevation source is equal to a second ArcGISElevationSource object.

Since 2.1.0

Arguments

Name	Type	Const	Summary
`otherElevationSource`	`ArcGISElevationSource`	`Yes`	The other elevation source.

Returns bool

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