Method GetParameterAtPoint

Namespace

GeometryHelper.Core

Assembly

GeometryHelper.dll

GetParameterAtPoint(GeoLine2, GeoPoint2)

Projects a point onto the infinite line containing the segment and gets the parameter value t using default tolerance. t=0 corresponds to StartPoint, t=1 corresponds to EndPoint.

public static double GetParameterAtPoint(GeoLine2 line, GeoPoint2 point)

Parameters

line GeoLine2

The line segment.

point GeoPoint2

The target point.

Returns

double

The parameter value t along the line.

GetParameterAtPoint(GeoLine2, GeoPoint2, Tolerance)

Projects a point onto the infinite line containing the segment and gets the parameter value t within tolerance. t=0 corresponds to StartPoint, t=1 corresponds to EndPoint.

public static double GetParameterAtPoint(GeoLine2 line, GeoPoint2 point, Tolerance tolerance)

Parameters

line GeoLine2

The line segment.

point GeoPoint2

The target point.

tolerance Tolerance

The tolerance used to detect a degenerate segment.

Returns

double

The parameter value t along the line, or 0 for a degenerate segment.

GetParameterAtPoint(GeoCircle2, GeoPoint2)

Gets the normalized parameter of the point on a circle closest to the supplied point. The point does not have to lie on the circumference; only its direction from the centre matters.

public static double GetParameterAtPoint(GeoCircle2 circle, GeoPoint2 point)

Parameters

circle GeoCircle2

point GeoPoint2

Returns

double

GetParameterAtPoint(GeoRectangle2, GeoPoint2)

Gets the normalized parameter of the point on the boundary of a rectangle closest to the supplied point.

public static double GetParameterAtPoint(GeoRectangle2 rect, GeoPoint2 point)

Parameters

rect GeoRectangle2

point GeoPoint2

Returns

double

GetParameterAtPoint(GeoPolygon2, GeoPoint2)

Gets the normalized parameter of the point on the boundary of a polygon closest to the supplied point.

public static double GetParameterAtPoint(GeoPolygon2 poly, GeoPoint2 point)

Parameters

poly GeoPolygon2

point GeoPoint2

Returns

double

GetParameterAtPoint(GeoPolyline2, GeoPoint2)

Gets the normalized parameter of the point on a polyline closest to the supplied point.

public static double GetParameterAtPoint(GeoPolyline2 polyline, GeoPoint2 point)

Parameters

polyline GeoPolyline2

point GeoPoint2

Returns

double

GetParameterAtPoint(GeoPolylineArc2, GeoPoint2)

Gets the normalized parameter of the point of a chain that may curve nearest a point.

public static double GetParameterAtPoint(GeoPolylineArc2 chain, GeoPoint2 point)

Parameters

chain GeoPolylineArc2

point GeoPoint2

Returns

double

Exceptions

ArgumentNullException

Thrown when the chain is null.

GetParameterAtPoint(GeoPolylineArc2, GeoPoint2, Tolerance)

Gets the normalized parameter of the point of a chain that may curve nearest a point, within a tolerance.

public static double GetParameterAtPoint(GeoPolylineArc2 chain, GeoPoint2 point, Tolerance tolerance)

Parameters

chain GeoPolylineArc2

point GeoPoint2

tolerance Tolerance

Returns

double

Exceptions

ArgumentNullException

Thrown when the chain is null.

GetParameterAtPoint(GeoPolygonArc2, GeoPoint2)

Gets the normalized parameter of the point of a loop that may curve nearest a point.

public static double GetParameterAtPoint(GeoPolygonArc2 loop, GeoPoint2 point)

Parameters

loop GeoPolygonArc2

point GeoPoint2

Returns

double

Exceptions

ArgumentNullException

Thrown when the loop is null.

GetParameterAtPoint(GeoPolygonArc2, GeoPoint2, Tolerance)

Gets the normalized parameter of the point of a loop that may curve nearest a point, within a tolerance.

public static double GetParameterAtPoint(GeoPolygonArc2 loop, GeoPoint2 point, Tolerance tolerance)

Parameters

loop GeoPolygonArc2

point GeoPoint2

tolerance Tolerance

Returns

double

Exceptions

ArgumentNullException

Thrown when the loop is null.