1
0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-08-14 02:34:12 +02:00

added doc

This commit is contained in:
Justin Lin
2017-03-14 18:10:34 +08:00
parent 74125710c1
commit 867ce201c1
4 changed files with 28 additions and 0 deletions

BIN
docs/images/lib-arc-1.JPG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

BIN
docs/images/lib-arc-2.JPG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

BIN
docs/images/lib-arc-3.JPG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

28
docs/lib-arc.md Normal file
View File

@@ -0,0 +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.
## 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.
## Examples
arc(radius = 20, angles = [45, 290], width = 2);
%circle(r = 20, $fn = 24);
![arc](images/lib-arc-1.JPG)
arc(radius = 20, angles = [45, 290], width = 2);
%circle(r = 20, $fn = 24);
![arc](images/lib-arc-2.JPG)
arc(radius = 20, angles = [45, 290], width = 2, width_mode = LINE_OUTWARD);
%circle(r = 20, $fn = 24);
![arc](images/lib-arc-3.JPG)