RELEASE.md

Version numbers are based on Semantic Versioning.

v3.3

Deprecated

Signature	Description
rails2sections	use maxtrix/m_transpose instead.
util/sort	use util/sorted instead.
util/has	use util/contains instead.
util/bsearch	use util/binary_search instead.
maze/mz_square_cells	use maze/mz_square.
maze/mz_square_walls	use maze/mz_squarewalls instead.
maze/mz_hex_walls	use maze/mz_hexwalls instead.
maze/mz_theta_cells	use maze/mz_theta instead.

Util

Signature	Description
util/sorted(lt[, cmp, key, reverse])	sort a list.
util/contains(lt, elem)	return true if lt contains elem.
util/binary_search(sorted, target[, lo, hi])	search a value in a sorted list.
util/count(lt, test)	return the number of times test return true in the list.

Matrix

Signature	Description
matrix/m_replace(m, i, j, value)	replace the aᵢⱼ element of a matrix.

Triangle

Signature	Description
triangle/tri_subdivide(shape_pts[, n])	subdivide a triangle n times.

Point Picking

Signature	Description
pp/pp_disk(radius, value_count[, seed])	generate random points over a disk.
pp/pp_sphere(radius, value_count[, seed])	pick random points on the surface of a sphere.
pp/pp_poisson2(size, r[, start, k, seed])	perform poisson sampling over a rectangle area.
pp/pp_poisson3(size, r[, start, k, seed])	perform poisson sampling over a cube space.

Maze

Signature	Description
maze/mz_square([rows, columns, start, init_cells, x_wrapping, y_wrapping, seed])	return cell data of a square maze.
maze/mz_squarewalls(cells, cell_width[, left_border, bottom_border])	a helper for creating square wall data from maze cells.
maze/mz_hexwalls(cells, cell_radius[, left_border, bottom_border])	a helper for creating hex wall data from maze cells.
maze/mz_theta(rings, beginning_number[, start, seed])	return cell data of a theta maze.
maze/mz_tiles(cells[, left_border, bottom_border])	turn maze cells into tiles.

v3.2.2

Maintenance release: bug fixes & performance improvements.

v3.2.1

Maintenance release: bug fixes & performance improvements.

v3.2

Deprecated:

Name	Description
paths2sections	use rails2sections instead.
hull_polyline2d, hull_polyline3d	use polyline_join instead.
shape_starburst, shape_pentagram	use shape_star instead.
starburst	use polyhedra/star instead.

New parameters:

• angle_between adds ccw.

New modules/functions:

Matrix

2D/3D Function

Signature	Description
rails2sections(rails)	create sections along rails.

Transformation

Signature	Description
select(i)	select module objects.
polyline_join(points)	place a join on each point. Hull each pair of joins and union all convex hulls.

2D Shape

Signature	Description
shape_star([outer_radius, inner_radius, n])	create a 2D star.

Polyhedra

Signature	Description
polyhedra/star([outerRadius, innerRadius, height, n])	create a 3D star.
polyhedra/polar_zonohedra(n[, theta])	create a polar zonohedra.
polyhedra/tetrahedron(radius[, detail])	create a tetrahedron.
polyhedra/hexahedron(radius[, detail])	create a hexahedron.
polyhedra/octahedron(radius[, detail])	create a octahedron.
polyhedra/dodecahedron(radius[, detail])	create a dodecahedron.
polyhedra/icosahedron(radius[, detail])	create a icosahedron.
polyhedra/superellipsoid(radius[, detail])	create a superellipsoid.

v3.1

Deprecated:

Name	Description
bezier_surface	use surface/sf_splines instead.
function_grapher	use surface/sf_thicken instead.

New modules/functions:

Matrix

Signature	Description
maxtrix/m_transpose(m)	transpose a matrix.

Surface

Signature	Description
surface/sf_curve(levels, curve_path, ...)	curve a photo.
surface/sf_splines(ctrl_pts, row_spline, column_spline)	generalized-spline surface.
surface/sf_thicken(points, thickness, ...)	thicken a surface.
surface/sf_solidifyT(points1, points2, triangles)	solidify two surfaces with triangular mesh.
surface/sf_thickenT(points, thickness, ...)	thicken a surface with triangular mesh.

Triangle

Signature	Description
triangle/tri_circumcenter(shape_pts)	return the circumcenter of a triangle.
triangle/tri_incenter(shape_pts)	return the incenter of a triangle.
triangle/tri_ear_clipping(shape_pts, ret = "TRI_INDICES", ...)	triangulation by ear clipping.
triangle/tri_delaunay(points, ret = "TRI_INDICES")	Join a set of points to make a Delaunay triangulation.
triangle/tri_delaunay_indices(d)	return triangle indices from a delaunay object.
triangle/tri_delaunay_shapes(d)	return triangle shapes from a delaunay object.
triangle/tri_delaunay_voronoi(d)	return Voronoi cells from a delaunay object.

v3.0

It's a version that Breaks Backward Compatibility!!

This version removed all deprecated modules/functions in previous versions.

Function signature changed:

• function_grapher: delete slicing parameter.
• hull_polyline3d: Rename the parameter thickness to diameter.
• line3d: Rename the parameter thickness to diameter.
• polyline3d: Rename the parameter thickness to diameter.
• util/bsearch: only supports sorted and target parameters.
• util/dedup: delete sorted parameter. add the eq,hash and number_of_buckets parameters.

Deleted:

• m_cumulate deleted.
• trianglate deleted.
• turtle/turtle2d and turtle/turtle3d are used internally.

This version, however, has some new features.

Enhanced:

• lines_intersection: Supports 3D lines.
• util/sort: by accepts a function literal.
• util/zip: Adds the combine parameter.
• function_grapher: "LINES"、"HULL_LINES" performance improved.
• vx_union, vx_circle, vx_bezier, vx_polygon: Performance improved.
• util/dedup: Performance improved.

New modules/functions:

• angle_between
• util/degrees
• util/radians
• util/polar_coordinate
• util/spherical_coordinate
• util/every
• util/some
• util/swap
• util/shuffle
• util/find_index
• util/set/hashset
• util/set/hashset_add
• util/set/hashset_has
• util/set/hashset_del
• util/set/hashset_len
• util/set/hashset_elems
• util/map/hashmap
• util/map/hashmap_put
• util/map/hashmap_get
• util/map/hashmap_del
• util/map/hashmap_len
• util/map/hashmap_keys
• util/map/hashmap_values
• util/map/hashmap_entries
• maze/mz_theta_cells
• maze/mz_theta_get

v2.5

Deprecated:

• polytransversals
• shape_glued2circles. Use shape_liquid_splitting instead.

New modules and functions:

• 2D Module

  • polygon_hull

• 3D Module

  • polyhedron_hull

• Path

  • curve
  • bauer_spiral
  • fibonacci_lattice

• 2D Shape

  • shape_liquid_splitting

• Util

  • util/lerp
  • util/choose

• Voxel

  • voxel/vx_bezier
  • voxel/vx_curve
  • voxel/vx_contour

• Maze

  • maze/mz_square_cells
  • maze/mz_square_get
  • maze/mz_square_walls
  • maze/mz_hex_walls
  • maze/mz_square_initialize
  • maze/mz_hamiltonian

v2.4

Deprecated:

• Pixel. Use Voxel instead.
• voronoi2d: use voronoi/vrn2_from instead.
• voronoi3d: use voronoi/vrn3_from instead.

Improved:

• polyline2d: improved middle-point drawing, support joinStyle parameter.
• box_extrude: added bottom_thicnkess parameter.

New modules and functions:

• 2D Function

  • lines_intersection

• Util

  • util/sum
  • util/zip

• Turtle

  • 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

• Matrix

  • matrix/m_determinant

• Voronoi

  • voronoi/vrn2_from
  • voronoi/vrn2_space
  • voronoi/vrn2_cells_from
  • voronoi/vrn2_cells_space
  • voronoi/vrn3_from
  • voronoi/vrn3_space

v2.3

Bugfixes:

• helix_extrude: wrong orientation when CLK.

Deprecated:

• polysections: use sweep instead.
• rotate_p: use ptf_rotate instead.
• circle_path: use shape_circle instead.

New modules and functions:

• 3D Module
  • sweep
  • loft
• 2D Function
  • contours
• Path
  • shape_circle
• Util
  • util/bsearch
  • util/has
  • util/dedup
  • util/flat
• 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
• 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

v2.2.1

Bugfixes:

• util/sort: z not sorted.

Improvements:

• Faster when the style of function_grapher is "LINES" or "HULL_LINES".
• Dedup pixels of pixel/px_polyline, pixel/px_circle, pixel/px_cylinder, pixel/px_sphere, pixel/px_polygon.

v2.2

• Bugfixes
  • util/sort: fix "search term not found" warning when by is "idx".
• Better dependency management. Just use modules you want. Existing scripts are not required to do any change.

v2.1

• Bugfixes
  • bend_extrude: fix wrong rotation.
  • bijection_offset: fix point order.
• New parameters.
  • box_extrude: new twist parameter.
  • crystall_ball: new thickness parameter.
• New modules and functions.
  • bspline_curve
  • util/rand
  • util/fibseq
  • pixel/px_from
  • pixel/px_ascii
  • pixel/px_gray
  • part/connector_peg
  • part/cone
  • part/joint_T
  • turtle/t2d
  • turtle/t3d

v2.0

• Use new features of OpenSCAD-2019.05 to refactor internal implementation.
• Delete the log module which is never used.
• Directory changed.
  • m_cumulate, m_mirror, m_rotation, m_scaling, m_shearing and m_translation are moved into the matrix directory.
  • turtle2d and turtle3d are moved into the turtle directory.
  • parse_number, split_str and sub_str are moved into the util directory.
• New modules and functions.
  • pixel/px_line
  • pixel/px_polyline
  • pixel/px_circle
  • pixel/px_cylinder
  • pixel/px_sphere
  • pixel/px_polygon
  • util/reverse
  • util/slice
  • util/sort

v1.3.3

• Bugfixes
  • in_shape: Wrong variable name.

v1.3.2

• All-in-one source file.

  • You can use include <dotSCAD.scad>; or use <dotSCAD.scad>; if you really don't want to care about dependencies.

• Bugfixes

  • along_with: Wrong variable scope.

v1.3.1

• Bugfixes
  • in_polyline: Wrong parameter name.
  • in_shape: Missing dependency.
  • along_with: Avoid warning when using 2D points.

v1.3

• New modules:

  • bend_extrude
  • voronoi2d
  • voronoi3d

• New functions:

  • in_shape
  • in_polyline
  • midpt_smooth
  • trim_shape
  • triangulate

• New parameters:

  • distance of shape_taiwan
  • epsilon of bijection_offset
  • method of path_extrude
  • method of along_with

v1.2

• New modules and functions:

  • starburst
  • torus_knot
  • bijection_offset
  • path_scaling_sections

• Others

  • Avoid warnings when using newer versions of OpenSCAD after 2015.03.

v1.1.1

• Bugfixes

  • m_rotation returns an identity matrix if a is 0.
  • The path_pts parameter of path_extrude accepts two or three points.
  • The points parameter of along_with accepts two or three points.

• Others

  • OpenSCAD has built-in matrix multiplication so m_multiply is not necessary.

v1.1

• New matrix functions:

  • m_multiply
  • m_cumulate
  • m_translation
  • m_rotation
  • m_scaling
  • m_mirror
  • m_shearing

• New modules:

  • shear

• New Parameters:

  • added v parameter to rotate_p

• Improved Performance:

  • path_extrude
  • align_with

v1.0.1

• Fixed path_extrude crossing problem. See issue 3.
• Fixed along_with crossing problems (similar to path_extrude.)

v1.0

• First release.