Method GetDistanceAtPoint

Namespace

GeometryHelper.Core

Assembly

GeometryHelper.dll

GetDistanceAtPoint(GeoLine3, GeoPoint3)

Gets the arc length from the start of a line segment to the point on it closest to the supplied point.

public static double GetDistanceAtPoint(GeoLine3 line, GeoPoint3 point)

Parameters

line GeoLine3

point GeoPoint3

Returns

double

GetDistanceAtPoint(GeoRay3, GeoPoint3)

Gets the arc length from the origin of a ray to the point on its carrier line closest to the supplied point. The result is negative when that point falls behind the origin.

public static double GetDistanceAtPoint(GeoRay3 ray, GeoPoint3 point)

Parameters

ray GeoRay3

point GeoPoint3

Returns

double

GetDistanceAtPoint(GeoPolyline3, GeoPoint3)

Gets the arc length from the start of a polyline to the point on it closest to the supplied point.

public static double GetDistanceAtPoint(GeoPolyline3 polyline, GeoPoint3 point)

Parameters

polyline GeoPolyline3

point GeoPoint3

Returns

double

GetDistanceAtPoint(GeoPolyline3, GeoPoint3, Tolerance)

Gets the arc length from the start of a polyline to the point on it closest to the supplied point, within a tolerance.

public static double GetDistanceAtPoint(GeoPolyline3 polyline, GeoPoint3 point, Tolerance tolerance)

Parameters

polyline GeoPolyline3

point GeoPoint3

tolerance Tolerance

Returns

double

Remarks

A polyline can pass near the same point more than once, so the closest edge is found first and the arc length is measured to that. Walking the chain and stopping at the first edge within tolerance would give a different answer depending on which end the chain was built from.

GetDistanceAtPoint(GeoPolygon3, GeoPoint3)

Gets the arc length from the first vertex of a polygon to the point on its boundary closest to the supplied point.

public static double GetDistanceAtPoint(GeoPolygon3 polygon, GeoPoint3 point)

Parameters

polygon GeoPolygon3

point GeoPoint3

Returns

double

GetDistanceAtPoint(GeoPolygon3, GeoPoint3, Tolerance)

Gets the arc length from the first vertex of a polygon to the point on its boundary closest to the supplied point, within a tolerance.

public static double GetDistanceAtPoint(GeoPolygon3 polygon, GeoPoint3 point, Tolerance tolerance)

Parameters

polygon GeoPolygon3

point GeoPoint3

tolerance Tolerance

Returns

double

Remarks

This measures around the boundary, not across the interior: a point in the middle of a polygon still reports the position of the nearest place on its outline.

GetDistanceAtPoint(GeoCircle3, GeoPoint3)

Gets the arc length from the zero parameter of a circle to the point on its circumference closest to the supplied point.

public static double GetDistanceAtPoint(GeoCircle3 circle, GeoPoint3 point)

Parameters

circle GeoCircle3

point GeoPoint3

Returns

double

GetDistanceAtPoint(GeoCircle3, GeoPoint3, Tolerance)

Gets the arc length from the zero parameter of a circle to the point on its circumference closest to the supplied point, within a tolerance.

public static double GetDistanceAtPoint(GeoCircle3 circle, GeoPoint3 point, Tolerance tolerance)

Parameters

circle GeoCircle3

point GeoPoint3

tolerance Tolerance

Returns

double