mirror of
https://github.com/JustinSDK/dotSCAD.git
synced 2025-08-10 16:54:23 +02:00
add doc
This commit is contained in:
@@ -377,7 +377,7 @@ These examples incubate dotSCAD and dotSCAD refactors these examples. See [examp
|
||||
|
||||
Signature | Description
|
||||
--|--
|
||||
polyhedra/star | create a 3D star.
|
||||
[**polyhedra/star**([outerRadius, innerRadius, height, n])](https://openhome.cc/eGossip/OpenSCAD/lib3x-polyhedra_star.html) | create a 3D star.
|
||||
[**polyhedra/tetrahedron**(radius[, detail])](https://openhome.cc/eGossip/OpenSCAD/lib3x-polyhedra_tetrahedron.html) | create a tetrahedron.
|
||||
[**polyhedra/hexahedron**(radius[, detail])](https://openhome.cc/eGossip/OpenSCAD/lib3x-polyhedra_hexahedron.html) | create a hexahedron.
|
||||
[**polyhedra/octahedron**(radius[, detail])](https://openhome.cc/eGossip/OpenSCAD/lib3x-polyhedra_octahedron.html) | create a octahedron.
|
||||
|
BIN
docs/images/lib3x-polyhedra_star-1.JPG
Normal file
BIN
docs/images/lib3x-polyhedra_star-1.JPG
Normal file
Binary file not shown.
After Width: | Height: | Size: 27 KiB |
24
docs/lib3x-polyhedra_star.md
Normal file
24
docs/lib3x-polyhedra_star.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# star
|
||||
|
||||
Create a star. Default to a pentagram.
|
||||
|
||||
**Since:** 3.2
|
||||
|
||||
## Parameters
|
||||
|
||||
- `outer_radius`: The outer radius of the star. Default to 1.
|
||||
- `inner_radius`: The inner radius of the star. Default to 0.381966.
|
||||
- `height`: The star height. Default to 0.5.
|
||||
- `n`: The burst number. Default to 5.
|
||||
|
||||
## Examples
|
||||
|
||||
use <polyhedra/star.scad>;
|
||||
|
||||
for(i = [3:6]) {
|
||||
translate([(i - 3) * 2, 0])
|
||||
star(n = i);
|
||||
}
|
||||
|
||||

|
||||
|
@@ -1,3 +1,13 @@
|
||||
/**
|
||||
* star.scad
|
||||
*
|
||||
* @copyright Justin Lin, 2021
|
||||
* @license https://opensource.org/licenses/lgpl-3.0.html
|
||||
*
|
||||
* @see https://openhome.cc/eGossip/OpenSCAD/lib3x-polyhedra_star.html
|
||||
*
|
||||
**/
|
||||
|
||||
use <geom_star.scad>;
|
||||
|
||||
module star(outerRadius = 1, innerRadius = 0.381966, height = 0.5, n = 5) {
|
||||
|
Reference in New Issue
Block a user