Table of Contents

Method IsPointOn

Namespace
GeometryHelper.Core
Assembly
GeometryHelper.dll

IsPointOn(GeoLine3, GeoPoint3)

Checks whether a point lies on a line segment, using the default tolerance.

public static bool IsPointOn(GeoLine3 line, GeoPoint3 point)

Parameters

line GeoLine3
point GeoPoint3

Returns

bool

IsPointOn(GeoLine3, GeoPoint3, Tolerance)

Checks whether a point lies on a line segment, within a tolerance.

public static bool IsPointOn(GeoLine3 line, GeoPoint3 point, Tolerance tolerance)

Parameters

line GeoLine3
point GeoPoint3
tolerance Tolerance

Returns

bool

Remarks

The segment is bounded, so a point on its infinite carrier but past an endpoint is not on it. A degenerate segment is a single point, and the test reduces to comparing against that point.

IsPointOn(GeoRay3, GeoPoint3)

Checks whether a point lies on a ray, using the default tolerance.

public static bool IsPointOn(GeoRay3 ray, GeoPoint3 point)

Parameters

ray GeoRay3
point GeoPoint3

Returns

bool

IsPointOn(GeoRay3, GeoPoint3, Tolerance)

Checks whether a point lies on a ray, within a tolerance.

public static bool IsPointOn(GeoRay3 ray, GeoPoint3 point, Tolerance tolerance)

Parameters

ray GeoRay3
point GeoPoint3
tolerance Tolerance

Returns

bool

Remarks

A ray starts at its origin, so a point on its carrier line but behind the origin is not on it.

IsPointOn(GeoPlane3, GeoPoint3)

Checks whether a point lies on a plane, using the default tolerance.

public static bool IsPointOn(GeoPlane3 plane, GeoPoint3 point)

Parameters

plane GeoPlane3
point GeoPoint3

Returns

bool

IsPointOn(GeoPlane3, GeoPoint3, Tolerance)

Checks whether a point lies on a plane, within a tolerance.

public static bool IsPointOn(GeoPlane3 plane, GeoPoint3 point, Tolerance tolerance)

Parameters

plane GeoPlane3
point GeoPoint3
tolerance Tolerance

Returns

bool

Remarks

The threshold is EqualPlanar rather than EqualPoint: this is the flatness question, and a plane is unbounded, so the point being tested can sit arbitrarily far from the plane origin.

IsPointOn(GeoPolyline3, GeoPoint3)

Checks whether a point lies on a polyline, using the default tolerance.

public static bool IsPointOn(GeoPolyline3 polyline, GeoPoint3 point)

Parameters

polyline GeoPolyline3
point GeoPoint3

Returns

bool

IsPointOn(GeoPolyline3, GeoPoint3, Tolerance)

Checks whether a point lies on a polyline, within a tolerance.

public static bool IsPointOn(GeoPolyline3 polyline, GeoPoint3 point, Tolerance tolerance)

Parameters

polyline GeoPolyline3
point GeoPoint3
tolerance Tolerance

Returns

bool

Remarks

There is deliberately no Contains for a polyline. A curve has no interior, so the question would only restate this one, and a chain tracing a closed shape would invite the wrong answer. Convert it with ToPolygon when the enclosed area is what matters.

IsPointOn(GeoPolygon3, GeoPoint3)

Checks whether a point lies on the boundary of a polygon, using the default tolerance.

public static bool IsPointOn(GeoPolygon3 polygon, GeoPoint3 point)

Parameters

polygon GeoPolygon3
point GeoPoint3

Returns

bool

IsPointOn(GeoPolygon3, GeoPoint3, Tolerance)

Checks whether a point lies on the boundary of a polygon, within a tolerance.

public static bool IsPointOn(GeoPolygon3 polygon, GeoPoint3 point, Tolerance tolerance)

Parameters

polygon GeoPolygon3
point GeoPoint3
tolerance Tolerance

Returns

bool

IsPointOn(GeoCircle3, GeoPoint3)

Checks whether a point lies on the circumference of a circle, using the default tolerance.

public static bool IsPointOn(GeoCircle3 circle, GeoPoint3 point)

Parameters

circle GeoCircle3
point GeoPoint3

Returns

bool

IsPointOn(GeoCircle3, GeoPoint3, Tolerance)

Checks whether a point lies on the circumference of a circle, within a tolerance.

public static bool IsPointOn(GeoCircle3 circle, GeoPoint3 point, Tolerance tolerance)

Parameters

circle GeoCircle3
point GeoPoint3
tolerance Tolerance

Returns

bool