Method Locate

Namespace

GeometryHelper.Core

Assembly

GeometryHelper.dll

Locate(GeoCircle2, GeoPoint2)

Classifies the spatial location of a point relative to a circle using default tolerance.

public static PointLocation Locate(GeoCircle2 circle, GeoPoint2 point)

Parameters

circle GeoCircle2

The circle.

point GeoPoint2

The target point.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoCircle2, GeoPoint2, Tolerance)

Classifies the spatial location of a point relative to a circle within tolerance.

public static PointLocation Locate(GeoCircle2 circle, GeoPoint2 point, Tolerance tolerance)

Parameters

circle GeoCircle2

The circle.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoRectangle2, GeoPoint2)

Classifies the spatial location of a point relative to a rotated rectangle (GeoRectangle2 OBB) using default tolerance.

public static PointLocation Locate(GeoRectangle2 rect, GeoPoint2 point)

Parameters

rect GeoRectangle2

The rectangle.

point GeoPoint2

The target point.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoRectangle2, GeoPoint2, Tolerance)

Classifies the spatial location of a point relative to a rotated rectangle (GeoRectangle2 OBB) within tolerance.

public static PointLocation Locate(GeoRectangle2 rect, GeoPoint2 point, Tolerance tolerance)

Parameters

rect GeoRectangle2

The rectangle.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoPolygon2, GeoPoint2)

Classifies the spatial location of a point relative to a polygon using default tolerance.

public static PointLocation Locate(GeoPolygon2 poly, GeoPoint2 point)

Parameters

poly GeoPolygon2

The polygon.

point GeoPoint2

The target point.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoPolygon2, GeoPoint2, Tolerance)

Classifies the spatial location of a point relative to a polygon within tolerance.

public static PointLocation Locate(GeoPolygon2 poly, GeoPoint2 point, Tolerance tolerance)

Parameters

poly GeoPolygon2

The polygon.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoPolyline2, GeoPoint2)

Classifies the spatial location of a point relative to a polyline using default tolerance. A polyline has no interior, so the result is either OnSide or OutSide.

public static PointLocation Locate(GeoPolyline2 polyline, GeoPoint2 point)

Parameters

polyline GeoPolyline2

The polyline.

point GeoPoint2

The target point.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoPolyline2, GeoPoint2, Tolerance)

Classifies the spatial location of a point relative to a polyline within tolerance. A polyline has no interior, so the result is either OnSide or OutSide; convert it with ToPolygon() to classify against an enclosed area.

public static PointLocation Locate(GeoPolyline2 polyline, GeoPoint2 point, Tolerance tolerance)

Parameters

polyline GeoPolyline2

The polyline.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoLine2, GeoPoint2)

Classifies the spatial location of a point relative to a line segment using default tolerance.

public static PointLocation Locate(GeoLine2 line, GeoPoint2 point)

Parameters

line GeoLine2

The line segment.

point GeoPoint2

The target point.

Returns

PointLocation

PointLocation.OnSide if on the line segment; otherwise PointLocation.OutSide.

Locate(GeoLine2, GeoPoint2, Tolerance)

Classifies the spatial location of a point relative to a line segment within tolerance.

public static PointLocation Locate(GeoLine2 line, GeoPoint2 point, Tolerance tolerance)

Parameters

line GeoLine2

The line segment.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance.

Returns

PointLocation

PointLocation.OnSide if on the line segment; otherwise PointLocation.OutSide.

Locate(GeoFace2, GeoPoint2)

Classifies the spatial location of a point relative to a face with holes using default tolerance.

public static PointLocation Locate(GeoFace2 face, GeoPoint2 point)

Parameters

face GeoFace2

The face.

point GeoPoint2

The target point.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoFace2, GeoPoint2, Tolerance)

Classifies the spatial location of a point relative to a face with holes within tolerance.

public static PointLocation Locate(GeoFace2 face, GeoPoint2 point, Tolerance tolerance)

Parameters

face GeoFace2

The face.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Remarks

A point inside a hole is outside the face, and a point on the rim of a hole is on its boundary, since the rim is as much an edge of the material as the outer loop is.

Locate(GeoTriangle2, GeoPoint2)

Classifies the location of a point relative to a triangle using default tolerance.

public static PointLocation Locate(GeoTriangle2 triangle, GeoPoint2 point)

Parameters

triangle GeoTriangle2

The triangle.

point GeoPoint2

The target point.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Locate(GeoTriangle2, GeoPoint2, Tolerance)

Classifies the location of a point relative to a triangle within tolerance.

public static PointLocation Locate(GeoTriangle2 triangle, GeoPoint2 point, Tolerance tolerance)

Parameters

triangle GeoTriangle2

The triangle.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance.

Returns

PointLocation

PointLocation.Inside, PointLocation.OnSide, or PointLocation.OutSide.

Remarks

A point within the point tolerance of an edge is on it. Any other point is inside when it lies on the same side of all three edges, so a triangle has the same inside whichever way it runs. A triangle of no area has no inside at all: a point is on its edges or outside it.

Locate(GeoPolylineArc2, GeoPoint2)

Says where a point lies against a chain that may curve.

public static PointLocation Locate(GeoPolylineArc2 chain, GeoPoint2 point)

Parameters

chain GeoPolylineArc2

point GeoPoint2

Returns

PointLocation

Remarks

A chain is a curve, so it encloses nothing: a point is either on it or outside it, exactly as with Locate(GeoPolyline2, GeoPoint2).

Exceptions

ArgumentNullException

Thrown when the chain is null.

Locate(GeoPolylineArc2, GeoPoint2, Tolerance)

Says where a point lies against a chain that may curve, within a tolerance.

public static PointLocation Locate(GeoPolylineArc2 chain, GeoPoint2 point, Tolerance tolerance)

Parameters

chain GeoPolylineArc2

point GeoPoint2

tolerance Tolerance

Returns

PointLocation

Exceptions

ArgumentNullException

Thrown when the chain is null.

Locate(GeoPolygonArc2, GeoPoint2)

Says where a point lies against a loop that may curve.

public static PointLocation Locate(GeoPolygonArc2 loop, GeoPoint2 point)

Parameters

loop GeoPolygonArc2

point GeoPoint2

Returns

PointLocation

Exceptions

ArgumentNullException

Thrown when the loop is null.

Locate(GeoPolygonArc2, GeoPoint2, Tolerance)

Says where a point lies against a loop that may curve, within a tolerance.

public static PointLocation Locate(GeoPolygonArc2 loop, GeoPoint2 point, Tolerance tolerance)

Parameters

loop GeoPolygonArc2

point GeoPoint2

tolerance Tolerance

Returns

PointLocation

Remarks

The answer is exact, with no arc cut into pieces anywhere in it: it is the straight loop through the vertices, turned inside out once for every piece an arc cuts off its own chord that the point happens to lie in.

Exceptions

ArgumentNullException

Thrown when the loop is null.