Namespace: GameEngine.Geometry
Class: GameEngine/Geometry/ArcGISAreaUnit
Since: 1.0.0
Inheritance: ArcGISUnit->ArcGISAreaUnit

Summary

Defines an area unit of measurement.

Constructors

ArcGISAreaUnit(ArcGISAreaUnitId unitId)

Creates a unit given its known id.

Since 1.0.0

Arguments
NameTypeSummary
unitId

The known id of the unit.

ArcGISAreaUnit(ArcGISLinearUnit linearUnit)

Creates an area unit given a linear unit.

Since 1.0.0

Arguments
NameTypeSummary
linearUnit

The linear unit.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

The ArcGISAreaUnitId of the given Area unit.

AreaUnitId

ArcGISAreaUnitId AreaUnitId

The ArcGISAreaUnitId of the given Area unit.

If an error occurs then ArcGISAreaUnitId.Other is returned.

Methods

SignatureReturn TypeSummary

Converts a value in another UOM into this UOM.

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(ArcGISAreaUnit fromUnit, double area)

Converts a value in another UOM into this UOM.

Since 1.0.0

Arguments
NameTypeSummary
fromUnit

The UOM to convert from.

area

The value to convert.

Returns double

The value in the this UOM or NAN if the conversion fails.

ConvertTo

double ConvertTo(ArcGISAreaUnit toUnit, double area)

Converts a value in this UOM into another UOM.

Since 1.0.0

Arguments
NameTypeSummary
toUnit

The UOM to convert to.

area

The value to convert.

Returns double

The value in the target UOM or NAN if the conversion fails.

FromSquareMeters

double FromSquareMeters(double area)

Converts a square meter value to this UOM.

Since 1.0.0

Arguments
NameTypeSummary
area

The value to convert.

Returns double

The value in this UOM or NAN if the conversion fails.

ToSquareMeters

double ToSquareMeters(double area)

Converts a value in this UOM to square meters.

Since 1.0.0

Arguments
NameTypeSummary
area

The value to convert.

Returns double

The value in square meters or NAN if the conversion fails.