diff --git a/README.md b/README.md index f66d306a..9307f5f0 100644 --- a/README.md +++ b/README.md @@ -241,7 +241,7 @@ See [examples](examples#dogfooding-examples). - [voronoi/vrn2_cells_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_cells_from.html) - [voronoi/vrn2_cells_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn2_cells_space.html) - [voronoi/vrn3_from](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_from.html) -- voronoi/vrn3_space +- [voronoi/vrn3_space](https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_space.html) ---- diff --git a/docs/images/lib2x-vrn3_space-1.JPG b/docs/images/lib2x-vrn3_space-1.JPG new file mode 100644 index 00000000..963df2cd Binary files /dev/null and b/docs/images/lib2x-vrn3_space-1.JPG differ diff --git a/docs/lib2x-vrn3_space.md b/docs/lib2x-vrn3_space.md new file mode 100644 index 00000000..163323d1 --- /dev/null +++ b/docs/lib2x-vrn3_space.md @@ -0,0 +1,23 @@ +# vrn3_space + +Creats a [Voronoi diagram](https://en.wikipedia.org/wiki/Voronoi_diagram) in the first octant. You specify a space and a grid width. The center of each cell will be distributed in each grid randomly. + +**Since:** 2.4 + +## Parameters + +- `size` : 3 value array [x, y, z]. +- `grid_w` : The width of each grid. +- `seed` : Seed value for random number generator for repeatable results. +- `spacing` : Distance between cells. Default to 1. + +## Examples + + use ; + + vrn3_space( + size = [20, 15, 10], + grid_w = 5 + ); + +![vrn3_space](images/lib2x-vrn3_space-1.JPG) diff --git a/src/voronoi/vrn3_space.scad b/src/voronoi/vrn3_space.scad index a935879f..e8f4e6da 100644 --- a/src/voronoi/vrn3_space.scad +++ b/src/voronoi/vrn3_space.scad @@ -1,3 +1,13 @@ +/** +* vrn3_space.scad +* +* @copyright Justin Lin, 2020 +* @license https://opensource.org/licenses/lgpl-3.0.html +* +* @see https://openhome.cc/eGossip/OpenSCAD/lib2x-vrn3_space.html +* +**/ + use <__comm__/__angy_angz.scad>; // slow but workable