Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISUnit
Since: 1.0.0
Summary
Defines a unit of measurement.
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
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.
PluralDisplayName
FString GetPluralDisplayName() const
The display name of the unit.
The display name for a specific unit.
Methods
| Signature | Return Type | Summary |
|---|---|---|
Creates a unit given its well-known ID. | ||
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
| Name | Type | Const | Summary |
|---|---|---|---|
unit | 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
| Name | Type | Const | Summary |
|---|---|---|---|
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.