From 55cece0d1c2c2f3e949d47468fc643a43d530d15 Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Thu, 23 Mar 2017 09:44:33 +0800 Subject: [PATCH] updated doc --- docs/lib-arc.md | 14 +++++++------- docs/lib-circular_sector.md | 1 - 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/lib-arc.md b/docs/lib-arc.md index bf17f5d8..4f62e4b8 100644 --- a/docs/lib-arc.md +++ b/docs/lib-arc.md @@ -1,28 +1,28 @@ # arc -Create an arc. You can pass a 2 element vector to define the central angle. It provides a `fn` parameter consistent with the `$fn` parameter of the circle module. It depends on the `circular_sector` module so you have to include circular_sector.scad. +Create an arc. You can pass a 2 element vector to define the central angle. Its `$fa`, `$fs` and `$fn` parameters are consistent with the circle module. It depends on the `circular_sector` module so you have to include circular_sector.scad. ## Parameters - `radius` : The radius of the circle. - `angles` : A 2 element vector which defines the central angle. The first element of the vector is the beginning angle in degrees, and the second element is the ending angle. -- `width_mode` : The default value is `"LINE_CROSS"`. The arc line will move outward by `width /2` and inward by `width / 2`. If it's `"LINE_OUTWARD"`, the arc line moves outward by `width`. The `"LINE_INWARD"` moves the arc line inward by `width`. -- `fn` : The `$fn` value used by the `circle` module internally. The default value is 24. +- `width_mode` : The default value is `"LINE_CROSS"`. The arc line will move outward by `width / 2` and inward by `width / 2`. If it's `"LINE_OUTWARD"`, the arc line moves outward by `width`. The `"LINE_INWARD"` moves the arc line inward by `width`. ## Examples - + + $fn = 24; arc(radius = 20, angles = [45, 290], width = 2); - %circle(r = 20, $fn = 24); + %circle(r = 20); ![arc](images/lib-arc-1.JPG) arc(radius = 20, angles = [45, 290], width = 2, width_mode = "LINE_INWARD"); - %circle(r = 20, $fn = 24); + %circle(r = 20); ![arc](images/lib-arc-2.JPG) arc(radius = 20, angles = [45, 290], width = 2, width_mode = "LINE_OUTWARD"); - %circle(r = 20, $fn = 24); + %circle(r = 20); ![arc](images/lib-arc-3.JPG) diff --git a/docs/lib-circular_sector.md b/docs/lib-circular_sector.md index b4366db3..97544029 100644 --- a/docs/lib-circular_sector.md +++ b/docs/lib-circular_sector.md @@ -6,7 +6,6 @@ Create a circular sector. You can pass a 2 element vector to define the central - `radius` : The radius of the circle. - `angles` : A 2 element vector which defines the central angle. The first element of the vector is the beginning angle in degrees, and the second element is the ending angle. -- `fn` : The `$fn` value used by the `circle` module internally. The default value is 24. ## Examples