ArcGISUnit

Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISUnit
Since: 1.0.0

Summary

Defines a unit of measurement.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

The abbreviation of the unit.

No
Yes

The display name of the unit.

No
Yes

The name of the unit.

No
Yes

The display name of the unit.

No
Yes

The well-known ID for the unit, or 0 for a custom unit.

No
Yes

The well-known ID for the unit, or 0 for a custom unit.

Abbreviation

FString GetAbbreviation() const

The abbreviation of the unit.

The abbreviation for a specific unit.

DisplayName

FString GetDisplayName() const

The display name of the unit.

The display name for a specific unit.

Name

FString GetName() const

The name of the unit.

The name for a specific unit.

PluralDisplayName

FString GetPluralDisplayName() const

The display name of the unit.

The display name for a specific unit.

UnitId

int32_t GetUnitId() const

The well-known ID for the unit, or 0 for a custom unit.

WKID

int32_t GetWKID() const

The well-known ID for the unit, or 0 for a custom unit.

Methods

SignatureReturn TypeSummary

FromUnitId(int32_t)

ArcGISUnit

Creates a unit given its well-known ID.

FromWKID(int32_t)

ArcGISUnit

Creates a unit given its well-known ID.

FromUnitId

static ArcGISUnit FromUnitId(int32_t unitId)

Creates a unit given its well-known ID.

Since 1.0.0

Arguments
NameTypeConstSummary
unitId
No

The well-known ID of the unit.

Returns ArcGISUnit

A unit. Depending on the well-known ID given, this may be a ArcGISLinearUnit, ArcGISAngularUnit, or ArcGISAreaUnit.

FromWKID

static ArcGISUnit FromWKID(int32_t WKID)

Creates a unit given its well-known ID.

Since 1.0.0

Arguments
NameTypeConstSummary
WKID
No

The well-known ID of the unit.

Returns ArcGISUnit

A unit. Depending on the well-known ID given, this may be a ArcGISLinearUnit, ArcGISAngularUnit, or ArcGISAreaUnit.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.