ArcGISLinearUnit

Namespace: Esri::GameEngine::Geometry
Class: Esri/GameEngine/Geometry/ArcGISLinearUnit
Since: 1.0.0
Inheritance: ArcGISUnit->ArcGISLinearUnit

Summary

Defines a linear unit of measurement.

Constructors

ArcGISLinearUnit(const ArcGISAreaUnit&)

Creates an linear unit given an area unit.

Since 1.0.0

Arguments
NameTypeConstSummary
areaUnit
Yes

The area unit.

ArcGISLinearUnit(ArcGISLinearUnitId)

Creates a unit given its known id.

Since 1.0.0

Arguments
NameTypeConstSummary
unitId
No

The known id of the unit.

Properties

PropertyTypeNullableReadonlySummary
No
Yes

The ArcGISLinearUnitId of the given Linear unit.

LinearUnitId

ArcGISLinearUnitId GetLinearUnitId() const

The ArcGISLinearUnitId of the given Linear unit.

If an error occurs then ArcGISLinearUnitId::Other is returned.

Methods

SignatureReturn TypeSummary

ConvertFrom(const ArcGISLinearUnit&, double)

double

Converts a value in another UOM into this UOM.

ConvertTo(const ArcGISLinearUnit&, double)

double

Converts a value in this UOM into another UOM.

FromMeters(double)

double

Converts a meter value to this UOM.

ToMeters(double)

double

Converts a value in this UOM to meters.

ConvertFrom

double ConvertFrom(const ArcGISLinearUnit& fromUnit, double value) const

Converts a value in another UOM into this UOM.

Since 1.0.0

Arguments
NameTypeConstSummary
fromUnit
Yes

The UOM to convert from.

value
No

The value to convert.

Returns double

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

ConvertTo

double ConvertTo(const ArcGISLinearUnit& toUnit, double value) const

Converts a value in this UOM into another UOM.

Since 1.0.0

Arguments
NameTypeConstSummary
toUnit
Yes

The UOM to convert to.

value
No

The value to convert.

Returns double

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

FromMeters

double FromMeters(double value) const

Converts a meter value to this UOM.

Since 1.0.0

Arguments
NameTypeConstSummary
value
No

The value to convert.

Returns double

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

ToMeters

double ToMeters(double value) const

Converts a value in this UOM to meters.

Since 1.0.0

Arguments
NameTypeConstSummary
value
No

The value to convert.

Returns double

The value in meters or NAN if the conversion fails.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.