Skip to content

Commit 9ba6f9a

Browse files
committed
updating docs
1 parent 28cbdb4 commit 9ba6f9a

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

coords.scad

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -142,24 +142,24 @@ function xy_to_polar(x,y=undef) = let(
142142

143143

144144
// Function: project_plane()
145-
// Usage: With 3 Points
145+
// Usage: With the plane defined by 3 Points
146146
// xyz = project_plane(point, a, b, c);
147-
// Usage: With Pointlist
147+
// Usage: With the plane defined by Pointlist
148148
// xyz = project_plane(point, POINTLIST);
149-
// Usage: With Plane Definition [A,B,C,D] Where Ax+By+Cz=D
149+
// Usage: With the plane defined by Plane Definition [A,B,C,D] Where Ax+By+Cz=D
150150
// xyz = project_plane(point, PLANE);
151151
// Description:
152-
// Converts the given 3D point from global coordinates to the 2D planar coordinates of the closest
153-
// point on the plane. This coordinate system can be useful in taking a set of nearly coplanar
152+
// Converts the given 3D points from global coordinates to the 2D planar coordinates of the closest
153+
// points on the plane. This coordinate system can be useful in taking a set of nearly coplanar
154154
// points, and converting them to a pure XY set of coordinates for manipulation, before converting
155-
// them back to the original 3D plane.
156-
// Can be called one of three ways:
157-
// - Given three points, `a`, `b`, and `c`, the planar coordinate system will have `[0,0]` at point `a`, and the Y+ axis will be towards point `b`.
158-
// - Given a list of points, finds three reasonably spaced non-collinear points in the list and uses them as points `a`, `b`, and `c` as above.
159-
// - Given a plane definition `[A,B,C,D]` where `Ax+By+Cz=D`, the closest point on that plane to the global origin at `[0,0,0]` will be the planar coordinate origin `[0,0]`.
155+
// them back to the original 3D plane. The parameter `point` may be a single point or a list of points
156+
// The plane may be given in one of three ways:
157+
// - by three points, `a`, `b`, and `c`, the planar coordinate system will have `[0,0]` at point `a`, and the Y+ axis will be towards point `b`.
158+
// - by a list of points passed by `a`, finds three reasonably spaced non-collinear points in the list and uses them as points `a`, `b`, and `c` as above.
159+
// - by a plane definition `[A,B,C,D]` passed by `a` where `Ax+By+Cz=D`, the closest point on that plane to the global origin at `[0,0,0]` will be the planar coordinate origin `[0,0]`.
160160
// Arguments:
161161
// point = The 3D point, or list of 3D points to project into the plane's 2D coordinate system.
162-
// a = A 3D point that the plane passes through. Used to define the plane.
162+
// a = A 3D point that the plane passes through or a list of points or a plane definition vector.
163163
// b = A 3D point that the plane passes through. Used to define the plane.
164164
// c = A 3D point that the plane passes through. Used to define the plane.
165165
// Example:

0 commit comments

Comments
 (0)