Cut Method (GeometryEngine)

ArcGIS.Core.Geometry Namespace / GeometryEngine Class / Cut Method

Example Collapse All

In This Topic

Syntax
Exceptions
Remarks
Example
Requirements
See Also

Cut Method (GeometryEngine)

In This Topic

Syntax
Exceptions
Remarks
Example
Requirements
See Also

Splits this geometry into parts. A polyline will be split into two parts at most.

Syntax

C#
Visual Basic (Declaration)

public IReadOnlyList<Geometry> Cut( 
   Multipart multipart,
   Polyline cutter
)

Public Function Cut( _
   ByVal multipart As Multipart, _
   ByVal cutter As Polyline _
) As IReadOnlyList(Of Geometry)

Parameters

multipart: The polygon or polyline to cut.
cutter: The cutting line.

Return Value

An IReadOnlyList<Geometry> representing the cut geometries. If either input geometry is empty or there was not a valid cut for another reason, and empty list is returned.

Exceptions

Exception	Description
System.ArgumentNullException	Either multipart or cutter or both are null or empty.
System.NotImplementedException	The method is not implemented for GeometryBag.
System.InvalidOperationException	Incompatible spatial references between the input geometries.

Remarks

When a polyline/polygon is cut, it is split where it intersects the cutter polyline. If a geometry is not cut, the returned IEnumerable<Geometry> will be empty.

If the input polyline is not known-simple, then the operation will be performed on a simplified copy of the polyline. There is no need for you to call any simplify method.

GeometryEngine Cut

Example

Cut a geometry with a polyline

C#

SpatialReference sr = SpatialReferences.WGS84;

List<MapPoint> list = new List<MapPoint>();
list.Add(MapPointBuilderEx.CreateMapPoint(1.0, 1.0, sr));
list.Add(MapPointBuilderEx.CreateMapPoint(1.0, 4.0, sr));
list.Add(MapPointBuilderEx.CreateMapPoint(4.0, 4.0, sr));
list.Add(MapPointBuilderEx.CreateMapPoint(4.0, 1.0, sr));

List<Geometry> cutGeometries;

LineSegment line = LineBuilderEx.CreateLineSegment(MapPointBuilderEx.CreateMapPoint(0, 0, sr), MapPointBuilderEx.CreateMapPoint(3, 6, sr));
Polyline cutter = PolylineBuilderEx.CreatePolyline(line);

// polyline
Polyline polyline = PolylineBuilderEx.CreatePolyline(list);
bool isSimple = GeometryEngine.Instance.IsSimpleAsFeature(polyline);
cutGeometries = GeometryEngine.Instance.Cut(polyline, cutter) as List<Geometry>;

Polyline leftPolyline = cutGeometries[0] as Polyline;
Polyline rightPolyline = cutGeometries[1] as Polyline;

// leftPolyline.Points[0] = 1, 2
// leftPolyline.Points[1] = 1, 4
// leftPolyline.Points[2] = 2, 4

// rightPolyline.Points.Count = 5
// rightPolyline.Parts.Count = 2

ReadOnlySegmentCollection segments0 = rightPolyline.Parts[0];
// segments0[0].StartCoordinate = 1, 1
// segments0[0].EndCoordinate = 1, 2

ReadOnlySegmentCollection segments1 = rightPolyline.Parts[1];
// segments1.Count = 2
// segments1[0].StartCoordinate = 2, 4
// segments1[0].EndCoordinate = 4, 4
// segments1[1].StartCoordinate = 4, 4
// segments1[1].EndCoordinate = 4, 1

// polygon 
Polygon polygon = PolygonBuilderEx.CreatePolygon(list);
isSimple = GeometryEngine.Instance.IsSimpleAsFeature(polygon);
cutGeometries = GeometryEngine.Instance.Cut(polygon, cutter) as List<Geometry>;

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

GeometryEngine Class
GeometryEngine Members

Send feedback