Cut a geometry along a polyline.
Use case
You might cut a polygon representing a large parcel to subdivide it into smaller parcels.
How to use the sample
Tap the "Cut" button to cut the polygon with the polyline and see the resulting parts (shaded in different colors).
How it works
- Pass the geometry and polyline to
GeometryEngine.Cut
to cut the geometry along the polyline. - Loop through the returned list of part geometries. Some of these geometries may be multi-part.
Relevant API
- GeometryEngine.Cut
- Polygon
- Polyline
Tags
cut, geometry, split
Sample Code
CutGeometry.cs
// Copyright 2018 Esri.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
// You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
// language governing permissions and limitations under the License.
using System;
using Esri.ArcGISRuntime.Geometry;
using Esri.ArcGISRuntime.Mapping;
using Esri.ArcGISRuntime.Symbology;
using Esri.ArcGISRuntime.UI;
using Esri.ArcGISRuntime.UI.Controls;
using Foundation;
using UIKit;
namespace ArcGISRuntime.Samples.CutGeometry
{
[Register("CutGeometry")]
[ArcGISRuntime.Samples.Shared.Attributes.Sample(
name: "Cut geometry",
category: "Geometry",
description: "Cut a geometry along a polyline.",
instructions: "Tap the \"Cut\" button to cut the polygon with the polyline and see the resulting parts (shaded in different colors).",
tags: new[] { "cut", "geometry", "split" })]
public class CutGeometry : UIViewController
{
// Hold references to UI controls.
private MapView _myMapView;
private UIBarButtonItem _cutGeometryButton;
// Graphics overlay to display the graphics.
private GraphicsOverlay _graphicsOverlay;
// Graphic that represents the polygon of Lake Superior.
private Graphic _lakeSuperiorPolygonGraphic;
// Graphic that represents the Canada and USA border (polyline) of Lake Superior.
private Graphic _countryBorderPolylineGraphic;
public CutGeometry()
{
Title = "Cut geometry";
}
private void Initialize()
{
// Create and show a map with a topographic basemap.
_myMapView.Map = new Map(BasemapStyle.ArcGISTopographic);
// Create a graphics overlay to hold the various graphics.
_graphicsOverlay = new GraphicsOverlay();
// Add the created graphics overlay to the MapView.
_myMapView.GraphicsOverlays.Add(_graphicsOverlay);
// Create a simple line symbol for the outline of the Lake Superior graphic.
SimpleLineSymbol lakeSuperiorSimpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Solid, System.Drawing.Color.Blue, 4);
// Create the color that will be used for the fill the Lake Superior graphic. It will be a semi-transparent, blue color.
System.Drawing.Color lakeSuperiorFillColor = System.Drawing.Color.FromArgb(34, 0, 0, 255);
// Create the simple fill symbol for the Lake Superior graphic - comprised of a fill style, fill color and outline.
SimpleFillSymbol lakeSuperiorSimpleFillSymbol = new SimpleFillSymbol(SimpleFillSymbolStyle.Solid, lakeSuperiorFillColor, lakeSuperiorSimpleLineSymbol);
// Create the graphic for Lake Superior - comprised of a polygon shape and fill symbol.
_lakeSuperiorPolygonGraphic = new Graphic(CreateLakeSuperiorPolygon(), lakeSuperiorSimpleFillSymbol);
// Add the Lake Superior graphic to the graphics overlay collection.
_graphicsOverlay.Graphics.Add(_lakeSuperiorPolygonGraphic);
// Create a simple line symbol for the Canada and USA border (polyline) of Lake Superior.
SimpleLineSymbol countryBorderSimpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Dot, System.Drawing.Color.Red, 5);
// Create the graphic for Canada and USA border (polyline) of Lake Superior - comprised of a polyline shape and line symbol.
_countryBorderPolylineGraphic = new Graphic(CreateBorder(), countryBorderSimpleLineSymbol);
// Add the Canada and USA border graphic to the graphics overlay collection.
_graphicsOverlay.Graphics.Add(_countryBorderPolylineGraphic);
// Set the initial visual extent of the map view to that of Lake Superior.
_myMapView.SetViewpointGeometryAsync(_lakeSuperiorPolygonGraphic.Geometry);
}
private void CutButton_TouchUpInside(object sender, EventArgs e)
{
try
{
// Cut the polygon geometry with the polyline, expect two geometries.
Geometry[] cutGeometries = GeometryEngine.Cut(_lakeSuperiorPolygonGraphic.Geometry, (Polyline) _countryBorderPolylineGraphic.Geometry);
// Create a simple line symbol for the outline of the Canada side of Lake Superior.
SimpleLineSymbol canadaSideSimpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Null, System.Drawing.Color.Blue, 0);
// Create the simple fill symbol for the Canada side of Lake Superior graphic - comprised of a fill style, fill color and outline.
SimpleFillSymbol canadaSideSimpleFillSymbol = new SimpleFillSymbol(SimpleFillSymbolStyle.ForwardDiagonal, System.Drawing.Color.Green, canadaSideSimpleLineSymbol);
// Create the graphic for the Canada side of Lake Superior - comprised of a polygon shape and fill symbol.
Graphic canadaSideGraphic = new Graphic(cutGeometries[0], canadaSideSimpleFillSymbol);
// Add the Canada side of the Lake Superior graphic to the graphics overlay collection.
_graphicsOverlay.Graphics.Add(canadaSideGraphic);
// Create a simple line symbol for the outline of the USA side of Lake Superior.
SimpleLineSymbol usaSideSimpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle.Null, System.Drawing.Color.Blue, 0);
// Create the simple fill symbol for the USA side of Lake Superior graphic - comprised of a fill style, fill color and outline.
SimpleFillSymbol usaSideSimpleFillSymbol = new SimpleFillSymbol(SimpleFillSymbolStyle.ForwardDiagonal, System.Drawing.Color.Yellow, usaSideSimpleLineSymbol);
// Create the graphic for the USA side of Lake Superior - comprised of a polygon shape and fill symbol.
Graphic usaSideGraphic = new Graphic(cutGeometries[1], usaSideSimpleFillSymbol);
// Add the USA side of the Lake Superior graphic to the graphics overlay collection.
_graphicsOverlay.Graphics.Add(usaSideGraphic);
// Disable the button after has been used.
((UIBarButtonItem) sender).Enabled = false;
}
catch (Exception ex)
{
// Display an error message if there is a problem generating cut operation.
UIAlertController alertController = UIAlertController.Create("Geometry Engine Failed!", ex.Message, UIAlertControllerStyle.Alert);
alertController.AddAction(UIAlertAction.Create("OK", UIAlertActionStyle.Default, null));
PresentViewController(alertController, true, null);
}
}
private Polyline CreateBorder()
{
// Create a point collection that represents the Canada and USA border (polyline) of Lake Superior. Use the same spatial reference as the underlying base map.
PointCollection borderCountryPointCollection = new PointCollection(SpatialReferences.WebMercator)
{
// Add all of the border map points to the point collection.
new MapPoint(-9981328.687124, 6111053.281447),
new MapPoint(-9946518.044066, 6102350.620682),
new MapPoint(-9872545.427566, 6152390.920079),
new MapPoint(-9838822.617103, 6157830.083057),
new MapPoint(-9446115.050097, 5927209.572793),
new MapPoint(-9430885.393759, 5876081.440801),
new MapPoint(-9415655.737420, 5860851.784463)
};
// Return a polyline geometry from the point collection.
return new Polyline(borderCountryPointCollection);
}
private Polygon CreateLakeSuperiorPolygon()
{
// Create a point collection that represents Lake Superior (polygon). Use the same spatial reference as the underlying base map.
PointCollection lakeSuperiorPointCollection = new PointCollection(SpatialReferences.WebMercator)
{
// Add all of the lake Superior boundary map points to the point collection.
new MapPoint(-10254374.668616, 5908345.076380),
new MapPoint(-10178382.525314, 5971402.386779),
new MapPoint(-10118558.923141, 6034459.697178),
new MapPoint(-9993252.729399, 6093474.872295),
new MapPoint(-9882498.222673, 6209888.368416),
new MapPoint(-9821057.766387, 6274562.532928),
new MapPoint(-9690092.583250, 6241417.023616),
new MapPoint(-9605207.742329, 6206654.660191),
new MapPoint(-9564786.389509, 6108834.986367),
new MapPoint(-9449989.747500, 6095091.726408),
new MapPoint(-9462116.153346, 6044160.821855),
new MapPoint(-9417652.665244, 5985145.646738),
new MapPoint(-9438671.768711, 5946341.148031),
new MapPoint(-9398250.415891, 5922088.336339),
new MapPoint(-9419269.519357, 5855797.317714),
new MapPoint(-9467775.142741, 5858222.598884),
new MapPoint(-9462924.580403, 5902686.086985),
new MapPoint(-9598740.325877, 5884092.264688),
new MapPoint(-9643203.813979, 5845287.765981),
new MapPoint(-9739406.633691, 5879241.702350),
new MapPoint(-9783061.694736, 5922896.763395),
new MapPoint(-9844502.151022, 5936640.023354),
new MapPoint(-9773360.570059, 6019099.583107),
new MapPoint(-9883306.649729, 5968977.105610),
new MapPoint(-9957681.938918, 5912387.211662),
new MapPoint(-10055501.612742, 5871965.858842),
new MapPoint(-10116942.069028, 5884092.264688),
new MapPoint(-10111283.079633, 5933406.315128),
new MapPoint(-10214761.742852, 5888134.399970),
new MapPoint(-10254374.668616, 5901877.659929)
};
// Return a polyline geometry from the point collection.
return new Polygon(lakeSuperiorPointCollection);
}
public override void ViewDidLoad()
{
base.ViewDidLoad();
Initialize();
}
public override void LoadView()
{
// Create the views.
View = new UIView {BackgroundColor = ApplicationTheme.BackgroundColor};
_myMapView = new MapView();
_myMapView.TranslatesAutoresizingMaskIntoConstraints = false;
_cutGeometryButton = new UIBarButtonItem();
_cutGeometryButton.Title = "Cut geometry";
UIToolbar toolbar = new UIToolbar();
toolbar.TranslatesAutoresizingMaskIntoConstraints = false;
toolbar.Items = new[]
{
new UIBarButtonItem(UIBarButtonSystemItem.FlexibleSpace),
_cutGeometryButton,
new UIBarButtonItem(UIBarButtonSystemItem.FlexibleSpace)
};
// Add the views.
View.AddSubviews(_myMapView, toolbar);
// Lay out the views.
NSLayoutConstraint.ActivateConstraints(new[]
{
_myMapView.TopAnchor.ConstraintEqualTo(View.SafeAreaLayoutGuide.TopAnchor),
_myMapView.LeadingAnchor.ConstraintEqualTo(View.LeadingAnchor),
_myMapView.TrailingAnchor.ConstraintEqualTo(View.TrailingAnchor),
_myMapView.BottomAnchor.ConstraintEqualTo(toolbar.TopAnchor),
toolbar.BottomAnchor.ConstraintEqualTo(View.SafeAreaLayoutGuide.BottomAnchor),
toolbar.LeadingAnchor.ConstraintEqualTo(View.LeadingAnchor),
toolbar.TrailingAnchor.ConstraintEqualTo(View.TrailingAnchor),
});
}
public override void ViewWillAppear(bool animated)
{
base.ViewWillAppear(animated);
// Subscribe to events.
_cutGeometryButton.Clicked += CutButton_TouchUpInside;
}
public override void ViewDidDisappear(bool animated)
{
base.ViewDidDisappear(animated);
// Unsubscribe from events, per best practice.
_cutGeometryButton.Clicked -= CutButton_TouchUpInside;
}
}
}