diff --git a/README.md b/README.md index b4729de6..3fb692de 100644 --- a/README.md +++ b/README.md @@ -249,7 +249,7 @@ These examples incubate dotSCAD and dotSCAD refactors these examples. See [examp - [mz_square_cells](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_cells.html) - [mz_square_get](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_get.html) -- mz_square_walls +- [mz_square_walls](https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_walls.html) - mz_hex_walls - mz_square_initialize - mz_hamiltonian diff --git a/docs/images/lib2x-mz_square_walls-1.JPG b/docs/images/lib2x-mz_square_walls-1.JPG new file mode 100644 index 00000000..9e69d133 Binary files /dev/null and b/docs/images/lib2x-mz_square_walls-1.JPG differ diff --git a/docs/lib2x-mz_square_walls.md b/docs/lib2x-mz_square_walls.md new file mode 100644 index 00000000..2e636e58 --- /dev/null +++ b/docs/lib2x-mz_square_walls.md @@ -0,0 +1,34 @@ +# mz_square_walls + +It's a helper for creating wall data from maze cells. You can transform wall points for creating different types of mazes. + +**Since:** 2.5 + +## Parameters + +- `cells` : Maze cells. +- `rows` : The rows of the maze. +- `columns` : The columns of the maze. +- `cell_width` : The width of a cell. +- `left_border` : Default to `true`. Create the leftmost border of the maze. +- `bottom_border` : Default to `true`. Create the bottommost border of the maze. + +## Examples + + use ; + use ; + use ; + + rows = 10; + columns = 10; + cell_width = 5; + wall_thickness = 2; + + cells = mz_square_cells(rows, columns); + walls = mz_square_walls(cells, rows, columns, cell_width); + + for(wall = walls) { + polyline2d(wall, wall_thickness, joinStyle = "JOIN_MITER"); + } + +![mz_square_walls](images/lib2x-mz_square_walls-1.JPG) \ No newline at end of file diff --git a/src/maze/mz_square_walls.scad b/src/maze/mz_square_walls.scad index 06b5d6a8..7643ad1c 100644 --- a/src/maze/mz_square_walls.scad +++ b/src/maze/mz_square_walls.scad @@ -1,3 +1,13 @@ +/** +* mz_square_walls.scad +* +* @copyright Justin Lin, 2020 +* @license https://opensource.org/licenses/lgpl-3.0.html +* +* @see https://openhome.cc/eGossip/OpenSCAD/lib2x-mz_square_walls.html +* +**/ + use <../util/dedup.scad>; use <_impl/_mz_square_walls_impl.scad>;