Contains Method (GeometryEngine)

In This Topic

Returns true if geometry1 contains geometry2.

Syntax

Visual Basic (Declaration)
C#

Public Function Contains( _
   ByVal geometry1 As Geometry, _
   ByVal geometry2 As Geometry _
) As Boolean

public bool Contains( 
   Geometry geometry1,
   Geometry geometry2
)

Parameters

geometry1: The base geometry.
geometry2: The comparison geometry.

Return Value

True if the geometry1 contains geometry2.

Exceptions

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

Remarks

If both geometry1 and geometry2 are not empty, then geometry1 contains geometry2 if the intersection of their interiors is not empty and geometry2 is a subset of geometry1.

If geometry1 is empty, then it does not contain geometry2.

If geometry1 is not empty and geometry2 is empty, then geometry1 contains geometry2.

Contains is the opposite of Within. That is, geometry1 contains geometry2 if and only if geometry2 is within geometry1.

GeometryEngine Contains

Example

Polygon contains MapPoints, Polylines, Polygons

{
    // build a polygon      
    List<MapPoint> pts =
    [
      MapPointBuilderEx.CreateMapPoint(1.0, 1.0),
  MapPointBuilderEx.CreateMapPoint(1.0, 2.0),
  MapPointBuilderEx.CreateMapPoint(2.0, 2.0),
  MapPointBuilderEx.CreateMapPoint(2.0, 1.0),
];

    Polygon poly = PolygonBuilderEx.CreatePolygon(pts);

    // test if an inner point is contained
    MapPoint innerPt = MapPointBuilderEx.CreateMapPoint(1.5, 1.5);
    bool contains = GeometryEngine.Instance.Contains(poly, innerPt);   // contains = true

    // test a point on a boundary
    contains = GeometryEngine.Instance.Contains(poly, poly.Points[0]);     // contains = false

    // test an interior line
    MapPoint innerPt2 = MapPointBuilderEx.CreateMapPoint(1.25, 1.75);
    List<MapPoint> innerLinePts = [innerPt, innerPt2];

    // test an inner polyline
    polyline = PolylineBuilderEx.CreatePolyline(innerLinePts);
    contains = GeometryEngine.Instance.Contains(poly, polyline);   // contains = true

    // test a line that crosses the boundary
    MapPoint outerPt = MapPointBuilderEx.CreateMapPoint(3, 1.5);
    List<MapPoint> crossingLinePts = [innerPt, outerPt];

    polyline = PolylineBuilderEx.CreatePolyline(crossingLinePts);
    contains = GeometryEngine.Instance.Contains(poly, polyline);     // contains = false

    // test a polygon in polygon
    Envelope env = EnvelopeBuilderEx.CreateEnvelope(innerPt, innerPt2);
    contains = GeometryEngine.Instance.Contains(poly, env);      // contains = true
  }

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

GeometryEngine Class
GeometryEngine Members

Send feedback