Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISAreaUnit
Since: 1.0.0
Inheritance: ArcGISUnit->ArcGISAreaUnit
Summary
Defines an area unit of measurement.
Constructors
ArcGISAreaUnit(ArcGISAreaUnitId)
Creates a unit given its known id.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
unit | No | The known id of the unit. |
ArcGISAreaUnit(const ArcGISLinearUnit&)
Creates an area unit given a linear unit.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
linear | Yes | The linear unit. |
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
No | Yes | The ArcGISAreaUnitId of the given Area unit. |
AreaUnitId
ArcGISAreaUnitId GetAreaUnitId() const
The ArcGISAreaUnitId of the given Area unit.
If an error occurs then ArcGISAreaUnitId::Other is returned.
Methods
| Signature | Return Type | Summary |
|---|---|---|
ConvertFrom(const ArcGISAreaUnit&, double) | Converts a value in another UOM into this UOM. | |
ConvertTo(const ArcGISAreaUnit&, double) | Converts a value in this UOM into another UOM. | |
Converts a square meter value to this UOM. | ||
Converts a value in this UOM to square meters. |
ConvertFrom
double ConvertFrom(const ArcGISAreaUnit& fromUnit, double area) const
Converts a value in another UOM into this UOM.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
from | Yes | The UOM to convert from. | |
area | No | The value to convert. |
Returns double
The value in the this UOM or NAN if the conversion fails.
ConvertTo
double ConvertTo(const ArcGISAreaUnit& toUnit, double area) const
Converts a value in this UOM into another UOM.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
to | Yes | The UOM to convert to. | |
area | No | The value to convert. |
Returns double
The value in the target UOM or NAN if the conversion fails.
FromSquareMeters
Converts a square meter value to this UOM.
Since 1.0.0
Arguments
| Name | Type | Const | Summary |
|---|---|---|---|
area | No | The value to convert. |
Returns double
The value in this UOM or NAN if the conversion fails.