is_point_on_polyline_xy

compas.geometry.is_point_on_polyline_xy(point, polyline, tol=None)

Determine if a point is on a polyline on the XY-plane.

Parameters:

point[float, float, float] | compas.geometry.Point

XY(Z) coordinates.

polylinesequence[point] | compas.geometry.Polyline

XY(Z) coordinates of the points of the polyline.

tolfloat, optional

The tolerance for comparing the distance between point and polyline to zero. Default is TOL.absolute.

Returns:

bool

True if the point is on the polyline. False otherwise.

See also

is_point_on_line_xy

is_point_on_segment_xy