Difference Method (GeometryEngine)

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

Example Collapse All

In This Topic

Syntax
Exceptions
Remarks
Example
Requirements
See Also

Difference Method (GeometryEngine)

In This Topic

Syntax
Exceptions
Remarks
Example
Requirements
See Also

Performs the topological difference operation on the two geometries.

Syntax

C#
Visual Basic (Declaration)

public Geometry Difference( 
   Geometry geometry1,
   Geometry geometry2
)

Public Function Difference( _
   ByVal geometry1 As Geometry, _
   ByVal geometry2 As Geometry _
) As Geometry

Parameters

geometry1: the Geometry instance on the left hand side of the subtraction.
geometry2: the Geometry on the right hand side being subtracted.

Return Value

Returns the result of subtraction. The result has the dimension of .

Exceptions

Exception	Description
System.ArgumentNullException	Either geometry1 or geometry2 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

GeometryEngine Difference

Example

Difference between two Polygons

C#

List<MapPoint> polyPts = new List<MapPoint>();
polyPts.Add(MapPointBuilderEx.CreateMapPoint(3.0, 2.0));
polyPts.Add(MapPointBuilderEx.CreateMapPoint(3.0, 6.0));
polyPts.Add(MapPointBuilderEx.CreateMapPoint(6.0, 6.0));
polyPts.Add(MapPointBuilderEx.CreateMapPoint(6.0, 2.0));

Polygon poly1 = PolygonBuilderEx.CreatePolygon(polyPts);

Envelope env = EnvelopeBuilderEx.CreateEnvelope(MapPointBuilderEx.CreateMapPoint(1.0, 1.0), MapPointBuilderEx.CreateMapPoint(4, 4));
Polygon poly2 = PolygonBuilderEx.CreatePolygon(env);

Geometry result = GeometryEngine.Instance.Difference(poly1, poly2);
Polygon polyResult = result as Polygon;
// polyResult.Area = 10.0

result = GeometryEngine.Instance.Difference(poly2, poly1);
polyResult = result as Polygon;
// polyResult.Area = 7.0

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

GeometryEngine Class
GeometryEngine Members

Send feedback