openscad/dotSCAD
1
0
Fork 0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-08-19 13:01:37 +02:00
Code Issues Releases Wiki Activity

updated doc

Browse Source
This commit is contained in:
Justin Lin
2017-03-23 09:44:33 +08:00
parent 4f2d57bf8a
commit 55cece0d1c
2 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/lib-arc.md
View File

@@ -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)

1
docs/lib-circular_sector.md
View File

@@ -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