1
0
mirror of https://github.com/JustinSDK/dotSCAD.git synced 2025-01-17 14:18:13 +01:00
dotSCAD/README.md

62 lines
2.8 KiB
Markdown
Raw Normal View History

2017-03-29 18:02:57 +08:00
# dotSCAD (Beta)
2017-03-11 17:49:46 +08:00
2017-03-27 17:34:32 +08:00
> These fundamental modules and functions are helpful when playing OpenSCAD.
2017-03-11 17:49:46 +08:00
2017-03-17 08:39:31 +08:00
[![license/LGPL](https://img.shields.io/badge/license-LGPL-blue.svg)](https://github.com/JustinSDK/lib-openscad/blob/master/LICENSE)
2017-03-15 15:30:24 +08:00
2017-03-27 17:36:32 +08:00
## Introduction
2017-03-27 17:34:32 +08:00
Every module or function is located in the file which has the same name as the module or the function. For examples, if you want to use the `line2d` module to draw a line, `include <line2d.scad>` first.
include <line2d.scad>;
2017-03-27 17:35:13 +08:00
2017-03-27 17:34:32 +08:00
line2d(p1 = [0, 0], p2 = [5, 0], width = 1);
Some modules may depend on other modules. For example, the `polyline2d` module depends on the `line2d` module, so you also have to `include <line2d.scad>` besides `include <polyline3d.scad>`.
include <line2d.scad>;
include <polyline3d.scad>;
2017-03-27 17:35:13 +08:00
2017-03-27 17:34:32 +08:00
polyline2d(points = [[1, 2], [-5, -4], [-5, 3], [5, 5]], width = 1);
2017-03-16 20:26:15 +08:00
2017-03-17 08:37:19 +08:00
## Documentation
- 2D
- [line2d](https://openhome.cc/eGossip/OpenSCAD/lib-line2d.html)
- [polyline2d](https://openhome.cc/eGossip/OpenSCAD/lib-polyline2d.html)
- [circular_sector](https://openhome.cc/eGossip/OpenSCAD/lib-circular_sector.html)
- [arc](https://openhome.cc/eGossip/OpenSCAD/lib-arc.html)
- 3D
- [line3d](https://openhome.cc/eGossip/OpenSCAD/lib-line3d.html)
2017-03-17 08:56:47 +08:00
- [polyline3d](https://openhome.cc/eGossip/OpenSCAD/lib-polyline3d.html)
2017-03-17 10:29:50 +08:00
- [hull_polyline3d](https://openhome.cc/eGossip/OpenSCAD/lib-hull_polyline3d.html)
2017-03-17 08:37:19 +08:00
2017-03-23 08:23:33 +08:00
- Transformation
2017-03-17 08:37:19 +08:00
- [hollow_out](https://openhome.cc/eGossip/OpenSCAD/lib-hollow_out.html)
2017-03-19 09:11:41 +08:00
- [bend](https://openhome.cc/eGossip/OpenSCAD/lib-bend.html)
2017-03-15 15:30:24 +08:00
2017-03-28 20:56:13 +08:00
- Functon
- [rotate_p](https://openhome.cc/eGossip/OpenSCAD/lib-rotate_p.html)
2017-03-29 11:35:41 +08:00
- [sub_str](https://openhome.cc/eGossip/OpenSCAD/lib-sub_str.html)
2017-03-29 13:20:17 +08:00
- [split_str](https://openhome.cc/eGossip/OpenSCAD/lib-split_str.html)
2017-03-29 13:50:43 +08:00
- [parse_number](https://openhome.cc/eGossip/OpenSCAD/lib-parse_number.html)
2017-03-29 11:35:41 +08:00
2017-03-23 08:23:33 +08:00
- Path
2017-03-23 11:33:38 +08:00
- [circle_path](https://openhome.cc/eGossip/OpenSCAD/lib-circle_path.html)
2017-03-22 10:47:09 +08:00
- [bezier](https://openhome.cc/eGossip/OpenSCAD/lib-bezier.html)
2017-03-26 16:51:41 +08:00
- [cylinder_spiral](https://openhome.cc/eGossip/OpenSCAD/lib-cylinder_spiral.html)
2017-03-27 15:32:36 +08:00
- [archimedean_spiral](https://openhome.cc/eGossip/OpenSCAD/lib-archimedean_spiral.html)
2017-03-29 17:51:57 +08:00
- [sphere_spiral](https://openhome.cc/eGossip/OpenSCAD/lib-sphere_spiral.html)
2017-03-26 16:51:41 +08:00
- Other
2017-03-27 17:34:32 +08:00
- [box_extrude](https://openhome.cc/eGossip/OpenSCAD/lib-box_extrude.html)
2017-03-28 09:09:37 +08:00
- [stereographic_extrude](https://openhome.cc/eGossip/OpenSCAD/lib-stereographic_extrude.html)
2017-03-27 17:34:32 +08:00
2017-03-29 11:52:52 +08:00
## Bugs and Feedback
For bugs, questions and discussions please use the [Github Issues](https://github.com/JustinSDK/dotSCAD/issues).
2017-03-27 17:34:32 +08:00
## About dotSCAD
I've been using OpenSCAD for years and created some funny things. Some of them include several important ideas and details. To prevent forgetfulness, I decided to [write them down](https://openhome.cc/eGossip/OpenSCAD/). Some examples developed in the documentation are useful so I elaborate them into this library.