Collection of Geometry enumerations. More...

Header: | #include <GeometryTypes.h> |

## Types

enum class | AngularUnitId { Other, Degrees, Grads, Minutes, Radians, Seconds } |

enum class | AreaUnitId { Other, Acres, Hectares, SquareCentimeters, SquareDecimeters, …, SquareYards } |

enum class | DatumTransformationType { GeographicTransformation, HorizontalVerticalTransformation } |

enum class | GarsConversionMode { LowerLeft, Center } |

enum class | GeodeticCurveType { Geodesic, Loxodrome, GreatElliptic, NormalSection, ShapePreserving } |

enum class | GeometryBuilderType { Unknown, PointBuilder, EnvelopeBuilder, PolylineBuilder, PolygonBuilder, MultipointBuilder } |

enum class | GeometryDimension { Point, Curve, Area, Volume, Unknown } |

enum class | GeometryExtendOptions { Default, RelocateEnds, KeepEndAttributes, NoEndAttributes, DoNotExtendFromStartPoint, DoNotExtendFromEndPoint } |

enum class | GeometryOffsetType { Mitered, Bevelled, Rounded, Squared } |

enum class | GeometryType { Unknown, Point, Envelope, Polyline, Polygon, Multipoint } |

enum class | LatitudeLongitudeFormat { DecimalDegrees, DegreesDecimalMinutes, DegreesMinutesSeconds } |

enum class | LinearUnitId { Other, Centimeters, Feet, Inches, Kilometers, …, Yards } |

enum class | MgrsConversionMode { Automatic, New180InZone01, New180InZone60, Old180InZone01, Old180InZone60 } |

enum class | SegmentType { Unknown, LineSegment, CubicBezierSegment, EllipticArcSegment } |

enum class | UnitType { LinearUnit, AngularUnit, AreaUnit, Unknown } |

enum class | UtmConversionMode { LatitudeBandIndicators, NorthSouthIndicators } |

## Detailed Description

## Type Documentation

`[since Esri:`:ArcGISRuntime 100.0]

enum class AngularUnitId

Defines a list of the most commonly-used angular units of measurement.

These values can be used to create instances of AngularUnit, as an alternative to using well-known IDs (WKIDs). In addition to the units in this enumeration, you can also use less commonly-used units, by passing a WKID of an angular unit to the inherited Unit::fromWkid(int) factory method. The function Unit::wkid returns the WKID of the unit.

The AngularUnitId can be one of:

Constant | Value | Description |
---|---|---|

`AngularUnitId::Other` | `0` | Indicates that the unit of angular measurement is a custom unit, or is a unit not listed in the enumerated type. This value may be returned from an AngularUnit created from a WKID of a less commonly used unit of measurement that does not have an equivalent value in this enumeration. |

`AngularUnitId::Degrees` | `9102` | Indicates an angular measurement in degrees. This unit has a WKID of 9102. |

`AngularUnitId::Grads` | `9105` | Indicates an angular measurement in grads. This unit has a WKID of 9105. |

`AngularUnitId::Minutes` | `9103` | Indicates an angular measurement in minutes, equal to one-sixtieth of a degree. This unit has a WKID of 9103. |

`AngularUnitId::Radians` | `9101` | Indicates an angular measurement in radians. This unit has an WKID of 9101. |

`AngularUnitId::Seconds` | `9104` | Indicates an angular measurement in seconds, equal to one-sixtieth of a minute. This unit has a WKID of 9104. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 100.0]

enum class AreaUnitId

Defines a list of the most commonly-used units of area measurement.

These values can be used to create instances of AreaUnit, as an alternative to using well-known IDs (WKIDs). In addition to the units in this enumeration, you can also use less commonly-used units, by passing a WKID of an area unit to the inherited Unit::fromWkid(int) factory method. The function Unit::wkid returns the WKID of the unit.

The AreaUnitId can be one of:

Constant | Value | Description |
---|---|---|

`AreaUnitId::Other` | `0` | Indicates that the unit of area measurement is a custom unit, or a unit not listed in the enumerated type. This value may be returned from an AreaUnit created from a WKID of a less commonly used unit of measurement that does not have an equivalent value in this enumeration. |

`AreaUnitId::Acres` | `109402` | Indicates an area measurement in acres. This unit has a WKID of 109402. |

`AreaUnitId::Hectares` | `109401` | Indicates an area measurement in hectares. This unit has a WKID of 109401. |

`AreaUnitId::SquareCentimeters` | `109451` | Indicates an area measurement in square centimeters. This unit has a WKID of 109451. |

`AreaUnitId::SquareDecimeters` | `109450` | Indicates an area measurement in square decimeters. This unit has a WKID of 109450. |

`AreaUnitId::SquareFeet` | `109405` | Indicates an area measurement in square feet. This unit has a WKID of 109405. |

`AreaUnitId::SquareKilometers` | `109414` | Indicates an area measurement in square kilometers. This unit has a WKID of 109414. |

`AreaUnitId::SquareMeters` | `109404` | Indicates an area measurement in square meters. This unit has a WKID of 109404. |

`AreaUnitId::SquareMillimeters` | `109452` | Indicates an area measurement in square millimeters. This unit has a WKID of 109452. |

`AreaUnitId::SquareMiles` | `109439` | Indicates an area measurement in square statute miles. This unit has a WKID of 109439. |

`AreaUnitId::SquareYards` | `109442` | Indicates an area measurement in square yards. This unit has a WKID of 109442. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 100.2]

enum class DatumTransformationType

Supported datum transformation types.

The DatumTransformationType can be one of:

Constant | Value | Description |
---|---|---|

`DatumTransformationType::GeographicTransformation` | `1` | Represents a GeographicTransformation instance. |

`DatumTransformationType::HorizontalVerticalTransformation` | `2` | Represents a HorizontalVerticalTransformation instance. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.2.

`[since Esri:`:ArcGISRuntime 100.1]

enum class GarsConversionMode

Enumerates possible locations of a point relative to a GARS cell.

The GarsConversionMode can be one of:

Constant | Value | Description |
---|---|---|

`GarsConversionMode::LowerLeft` | `0` | Represents a GARS cell by the coordinate of its south-west corner. |

`GarsConversionMode::Center` | `1` | Represents a GARS cell by the coordinates of its center. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.1.

`[since Esri:`:ArcGISRuntime 100.0]

enum class GeodeticCurveType

Enumerates types of geodetic curves for use in geodetic GeometryEngine operations.

The GeodeticCurveType can be one of:

Constant | Value | Description |
---|---|---|

`GeodeticCurveType::Geodesic` | `0` | The shortest line between any two points on the Earth's surface on a spheroid (ellipsoid). |

`GeodeticCurveType::Loxodrome` | `1` | A line of constant bearing, or azimuth. Straight line is a rhumb line. |

`GeodeticCurveType::GreatElliptic` | `2` | The line on a spheroid (ellipsoid) defined by the intersection at the surface by a plane that passes through the center of the spheroid and the start and end points of a segment. This is also known as a great circle when a sphere is used. |

`GeodeticCurveType::NormalSection` | `3` | Straight line is a normal section. |

`GeodeticCurveType::ShapePreserving` | `4` | Keeps the original shape of the geometry or curve. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 100.0]

enum class GeometryBuilderType

Enumerates types of geometry builder that may be represented by GeometryBuilder or a class that inherts from GeometryBuilder.

The GeometryBuilderType can be one of:

Constant | Value | Description |
---|---|---|

`GeometryBuilderType::Unknown` | `-1` | Unknown geometry builder type |

`GeometryBuilderType::PointBuilder` | `1` | A PointBuilder |

`GeometryBuilderType::EnvelopeBuilder` | `2` | An EnvelopeBuilder |

`GeometryBuilderType::PolylineBuilder` | `3` | A PolylineBuilder |

`GeometryBuilderType::PolygonBuilder` | `4` | A PolygonBuilder |

`GeometryBuilderType::MultipointBuilder` | `5` | A MultipointBuilder |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 200.0]

enum class GeometryDimension

Indicates the dimensionality of a Geometry, relating to the number of spatial dimensions in which the geometry may have a size.

The GeometryDimension can be one of:

Constant | Value | Description |
---|---|---|

`GeometryDimension::Point` | `0` | The geometry is a point or multipoint. |

`GeometryDimension::Curve` | `1` | The geometry is a curve. |

`GeometryDimension::Area` | `2` | The geometry has an area. |

`GeometryDimension::Volume` | `3` | The geometry has a volume. |

`GeometryDimension::Unknown` | `-1` | Unknown geometry dimensions. |

This enum was introduced or modified in Esri::ArcGISRuntime 200.0.

`[since Esri:`:ArcGISRuntime 100.1]

enum class GeometryExtendOptions

Enumerates options that the GeometryEngine's extend() method should use.

The GeometryExtendOptions can be one of:

Constant | Value | Description |
---|---|---|

`GeometryExtendOptions::Default` | `0` | By default, extension considers both ends of paths. The old ends remain and new points are added at the extended ends. The new points have attributes that are extrapolated from adjacent existing segments. |

`GeometryExtendOptions::RelocateEnds` | `1` | If an extension is performed at an end, relocate the end point to the new position instead of leaving the old point and adding a new point at the new position. |

`GeometryExtendOptions::KeepEndAttributes` | `2` | If an extension is performed at an end, do not extrapolate the end-segment's attributes for the new point. Instead, make its attributes the same as the current end. Incompatible with GeometryExtendOptions::NoEndAttributes. |

`GeometryExtendOptions::NoEndAttributes` | `4` | If an extension is performed at an end, do not extrapolate the end-segment's attributes for the new point. Instead, make its attributes be empty. Incompatible with GeometryExtendOptions::KeepEndAttributes. |

`GeometryExtendOptions::DoNotExtendFromStartPoint` | `8` | Do not extend the 'from' end of any path. |

`GeometryExtendOptions::DoNotExtendFromEndPoint` | `16` | Do not extend the 'to' end of any path. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.1.

`[since Esri:`:ArcGISRuntime 100.0]

enum class GeometryOffsetType

The different types of geometry offset joints.

The GeometryOffsetType can be one of:

Constant | Value | Description |
---|---|---|

`GeometryOffsetType::Mitered` | `0` | Refers to a mitered joint type. |

`GeometryOffsetType::Bevelled` | `1` | Refers to a bevelled joint type. |

`GeometryOffsetType::Rounded` | `2` | Refers to a rounded joint type. |

`GeometryOffsetType::Squared` | `3` | Refers to a squared joint type. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 100.0]

enum class GeometryType

Enumerates types of geometry that may be represented by Geometry or a class that inherts from Geometry.

The GeometryType can be one of:

Constant | Value | Description |
---|---|---|

`GeometryType::Unknown` | `-1` | Unknown geometry type |

`GeometryType::Point` | `1` | Single point (point) |

`GeometryType::Envelope` | `2` | Enclosed rectangular area with sides aligned on the X and Y axes (area, multi-path, multi-vertex) |

`GeometryType::Polyline` | `3` | One or more lines in a single %Geometry (linear, multi-vertex, multi-path) |

`GeometryType::Polygon` | `4` | One or more enclosed areas in a single %Geometry (multi-vertex, multi-path) |

`GeometryType::Multipoint` | `5` | One or more points in a single %Geometry (point, multi-vertex) |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 100.1]

enum class LatitudeLongitudeFormat

Enumerates supported formats for representing latitude-longitude geographical coordinates as a string.

The LatitudeLongitudeFormat can be one of:

Constant | Value | Description |
---|---|---|

`LatitudeLongitudeFormat::DecimalDegrees` | `0` | The geographical coordinates are represented in decimal degrees. |

`LatitudeLongitudeFormat::DegreesDecimalMinutes` | `1` | The geographical coordinates are represented in degrees and decimal minutes. |

`LatitudeLongitudeFormat::DegreesMinutesSeconds` | `2` | The geographical coordinates are represented in degrees and minutes and decimal seconds. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.1.

`[since Esri:`:ArcGISRuntime 100.0]

enum class LinearUnitId

Defines a list of the most commonly-used units of linear measurement.

**Note: **See Esri::ArcGISRuntime::GeoprocessingLinearUnit for a description of the relationship between Esri::ArcGISRuntime::GeoprocessingLinearUnit and Esri::ArcGISRuntime::LinearUnit.

These values can be used to create instances Unit, as an alternative to using well-known IDs (WKIDs). In addition to the units in this enumeration, you can also use less commonly-used units, by passing a WKID of a linear unit to the inherited Unit::fromWkid(int) factory method. The function Unit::wkid returns the WKID of the unit.

The LinearUnitId can be one of:

Constant | Value | Description |
---|---|---|

`LinearUnitId::Other` | `0` | Indicates that the unit of linear measurement is a custom unit, or a unit that is not listed in the enumerated type. This value may be returned from an LinearUnit created from a WKID of a less commonly used unit of measurement that does not have an equivalent value in this enumeration. |

`LinearUnitId::Centimeters` | `1033` | Indicates a linear measurement in centimeters. This unit has a WKID of 1033. |

`LinearUnitId::Feet` | `9002` | Indicates a linear measurement in feet. This unit has a WKID of 9002. |

`LinearUnitId::Inches` | `109008` | Indicates a linear measurement in inches. This unit has a WKID of 109008. |

`LinearUnitId::Kilometers` | `9036` | Indicates a linear measurement in kilometers. This unit has a WKID of 9036. |

`LinearUnitId::Meters` | `9001` | Indicates a linear measurement in meters. This unit has a WKID of 9001. |

`LinearUnitId::Miles` | `9093` | Indicates a linear measurement in statute miles. This unit has a WKID of 9093. |

`LinearUnitId::Millimeters` | `1025` | Indicates a linear measurement in millimeters. This unit has a WKID of 1025. |

`LinearUnitId::NauticalMiles` | `9030` | Indicates a linear measurement in nautical miles. This unit has a WKID of 9030. |

`LinearUnitId::Yards` | `9096` | Indicates a linear measurement in yards. This unit has a WKID of 9096. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 100.1]

enum class MgrsConversionMode

Enumerates the lettering scheme and treatment of coordinates at 180 degrees longitude when converting MGRS.

The MgrsConversionMode can be one of:

Constant | Value | Description |
---|---|---|

`MgrsConversionMode::Automatic` | `0` | The choice of MGRS lettering scheme is based on the datum and ellipsoid of the spatial reference provided. Spatial references with new datums (e.g. `WGS` 84) assume new lettering scheme (AA scheme). This is equivalent to `MgrsConversionMode::New180InZone60` . Spatial references with older datums (e.g. `Clarke` 1866, `Bessel` 1841, `Clarke` 1880) assume old lettering scheme (AL scheme). This is equivalent to `MgrsConversionMode::Old180InZone60` . When converted, points with longitude of exactly 180 degrees are placed in zone 60. |

`MgrsConversionMode::New180InZone01` | `1` | The MGRS notation uses the new lettering scheme (AA scheme) and, when converted, places points with longitude of 180 degrees in zone 01. |

`MgrsConversionMode::New180InZone60` | `2` | The MGRS notation uses the new lettering scheme (AA scheme) and, when converted, places points with longitude of 180 degrees in zone 60. |

`MgrsConversionMode::Old180InZone01` | `3` | The MGRS notation uses the old lettering scheme (AL scheme) and, when converted, places points with longitude of 180 degrees in zone 01. |

`MgrsConversionMode::Old180InZone60` | `4` | The MGRS notation uses the old lettering scheme (AL scheme) and, when converted, places points with longitude of 180 degrees in zone 60. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.1.

`[since Esri:`:ArcGISRuntime 100.0]

enum class SegmentType

The different types of segments.

Each of the different supported segment types. The segment type can be accessed by calling Segment::segmentType.

The SegmentType can be one of:

Constant | Value | Description |
---|---|---|

`SegmentType::Unknown` | `-1` | An unknown segment. |

`SegmentType::LineSegment` | `1` | Line segment. |

`SegmentType::CubicBezierSegment` | `2` | Cubic bezier curve segment. |

`SegmentType::EllipticArcSegment` | `3` | Elliptic arc curve segment. |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

`[since Esri:`:ArcGISRuntime 100.0]

enum class UnitType

Enumerates types of unit represented by an instance of a Unit type.

The UnitType can be one of:

Constant | Value | Description |
---|---|---|

`UnitType::LinearUnit` | `0` | LinearUnit |

`UnitType::AngularUnit` | `1` | AngularUnit |

`UnitType::AreaUnit` | `2` | AreaUnit |

`UnitType::Unknown` | `-1` | Unknown unit type |

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

### enum class UtmConversionMode

Determines how latitude is designated in UTM notation.

Within a single longitudinal zone within the UTM system, two points share the same grid position: one in the northern hemisphere and one in the south. Two schemes are used to resolve this ambiguity. In the first, the point is designated a latitude band, identified with letters C through X (omitting I and O). In the second, in place of the latitude band, a hemisphere indicator (N or S) is used.

The UtmConversionMode can be one of:

Constant | Value | Description |
---|---|---|

`UtmConversionMode::LatitudeBandIndicators` | `0` | The letter after the UTM zone number represents a latitudinal band (C through X, omitting I and O). |

`UtmConversionMode::NorthSouthIndicators` | `1` | The letter after the UTM zone number represents a hemisphere (N or S). |