Geometries represent real-world objects by defining a shape at a specific geographic location. They are used throughout the API to represent the shapes of features and graphics, layer extents, viewpoints, and GPS locations. They are also used as inputs and outputs of spatial analysis and geoprocessing operations, and to measure distances and areas, among other uses.
Geometry
The Geometry class provides functionality common to all types of geometry. Point, Multipoint, Polyline, Polygon, and Envelope all inherit from the Geometry base class, and represent different types of shapes.
The following are common geometry characteristics:
- Geometries have a spatial reference indicating the coordinate system used by its coordinates.
- Geometries can be empty, indicating that they have no specific location or shape.
- Geometries can have z-values and/or m-values.
- Geometries can be converted to and from JSON to be persisted or to be exchanged directly with REST services.
Geometries are immutable
Most geometries are created and not changed for their lifetime. Examples include feature geometry created for storage in a geodatabase, read from a non-editable layer, or returned from tasks such as spatial queries, geocode operations, network traces, or geoprocessing. Immutable geometries (geometries that cannot be changed) offer some significant benefits to your app. They are inherently thread-safe, help prevent accidental changes, and allow for certain performance optimizations.
While immutable geometries appear to present problems for editing existing geometries, those problems are solved by using geometry builders. Geometry builders are designed to represent the state of a geometry under construction while allowing modifications, thus enabling editing workflows.
Point
Point geometries represent a single point, place, or location such as a geocoded house address along a street or the location of a water meter in a water utility network. Larger geographic entities such as cities are often represented as points on small-scale maps. Points can be used as the geometry of features and graphics and are often used to help construct other geometries.
Points store a single set of x,y coordinates that represent a discrete location within a specified coordinate system (spatial reference). Optionally, a z-value (to define elevation, for example) can also be included. Instances of Point can be created using a constructor that defines the full geometry by passing an x coordinate, y coordinate, and spatial reference.
// Create a point with x, y, and z coordinate values using the WGS 1984 coordinate system.
val saltLakeCity = Point(-111.88, 40.75, 1320.0, SpatialReference.wgs84())
Envelope
Envelope geometries represent rectangular shapes with sides that are parallel with the x or y axis of the coordinate system. Most commonly, they represent the spatial extent of layers or other geometries, or define areas of interest for tasks. They can be used as the geometry of graphics and in many geometry operations. Envelopes cannot be used to store feature geometry.
New instances of Envelope are defined by specifying a minimum and maximum x-coordinate and minimum and maximum y-coordinate, and a SpatialReference. Optionally, a minimum and maximum z-value can be specified to define the depth of the envelope.
// Envelope with bounding coords defined in longitude and latitude.
var areaOfInterest = Envelope(
xMin = -117.85,
yMin = 32.20,
xMax = -116.50,
yMax = 33.45,
spatialReference = SpatialReference.wgs84()
)
Another way to define an envelope is by using two points. The minimum and maximum x,y coordinates are calculated from the two points.
// Envelope with lower-left (southwest) and upper-right (northeast) points.
val southwestPoint = Point(-117.85, 32.20, SpatialReference.wgs84())
val northeastPoint = Point(-116.50, 33.45, SpatialReference.wgs84())
val env = Envelope(southwestPoint, northeastPoint)
Multipoint
Multipoint geometries represent an ordered collection of points. They can be used as the geometry of features and graphics, or as input or output of geometry operations. For features that consist of a very large number of points that share the same set of attribute values, multipoints may be more efficient to store and analyze in a geodatabase compared to using multiple point features.
Multipoints are composed of a single read-only collection of points. To build a multipoint, create an MultipointBuilder, add points, and the geometry will return an Multipoint. You can also use geometry builders to modify an existing geometry.
val builder = MultipointBuilder(SpatialReference.wgs84()) {
points.add(southwestPoint)
points.add(northeastPoint)
points.add(sanDiego)
}
val oneMultipoint = builder.toGeometry()
To access each Point in an existing Multipoint, iterate over the read-only point collection returned from the points property.
oneMultipoint.points.forEach { point ->
logInfo("x: ${point.x}, y: ${point.y}, z: ${point.z}")
}
Polyline
Polyline geometries represent the shape and location of linear features, such as a street in a road network or a pipeline in an oil refinery. They can be used as the geometry of features and graphics, or as input or output of tasks or geoprocessing operations, such as the output of a network trace.
Polylines are composed of a series of connected segments, where each segment defines a continuous line between a start and an end point. ArcGIS supports both linear and curve segments. For more information, see the Segments section below.
You can create a Polyline using a PolylineBuilder. The builder creates a series of straight line segments connecting the points you specify.
Polylines can have multiple parts. Each part is a series of connected segments, but the parts can be disjoint from each other, such as a polyline representing a discontinuous highway that has an unfinished section. Parts can also intersect at one or more vertices. For example, in a polyline representing a river and its tributaries. The Polyline class inherits from Multipart, which provides members for iterating through the segments and points of each part in a polyline.
To modify an existing polyline, use PolylineBuilder.
// Define some map points (airports: LA, Chicago, Paris).
val laxPoint = Point(-118.408, 33.943, SpatialReference.wgs84())
val ordPoint = Point(-87.905, 41.979, SpatialReference.wgs84())
val orlyPoint = Point(2.379, 48.723, SpatialReference.wgs84())
// Add the points to a collection.
val stops = listOf<Point>(laxPoint, ordPoint, orlyPoint)
// Create a new Polyline from the points.
val myFlightPath = Polyline(stops)
Polygon
Polygon geometries represent the shape and location of areas, such as a country or a lake. They can be used as the geometry of features and graphics, or as input or output of tasks or geoprocessing operations, such as the output of a drive-time analysis or a buffer operation.
Polygons are similar to polylines in that they are also composed of a series of connected segments. However, polygons define closed areas, so the end point of the last segment is always in the same location as the start point of the first segment, forming a closed boundary. As with polylines, you can work with the vertices of the segments of a polygon by using point-based helper methods. For more information on segments, see Segments on this page.
To build a Polygon, create a PolygonBuilder and add points in the correct order around the polygon's perimeter. Next, use the to method to provide the Polygon.
Similar to polylines, polygons can have multiple parts but have different rules than those for multipart polylines. Each part of a multipart polygon is a series of connected segments forming a closed ring. Each part must not cross any other part but may lie completely inside or outside another part. For example, a polygon representing the state of Hawaii would comprise eight disjoint parts, one representing each island. A polygon representing the country of South Africa, which completely surrounds the enclave of Lesotho, would comprise two parts, one contained inside the other. The Polygon class also inherits from Multipart.
// Create a polygon builder; add each corner of the state of Colorado.
val polyBuilder = PolygonBuilder(SpatialReference.wgs84()) {
addPoint(-109.048, 40.998)
addPoint(-102.047, 40.998)
addPoint(-102.037, 36.989)
addPoint(-109.048, 36.998)
}
// Get the defined polygon from the polygon builder.
val coloradoPoly = polyBuilder.toGeometry()
Multipart (Polygon and Polyline)
Polygon and Polyline inherit from Multipart. Multipart provides access to a collection of the geometry's parts.
Each part in the collection is a collection of segment objects (see Segments below). You can iterate through the segments or points in each part.
// Iterate through all parts in a Polygon
hawaiiPoly.parts.forEachIndexed() { partIndex, part: Part ->
// Iterate the Segments of each Part.
part.forEachIndexed() { segmentIndex, segment ->
logInfo("In Part ${partIndex}, Segment $segmentIndex has these start and end points:" +
"(${segment.startPoint.x},${segment.startPoint.y}) and (${segment.endPoint.x},${segment.endPoint.y})"
)
}
// Iterate the collection of Points representing vertices of each Part.
logInfo("The Part contains the following points:")
part.points.forEach { point ->
logInfo("x: ${point.x} y: ${point.y} z: ${point.z}")
}
}
You can iterate through the points that represent the vertices in all the parts.
// Iterate through all the points (vertices) in all the parts of a Polygon
logInfo("Polygon contains the following points:")
hawaiiPoly.parts.forEach { part ->
part.points.forEach { point ->
logInfo("x: ${point.x} y: ${point.y} z: ${point.z}")
}
}
In the same way as Polygon and Polyline are immutable, the collections returned from Multipart are also immutable.
Segments
A segment describes a continuous line between a start location and an end location. Every part in a multipart geometry is a collection of Segments where the end of one segment is at exactly the same location as the start of the following segment. The ArcGIS system supports both straight and curved segments, with a few exceptions noted in the Perform edits topic in this guide. Multipart geometries can be composed from and decomposed into segments if required.
Linear segments are represented with instances of the LineSegment class. Curve segments can be represented with an EllipticArcSegment or CubicBezierSegment. See the True curves section of this topic for more information about working with curve geometries.
Because a single location is shared by adjacent segments, a single Point object is used to represent the shared location when you iterate through the points in a part. As a result, when iterating through the points in a part of a polyline, there will be one more Point than the number of Segments in that same part.
Similar to the geometries they comprise, Segments are immutable.
Work with geometry
Spatial references
The meaning of the coordinates in a geometry is determined by the geometry's spatial reference. The vertices and spatial reference together allow your app to translate a real-world object from its location on the Earth to its location on your map or scene.
In some cases, a geometry's spatial reference may not be set. Graphics that do not have a spatial reference are drawn using the same spatial reference as the map view in which they are drawn. When using a geometry builder to create a polyline or polygon geometry from point geometries, you don't need to set the spatial reference of every point before you add it to the builder, as it will be assigned the spatial reference of the builder it's added to. In most other cases, such as when using a geometry in geometry operations or when editing a feature table, the geometry's spatial reference must be set.
Learn more about spatial references
Linear, angular, and area units
Different types of unit of measurement can be used throughout this API. Projected coordinate systems define coordinates using linear measurements, for example using meters or miles, which are represented by LinearUnit. Linear units are also used to return distance measurements, for example by some members of GeometryEngine. Geographic coordinate systems define coordinates using angular measurements, for example using degrees or radians, which are represented by AngularUnit. Methods that calculate the size of areas, for example in acres or square kilometers, use area units. These are represented by AreaUnit. Linear, angular, and area units can be defined by using enumerations of the most common units of measurement. They can also be defined by Well-Known ID (WKID) or Well-Known Text (WKT).
Projection, topological, and other operations
Changing the coordinates of a geometry to have the same shape and location represented using a different spatial reference is known as "projection" or sometimes as "reprojection". Because geometries are immutable, they do not have any member methods that project, transform, or otherwise modify their content.
The GeometryEngine class provides a wide range of methods that read the content of geometries and modify that content to create new geometries. There are methods to project, buffer, union, and so on. Note that not all methods support true curves. When creating geometries using locations from the screen, and the map is a wraparound map, you may also need to consider normalizing a geometry before you save it to a geodatabase or use it in tasks or other operations. In addition, the geometry engine has a range of methods that support spatial analysis through some of the following operations: buffer, clip, equals, or intersection. To gain more insight on what geometry analysis is about, see Introduction to geometry analysis; otherwise, refer to the class documentation.
Use the GeometryEngine class to project geometries to a different spatial reference.
val wgsPoint = Point(x = -122.411445, y = 37.773017, spatialReference = SpatialReference.wgs84())
val projectedPoint = GeometryEngine.projectOrNull(wgsPoint, SpatialReference.webMercator())
?: return logErr("GeometryEngine unable to project.")
True curves
Sometimes, shapes that appear as curves on a map are really a series of connected linear segments that approximate a curve. For many use cases (and depending on the accuracy you require for the data), this is an acceptable way to represent curved features. ArcGIS can also store and display geometry using segments that accurately represent curvilinear geometry. Curved segments are represented with instances of the EllipticArcSegment or CubicBezierSegment classes. These segments are referred to as true curves.
You can add curve segments to a MultipartBuilder, and if a geometry has curves then curve segments are returned where applicable from the collections that comprise the multipart geometry. Curve and linear segments can be mixed together in the same multipart geometry.
You can use GeometryEngine.densifyOrNull() to create an approximated curve from a true curve based on several linear segments. Such a curve is often referred to as a densified curve. By default, curve geometries are not fetched from services that support curves, meaning that densified versions of true curve geometries are returned instead.
Curve geometries stored in services where onlyAllowTrueCurveUpdatesByTrueCurveClients is true cannot be updated by default.
Convert to and from JSON
Geometries can be serialized and de-serialized to and from JSON. The ArcGIS REST API documentation describes the JSON representation of geometry objects. You can use this encoding and decoding mechanism to exchange geometries with REST Web services or to store them in text files.
Converting to or from JSON can add points to multipart geometries if the geometry has insufficient points to construct a segment.
// Return a polygon as json-formatted text.
val jsonString = coloradoPoly.toJson()
// Re-create the polygon from json using the fromJson() companion object method on Geometry
val newPoly = Geometry.fromJsonOrNull(jsonString) ?: return logErr("Unable to return json from the geometry")
Z-values and 3D
Geometries can have z-values, indicating values along the z-axis, which is orthogonal to both the x-axis and y-axis. Z-values can indicate height above or depth below a surface, or an absolute elevation. For example, z-values are used to draw the locations of geometries in scene views. Note that geometries are not considered true 3D shapes and are draped onto surfaces in the view, or in some cases, drawn in a single plane by using z-values. Z-values are stored on Point and Envelope. Therefore, because all other geometries are created from Point, all types of geometry can have z-values.
Whether or not a geometry has z-values is determined when the geometry is created; if you use a method that has a z-value parameter, the new geometry will have z-values (the geometry's has will be true). If you create geometries using constructors that take z-value parameters, or if you pass into the constructor points or segments that have z-values, the new geometry will have z-values. A geometry with z-values is sometimes known as a z-aware geometry.
It may be that not all vertices in your geometry have a z-value defined. Na is a valid z-value used to indicate an unknown z-value. However, the default z-value is zero. It is important to note that when you get z-values from a geometry that does not have z-values, the default value of zero is returned. Check the has property to determine whether a z-value of zero means that there are no z-values in the geometry or that the z-value in the geometry's coordinates really is zero.
M-values
M-values are used in linear referencing scenarios, and like z-values, every geometry can optionally store m-values. The default m-value is Na. If an m-value is specified as a parameter when a geometry is created, the new geometry will have m-values (the geometry's has will be true). Note that when you get m-values back from a geometry, the default value of Na (different than the default for z-values) is returned for vertices that do not have m-values. A geometry with m-values is sometimes known as an m-aware geometry.
True curves
Sometimes, shapes that appear as curves on a map are really a series of connected linear segments that approximate a curve. For many use cases (and depending on the accuracy you require for the data), this is an acceptable way to represent curved features. ArcGIS can also store and display geometry using segments that accurately represent curvilinear geometry. Curved segments are represented with instances of the EllipticArcSegment or CubicBezierSegment classes. These segments are referred to as true curves.
You can add curve segments to a MultipartBuilder, and if a geometry has curves then curve segments are returned where applicable from the collections that comprise the multipart geometry. Curve and linear segments can be mixed together in the same multipart geometry.
You can use GeometryEngine.densifyOrNull() to create an approximated curve from a true curve based on several linear segments. Such a curve is often referred to as a densified curve. By default, curve geometries are not fetched from services that support curves, meaning that densified versions of true curve geometries are returned instead.
Curve geometries stored in services where onlyAllowTrueCurveUpdatesByTrueCurveClients is true cannot be updated by default.