From d80cb310eb1cec30b77ee125e80bdbdbe91f3806 Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Thu, 23 Mar 2017 10:09:08 +0800 Subject: [PATCH] updated doc --- docs/lib-hull_polyline3d.md | 10 ++++++---- src/hull_polyline3d.scad | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/lib-hull_polyline3d.md b/docs/lib-hull_polyline3d.md index c51617c4..55da1104 100644 --- a/docs/lib-hull_polyline3d.md +++ b/docs/lib-hull_polyline3d.md @@ -1,12 +1,14 @@ # hull_polyline3d -Creates a 3D polyline from a list of `[x, y, z]` coordinates. As the name says, it uses the built-in hull operation for each pair of points. It's slow. However, it can be used to create metallic effects when the `fn` parameter is small. +Creates a 3D polyline from a list of `[x, y, z]` coordinates. As the name says, it uses the built-in hull operation for each pair of points (created by the `sphere` module). It's slow. However, it can be used to create metallic effects for a small `$fn`, large `$fa` or `$fs`. ## Parameters - `points` : The list of `[x, y, z]` points of the polyline. : A vector of 3 element vectors. The points are indexed from 0 to n-1. - `thickness` : The line thickness. -- `fn` : It controlls the `$fn` value used by the `sphere` module. The default value is `3`. +- `$fa` : Fragment angle in degrees. +- `$fs` : Fragment size in mm. +- `$fn` : Resolution. ## Examples @@ -18,7 +20,7 @@ Creates a 3D polyline from a list of `[x, y, z]` coordinates. As the name says, [0, 0, 0] ], thickness = 1, - fn = 3 + $fn = 3 ); ![polyline3d](images/lib-hull_polyline3d-1.JPG) @@ -35,7 +37,7 @@ Creates a 3D polyline from a list of `[x, y, z]` coordinates. As the name says, for(i = [0:7]) { rotate(45 * i) - hull_polyline3d(points, 2, 3); + hull_polyline3d(points, 2, $fn = 3); } ![polyline3d](images/lib-hull_polyline3d-2.JPG) diff --git a/src/hull_polyline3d.scad b/src/hull_polyline3d.scad index 5cb0a017..9745b0ab 100644 --- a/src/hull_polyline3d.scad +++ b/src/hull_polyline3d.scad @@ -2,7 +2,7 @@ * hull_polyline3d.scad * * Creates a 3D polyline from a list of `[x, y, z]` coordinates. -* As the name says, it uses the built-in hull operation for each pair of points. +* As the name says, it uses the built-in hull operation for each pair of points (created by the sphere module). * It's slow. However, it can be used to create metallic effects for a small $fn, large $fa or $fs. * * @copyright Justin Lin, 2017