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