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 a linear unit given an area unit.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`areaUnit`	`ArcGISAreaUnit`	`Yes`	The area unit.

ArcGISLinearUnit(ArcGISLinearUnitId)

Creates a unit given its known id.

Since 1.0.0

Arguments

Name	Type	Const	Summary
`unitId`	`ArcGISLinearUnitId`	`No`	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 GetLinearUnitId() const

The ArcGISLinearUnitId of the given Linear unit.

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

Methods

Signature	Return Type	Summary
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

Name	Type	Const	Summary
`fromUnit`	`ArcGISLinearUnit`	`Yes`	The UOM to convert from.
`value`	`double`	`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

Name	Type	Const	Summary
`toUnit`	`ArcGISLinearUnit`	`Yes`	The UOM to convert to.
`value`	`double`	`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

Name	Type	Const	Summary
`value`	`double`	`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

Name	Type	Const	Summary
`value`	`double`	`No`	The value to convert.

Returns double

The value in meters or NAN if the conversion fails.