12 KiB
dotSCAD 2.2.1
Reduce the burden of mathematics when playing OpenSCAD.
Introduction
Based on OpenSCAD 2019.05. For old OpenSCAD versions, please use dotSCAD 1.3. You can download all versions from the releases.
OpenSCAD uses three library locations, the installation library, built-in library, and user defined libraries. It's convenient to set OPENSCADPATH. Check Setting OPENSCADPATH in OpenSCAD User Manual/Libraries for details.
Every module or function is located in the file which has the same name as the module or the function. For example, if you want to use the line2d module to draw a line, use <line2d.scad>; first.
use <line2d.scad>;
line2d(p1 = [0, 0], p2 = [5, 0], width = 1);
Some module files are organized in a directory. For example, px_circle.scad exists in pixel directory. You have to prefix the directory name when including px_circle.
use <pixel/px_circle.scad>;
points = px_circle(radius = 10);
for(pt = points) {
translate(pt) square(1);
}
Examples
See examples.
Documentation
2D Module
- arc
- pie
- rounded_square
- line2d
- polyline2d
- hull_polyline2d
- hexagons
- polytransversals
- multi_line_text
- voronoi2d
3D Module
- rounded_cube
- rounded_cylinder
- crystal_ball
- line3d
- polyline3d
- hull_polyline3d
- function_grapher
- polysections (It'll be deprecated from 2.3. Use
sweepinstead.) - sweep (2.3 Preview)
- loft (2.3 Preview)
- starburst
- voronoi3d
Transformation
2D Function
2D/3D Function
- rotate_p (It'll be deprecated from 2.3. Use
ptf/ptf_rotateinstead.) - cross_sections
- paths2sections
- path_scaling_sections
- bezier_surface
- bezier_smooth
- midpt_smooth
- in_polyline
- contours (2.3 Preview)
Path
- arc_path
- circle_path (It'll be deprecated from 2.3. Use
shape_circleinstead.) - bspline_curve
- bezier_curve
- helix
- golden_spiral
- archimedean_spiral
- sphere_spiral
- torus_knot
Extrusion
2D Shape
- shape_taiwan
- shape_arc
- shape_pie
- shape_circle (2.3 Preview)
- shape_ellipse
- shape_square
- shape_trapezium
- shape_cyclicpolygon
- shape_pentagram
- shape_starburst
- shape_superformula
- shape_glued2circles
- shape_path_extend
2D Shape Extrusion
- path_extrude
- ring_extrude
- helix_extrude
- golden_spiral_extrude
- archimedean_spiral_extrude
- sphere_spiral_extrude
Util
- util/sub_str
- util/split_str
- util/parse_number
- util/reverse
- util/slice
- util/sort
- util/rand
- util/fibseq
- util/bsearch (2.3 Preview)
- util/has (2.3 Preview)
- util/dedup (2.3 Preview)
- util/flat (2.3 Preview)
Matrix
- matrix/m_cumulate
- matrix/m_translation
- matrix/m_rotation
- matrix/m_scaling
- matrix/m_mirror
- matrix/m_shearing
Point Transformation (2.3 Preview)
- ptf/ptf_rotate
- ptf/ptf_x_twist
- ptf/ptf_y_twist
- ptf/ptf_circle
- ptf/ptf_bend
- ptf/ptf_ring
- ptf/ptf_sphere
- ptf/ptf_torus
Turtle
Pixel
- pixel/px_line
- pixel/px_polyline
- pixel/px_circle
- pixel/px_cylinder
- pixel/px_sphere
- pixel/px_polygon
- pixel/px_from
- pixel/px_ascii
- pixel/px_gray
Part
Surface (2.3 Preview)
- surface/sf_square
- surface/sf_bend
- surface/sf_ring
- surface/sf_sphere
- surface/sf_torus
- surface/sf_solidify
Noise (2.3 Preview)
- noise/nz_perlin1
- noise/nz_perlin1s
- noise/nz_perlin2
- noise/nz_perlin2s
- noise/nz_perlin3
- noise/nz_perlin3s
- noise/nz_worley1
- noise/nz_worley1s
- noise/nz_worley2
- noise/nz_worley2s
- noise/nz_cell
Bugs and Feedback
For bugs, questions and discussions please use the Github Issues.
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. Some examples developed in the documentation are useful so I elaborate them into this library.
The idea of the name dotSCAD comes from the filename extension ".scad" of OpenSCAD.