Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISAngularUnit
Since: 1.0.0
Inheritance: ArcGISUnit->ArcGISAngularUnit
Summary
Defines an angular unit of measurement.
Constructors
ArcGISAngularUnit(ArcGISAngularUnitId unitId)
Creates a unit given its known id.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
unitId | No | The known id of the unit. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | The ArcGISAngularUnitId of the given angular unit. |
AngularUnitId
ArcGISAngularUnitId GetAngularUnitId() const
The ArcGISAngularUnitId of the given angular unit.
If an error occurs then ArcGISAngularUnitId::Other is returned.
Methods
| Signature | Return Type | Summary |
|---|---|---|
ConvertFrom(const ArcGISAngularUnit&, double) | Converts a value in another UOM into this UOM. | |
ConvertTo(const ArcGISAngularUnit&, double) | Converts a value in this UOM into another UOM. | |
Converts a radian value to this UOM. | ||
Converts a value in this UOM to radians. |
ConvertFrom
double ConvertFrom(const ArcGISAngularUnit& fromUnit, double angle) const
Converts a value in another UOM into this UOM.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
fromUnit | Yes | The UOM to convert from. | |
angle | No | The value to convert. |
Returns double
The value in the this UOM or NAN if the conversion fails.
ConvertTo
double ConvertTo(const ArcGISAngularUnit& toUnit, double angle) const
Converts a value in this UOM into another UOM.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
toUnit | Yes | The UOM to convert to. | |
angle | No | The value to convert. |
Returns double
The value in the target UOM or NAN if the conversion fails.
FromRadians
Converts a radian value to this UOM.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
radians | No | The value to convert. |
Returns double
The value in this UOM or NAN if the conversion fails.