From 02ddec88c07fb4c19fb29774a3b0d6ff59090b8e Mon Sep 17 00:00:00 2001 From: Justin Lin Date: Sun, 7 May 2017 20:13:13 +0800 Subject: [PATCH] renamed --- README.md | 6 +++--- .../{lib-circle_path-1.JPG => lib-pie-1.JPG} | Bin docs/lib-circular_sector.md | 20 ------------------ docs/lib-pie.md | 20 ++++++++++++++++++ src/{circular_sector.scad => pie.scad} | 8 +++---- 5 files changed, 27 insertions(+), 27 deletions(-) rename docs/images/{lib-circle_path-1.JPG => lib-pie-1.JPG} (100%) delete mode 100644 docs/lib-circular_sector.md create mode 100644 docs/lib-pie.md rename src/{circular_sector.scad => pie.scad} (73%) diff --git a/README.md b/README.md index 9a50d0bd..f26a068c 100644 --- a/README.md +++ b/README.md @@ -28,13 +28,13 @@ Too many dependencies? Because OpenSCAD doesn't provide namespace management, I ## Documentation - 2D - - [ellipse](https://openhome.cc/eGossip/OpenSCAD/lib-ellipse.html) + - [pie](https://openhome.cc/eGossip/OpenSCAD/lib-pie.html) + - [arc](https://openhome.cc/eGossip/OpenSCAD/lib-arc.html) + - [ellipse](https://openhome.cc/eGossip/OpenSCAD/lib-ellipse.html) - [rounded_square](https://openhome.cc/eGossip/OpenSCAD/lib-rounded_square.html) - [line2d](https://openhome.cc/eGossip/OpenSCAD/lib-line2d.html) - [polyline2d](https://openhome.cc/eGossip/OpenSCAD/lib-polyline2d.html) - [hull_polyline2d](https://openhome.cc/eGossip/OpenSCAD/lib-hull_polyline2d.html) - - [circular_sector](https://openhome.cc/eGossip/OpenSCAD/lib-circular_sector.html) - - [arc](https://openhome.cc/eGossip/OpenSCAD/lib-arc.html) - [hexagons](https://openhome.cc/eGossip/OpenSCAD/lib-hexagons.html) - [polytransversals](https://openhome.cc/eGossip/OpenSCAD/lib-polytransversals.html) - [path_extend](https://openhome.cc/eGossip/OpenSCAD/lib-path_extend.html) diff --git a/docs/images/lib-circle_path-1.JPG b/docs/images/lib-pie-1.JPG similarity index 100% rename from docs/images/lib-circle_path-1.JPG rename to docs/images/lib-pie-1.JPG diff --git a/docs/lib-circular_sector.md b/docs/lib-circular_sector.md deleted file mode 100644 index fd1a3059..00000000 --- a/docs/lib-circular_sector.md +++ /dev/null @@ -1,20 +0,0 @@ -# circular_sector - -Creates a circular sector. You can pass a 2 element vector to define the central angle. Its `$fa`, `$fs` and `$fn` parameters are consistent with the `circle` module. - -## 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. -- `$fa`, `$fs`, `$fn` : Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details. - -## Examples - - include ; - - circular_sector(radius = 20, angles = [210, 310]); - translate([-15, 0, 0]) circular_sector(radius = 20, angles = [45, 135]); - translate([15, 0, 0]) circular_sector(radius = 20, angles = [45, 135], $fn = 12); - -![circular_sector](images/lib-circular_sector-1.JPG) - diff --git a/docs/lib-pie.md b/docs/lib-pie.md new file mode 100644 index 00000000..a1c854c8 --- /dev/null +++ b/docs/lib-pie.md @@ -0,0 +1,20 @@ +# pie + +Creates a pie (circular sector). You can pass a 2 element vector to define the central angle. Its `$fa`, `$fs` and `$fn` parameters are consistent with the `circle` module. + +## 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. +- `$fa`, `$fs`, `$fn` : Check [the circle module](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#circle) for more details. + +## Examples + + include ; + + pie(radius = 20, angles = [210, 310]); + translate([-15, 0, 0]) pie(radius = 20, angles = [45, 135]); + translate([15, 0, 0]) pie(radius = 20, angles = [45, 135], $fn = 12); + +![pie](images/lib-pie-1.JPG) + diff --git a/src/circular_sector.scad b/src/pie.scad similarity index 73% rename from src/circular_sector.scad rename to src/pie.scad index bb6c7672..06940593 100644 --- a/src/circular_sector.scad +++ b/src/pie.scad @@ -1,18 +1,18 @@ /** -* circular_sector.scad +* pie.scad * -* Creates a circular sector. You can pass a 2 element vector to define the central angle. Its $fa, $fs and $fn parameters are consistent with the circle module. +* Creates a pie (circular sector). You can pass a 2 element vector to define the central angle. Its $fa, $fs and $fn parameters are consistent with the circle module. * * @copyright Justin Lin, 2017 * @license https://opensource.org/licenses/lgpl-3.0.html * -* @see https://openhome.cc/eGossip/OpenSCAD/lib-circular_sector.html +* @see https://openhome.cc/eGossip/OpenSCAD/lib-pie.html * **/ include <__private__/__frags.scad>; -module circular_sector(radius, angles) { +module pie(radius, angles) { frags = __frags(radius); a_step = 360 / frags;