This is the documentation of the first stable release of COMPAS 2. If you have feedback, please give it here: COMPAS issue tracker.

ToroidalSurface.closest_point

ToroidalSurface.closest_point(point, return_parameters=False)[source]

Compute the closest point on the curve to a given point.

Parameters:

pointPoint: The point to project to the surface.
return_parametersbool, optional: If True, return the surface UV parameters in addition to the closest point.

Returns:

compas.geometry.Point | tuple[compas.geometry.Point, tuple[float, float]]: If return_parameters is False, the nearest point on the surface. If return_parameters is True, the UV parameters in addition to the nearest point on the surface.