Class PreparedPolygon

A prepared version for IPolygonal geometries. This class supports both Polygons and MultiPolygons.

This class does not support MultiPolygons which are non-valid (e.g. with overlapping elements).

Instances of this class are thread-safe and immutable.

Inheritance

object

BasicPreparedGeometry

PreparedPolygon

Implements

IPreparedGeometry

Inherited Members

BasicPreparedGeometry.Geometry

BasicPreparedGeometry.RepresentativePoints

BasicPreparedGeometry.IsAnyTargetComponentInTest(Geometry)

BasicPreparedGeometry.EnvelopesIntersect(Geometry)

BasicPreparedGeometry.EnvelopeCovers(Geometry)

BasicPreparedGeometry.CoveredBy(Geometry)

BasicPreparedGeometry.Crosses(Geometry)

BasicPreparedGeometry.Disjoint(Geometry)

BasicPreparedGeometry.Overlaps(Geometry)

BasicPreparedGeometry.Touches(Geometry)

BasicPreparedGeometry.Within(Geometry)

BasicPreparedGeometry.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: NetTopologySuite.Geometries.Prepared

Assembly: NetTopologySuite.dll

Syntax

public class PreparedPolygon : BasicPreparedGeometry, IPreparedGeometry

Constructors

PreparedPolygon(IPolygonal)

Declaration

public PreparedPolygon(IPolygonal poly)

Parameters

Type	Name	Description
IPolygonal	poly

Properties

IntersectionFinder

Declaration

public FastSegmentSetIntersectionFinder IntersectionFinder { get; }

Property Value

Type	Description
FastSegmentSetIntersectionFinder

PointLocator

Declaration

public IPointOnGeometryLocator PointLocator { get; }

Property Value

Type	Description
IPointOnGeometryLocator

Methods

Contains(Geometry)

Tests whether the base Geometry contains a given geometry.

Declaration

public override bool Contains(Geometry g)

Parameters

Type	Name	Description
Geometry	g	The Geometry to test

Returns

Type	Description
bool	true if this Geometry contains the given Geometry

Overrides

BasicPreparedGeometry.Contains(Geometry)

Remarks

Default implementation.

ContainsProperly(Geometry)

Tests whether the base Geometry properly contains a given geometry.

The ContainsProperly predicate has the following equivalent definitions:

In other words, if the test geometry has any interaction with the boundary of the target geometry the result of ContainsProperly is false. This is different semantics to the Contains(Geometry) predicate, in which test geometries can intersect the target's boundary and still be contained.

The advantage of using this predicate is that it can be computed efficiently, since it avoids the need to compute the full topological relationship of the input boundaries in cases where they intersect.

An example use case is computing the intersections of a set of geometries with a large polygonal geometry. Since intersection is a fairly slow operation, it can be more efficient to use ContainsProperly(Geometry) to filter out test geometries which lie wholly inside the area. In these cases the intersection is known a priori to be simply the original test geometry.

Declaration

public override bool ContainsProperly(Geometry g)

Parameters

Type	Name	Description
Geometry	g	The geometry to test

Returns

Type	Description
bool	true if this geometry properly contains the given geometry

Overrides

BasicPreparedGeometry.ContainsProperly(Geometry)

Remarks

Default implementation.

See Also

Contains(Geometry)

Covers(Geometry)

Tests whether the base Geometry covers a given geometry.

Declaration

public override bool Covers(Geometry g)

Parameters

Type	Name	Description
Geometry	g	The geometry to test

Returns

Type	Description
bool	true if this geometry covers the given geometry

Overrides

BasicPreparedGeometry.Covers(Geometry)

Remarks

Default implementation.

Intersects(Geometry)

Tests whether the base Geometry intersects a given geometry.

Declaration

public override bool Intersects(Geometry g)

Parameters

Type	Name	Description
Geometry	g	The geometry to test

Returns

Type	Description
bool	true if this geometry intersects the given geometry

Overrides

BasicPreparedGeometry.Intersects(Geometry)

Remarks

Default implementation.

Implements

IPreparedGeometry