14 KiB
dotSCAD 3.0 Dev
Reduce the burden of mathematics/algorithm when playing OpenSCAD.
Introduction
This library requires OpenSCAD 2021.01 or later.
Some of my 3D models require complex mathematics/algorithm. I extract them into dotSCAD. Hope it helps when you're playing OpenSCAD.
The idea of the name dotSCAD comes from the filename extension ".scad" of OpenSCAD.
Get Started
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.
I set OPENSCADPATH
to the src
folder of dotSCAD so all examples here start searching modules or functions from src
.
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 <voxel/vx_circle.scad>;
points = vx_circle(radius = 10);
for(pt = points) {
translate(pt) square(1);
}
Examples
These examples incubate dotSCAD and dotSCAD refactors these examples. See examples.
Documentation
2D Module
3D Module
- rounded_cube
- rounded_cylinder
- crystal_ball
- line3d
- polyline3d
- hull_polyline3d
- function_grapher
- sweep
- loft
- starburst
- polyhedron_hull
Transformation
2D Function
2D/3D Function
- cross_sections
- paths2sections
- path_scaling_sections
- bezier_surface
- bezier_smooth
- midpt_smooth
- in_polyline
Path
- arc_path
- bspline_curve
- bezier_curve
- helix
- golden_spiral
- archimedean_spiral
- sphere_spiral
- torus_knot
- curve
- bauer_spiral
- fibonacci_lattice
Extrusion
2D Shape
- shape_taiwan
- shape_arc
- shape_pie
- shape_circle
- shape_ellipse
- shape_square
- shape_trapezium
- shape_cyclicpolygon
- shape_pentagram
- shape_starburst
- shape_superformula
- shape_path_extend
- shape_liquid_splitting
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
- util/has
- util/dedup
- util/flat
- util/sum
- util/zip
- util/lerp
- util/choose
Matrix
- matrix/m_cumulate
- matrix/m_translation
- matrix/m_rotation
- matrix/m_scaling
- matrix/m_mirror
- matrix/m_shearing
- matrix/m_determinant
Point Transformation
- 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
- turtle/turtle2d
- turtle/turtle3d
- turtle/t2d
- turtle/t3d
- turtle/footprints2
- turtle/footprints3
- turtle/lsystem2
- turtle/lsystem3
Voxel
- voxel/vx_line
- voxel/vx_polyline
- voxel/vx_circle
- voxel/vx_cylinder
- voxel/vx_sphere
- voxel/vx_polygon
- voxel/vx_from
- voxel/vx_ascii
- voxel/vx_gray
- voxel/vx_union
- voxel/vx_intersection
- voxel/vx_difference
- voxel/vx_bezier
- voxel/vx_curve
- voxel/vx_contour
Part
Surface
- surface/sf_square
- surface/sf_bend
- surface/sf_ring
- surface/sf_sphere
- surface/sf_torus
- surface/sf_solidify
Noise
- noise/nz_perlin1
- noise/nz_perlin1s
- noise/nz_perlin2
- noise/nz_perlin2s
- noise/nz_perlin3
- noise/nz_perlin3s
- noise/nz_worley2
- noise/nz_worley2s
- noise/nz_worley3
- noise/nz_worley3s
- noise/nz_cell
Voronoi
- voronoi/vrn2_from
- voronoi/vrn2_space
- voronoi/vrn2_cells_from
- voronoi/vrn2_cells_space
- voronoi/vrn3_from
- voronoi/vrn3_space