CurveClosestPoints Method (IEnumerableGeometryBase, Point3d, Point3d, Int32, Double)

Finds the object (and the closest point in that object) that is closest to this curve.

Breps, surfaces, curves and point clouds are examples of objects that can be passed to this function.

Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll)

Since: 5.0

Syntax

public bool ClosestPoints(
	IEnumerable<GeometryBase> geometry,
	out Point3d pointOnCurve,
	out Point3d pointOnObject,
	out int whichGeometry,
	double maximumDistance
)

Public Function ClosestPoints ( 
	geometry As IEnumerable(Of GeometryBase),
	<OutAttribute> ByRef pointOnCurve As Point3d,
	<OutAttribute> ByRef pointOnObject As Point3d,
	<OutAttribute> ByRef whichGeometry As Integer,
	maximumDistance As Double
) As Boolean

Parameters

geometry: Type: System.Collections.GenericIEnumerableGeometryBase
A list, an array or any enumerable set of geometry to search.
pointOnCurve: Type: Rhino.GeometryPoint3d
The point on curve. This out parameter is assigned during this call.
pointOnObject: Type: Rhino.GeometryPoint3d
The point on geometry. This out parameter is assigned during this call.
whichGeometry: Type: SystemInt32
The index of the geometry. This out parameter is assigned during this call.
maximumDistance: Type: SystemDouble
Maximum allowable distance. Past this distance, the research is given up and false is returned.

Return Value

Type: Boolean
true on success; false if no object was found or selected.

Exceptions

Exception	Condition
ArgumentNullException	If geometry is null.

Reference

Curve Class

ClosestPoints Overload

Rhino.Geometry Namespace