Header menu logo Rhino.Scripting.Fsharp

RhPoints Module

This module provides curried functions to manipulate Rhino Point3d It is NOT automatically opened.

Functions and values

Function or value Description

RhPoints.closestPoint pt pts

Full Usage: RhPoints.closestPoint pt pts

Parameters:
Returns: Point3d

Returns the closest point from a point list to a given point.

pt : Point3d
pts : ResizeArray<Point3d>
Returns: Point3d

RhPoints.closestPointIdx pt pts

Full Usage: RhPoints.closestPointIdx pt pts

Parameters:
Returns: int

Returns the closest point index from a point list to a given point.

pt : Point3d
pts : ResizeArray<Point3d>
Returns: int

RhPoints.closestPointsIdx xs ys

Full Usage: RhPoints.closestPointsIdx xs ys

Parameters:
Returns: int * int

Returns the indices of the points that are closest to each other.

xs : ResizeArray<Point3d>
ys : ResizeArray<Point3d>
Returns: int * int

RhPoints.cullDuplicatePointsInSeq tolerance pts

Full Usage: RhPoints.cullDuplicatePointsInSeq tolerance pts

Parameters:
    tolerance : float
    pts : ResizeArray<Point3d>

Returns: ResizeArray<Point3d>

Culls points if they are too close to the previous point. First and last points are always kept.

tolerance : float
pts : ResizeArray<Point3d>
Returns: ResizeArray<Point3d>

RhPoints.findContinuousPoints tolGap ptss

Full Usage: RhPoints.findContinuousPoints tolGap ptss

Parameters:
    tolGap : float
    ptss : ResizeArray<ResizeArray<Point3d>>

Returns: ResizeArray<Point3d>

Similar to Join Polylines, this tries to find continuous sequences of points. 'tolGap' is the maximum allowable gap between the start and the endpoint of two point lists. Search starts from the point list with the most points. Both start and end point of each point list is checked for adjacency.

tolGap : float
ptss : ResizeArray<ResizeArray<Point3d>>
Returns: ResizeArray<Point3d>

RhPoints.minDistBetweenPointSets xs ys

Full Usage: RhPoints.minDistBetweenPointSets xs ys

Parameters:
Returns: float

Returns the smallest distance between two point sets.

xs : ResizeArray<Point3d>
ys : ResizeArray<Point3d>
Returns: float

RhPoints.mostDistantPoint findPointFrom checkAgainst

Full Usage: RhPoints.mostDistantPoint findPointFrom checkAgainst

Parameters:
    findPointFrom : ResizeArray<Point3d>
    checkAgainst : ResizeArray<Point3d>

Returns: Point3d

Finds the point that has the biggest distance to any point from another set.

findPointFrom : ResizeArray<Point3d>
checkAgainst : ResizeArray<Point3d>
Returns: Point3d

RhPoints.mostDistantPointIdx findPointFrom checkAgainst

Full Usage: RhPoints.mostDistantPointIdx findPointFrom checkAgainst

Parameters:
    findPointFrom : ResizeArray<Point3d>
    checkAgainst : ResizeArray<Point3d>

Returns: int * int

Finds the index of the point that has the biggest distance to any point from the other set. Basically the most lonely point in 'findPointFrom' list with respect to 'checkAgainst' list. Returns (findPointFromIdx, checkAgainstIdx).

findPointFrom : ResizeArray<Point3d>
checkAgainst : ResizeArray<Point3d>
Returns: int * int

Type something to start searching.