diff --git a/images/metaball_demo.png b/images/metaball_demo.png new file mode 100644 index 00000000..dc86d08f Binary files /dev/null and b/images/metaball_demo.png differ diff --git a/isosurface.scad b/isosurface.scad index 78192971..4ca7b5d9 100644 --- a/isosurface.scad +++ b/isosurface.scad @@ -1,16 +1,39 @@ ///////////////////////////////////////////////////////////////////// // LibFile: isosurface.scad -// An isosurface is a three-dimensional surface representing points of a constant -// value (e.g. density pressure, temperature, electric field strength, density) in a -// 3D volume. It is essentially a 3D cross-section of a 4-dimensional function. -// An isosurface may be represented generally by any function of three variables, -// that is, the function returns a single value based on [x,y,z] inputs. The -// isosurface is defined by all return values equal to a constant isovalue. +// [metaballs](https://en.wikipedia.org/wiki/Metaballs) (also known as "blobby objects"), +// are bounded and closed organic surfaces that smoothly blend together. +// Metaballs are one specific kind of isosurface. +// . +// An isosurface, or implicit surface, is a three-dimensional surface representing all points of a +// constant value (e.g. pressure, temperature, electric potential, density) in a +// 3D volume. It's the 3D version of a 2D contour; in fact, any 2D cross-section of an +// isosurface **is** a 2D contour. // . -// A [gryoid](https://en.wikipedia.org/wiki/Gyroid) (often used as a volume infill pattern in [FDM 3D printing](https://en.wikipedia.org/wiki/Fused_filament_fabrication)) -// is an exmaple of an isosurface that is unbounded and periodic in all three dimensions. -// Other typical examples in 3D graphics are [metaballs](https://en.wikipedia.org/wiki/Metaballs) (also known as "blobby objects"), -// which are bounded and closed organic-looking surfaces that meld together when in close proximity. +// For computer-aided design, isosurfaces of abstract functions can generate complex curved surfaces +// and organic shapes. For example, spherical metaballs can be formulated using a set of point +// centers that define the metaballs locations. For a single metaball, a function is defined each +// each point in a 3D volume based on the distance from that point to the metaball center. The +// combined contributions from all the metaballs results in a function that varies in a complicated +// way across the volume. When two metaballs are far apart, they appear simply as spheres, but when +// they are close together they enlarge amd reach toward each other and meld together in a smooth +// fashion. The resulting metaball model appears as smoothly blended blobby shapes. The +// implementation below provides metaballs of a variety of types including spheres, cuboids and +// cylinders (cones), with optional parameters to adjust the influence of one metaball on others, +// and the cutoff distance where the metaball's influence stops. +// . +// An isosurface can be defined using any function of three variables: +// the isosurface of a function $f(x,y,z)$ is the set of points where +// $f(x,y,z)=c$ for some constant value $c$. The constant $c$ is referred to as the "isovalue". +// Changing the isovalue will tend to grow or shrink the isosurface, depending on how the function is +// defined. Since metaballs are isosurfaces, they also have an isovalue. The isovalue is also known +// as the "threshold". +// . +// Some isosurface functions are unbounded, extending infinitely in all directions. A familiar example may +// be a [gryoid](https://en.wikipedia.org/wiki/Gyroid), which is often used as a volume infill pattern in +// [fused filament fabrication](https://en.wikipedia.org/wiki/Fused_filament_fabrication)). The gyroid +// isosurface is unbounded and periodic in all three dimensions. +// . +// This file provides modules and functions to create a VNF using metaballs, or from general isosurfaces. // // Includes: // include @@ -23,13 +46,15 @@ /* Lookup Tables for Transvoxel's Modified Marching Cubes -From https://gist.github.com/dwilliamson/72c60fcd287a94867b4334b42a7888ad +Adapted for OpenSCAD from https://gist.github.com/dwilliamson/72c60fcd287a94867b4334b42a7888ad Unlike the original paper (Marching Cubes: A High Resolution 3D Surface Construction Algorithm), these tables guarantee a closed mesh in which connected components are continuous and free of holes. Rotations are prioritized over inversions so that 3 of the 6 cases containing ambiguous faces are never added. 3 extra cases are added as a post-process, overriding inversions through custom-built rotations to eliminate the remaining ambiguities. -The cube index determines the sequence of edges to split. The index ranges from 0 to 255, representing all possible combinations of the 8 corners of the cube being greater or less than the isosurface threshold. For example, 10000110 (8-bit binary for decimal index 134) has corners 2, 3, and 7 greater than the threshold. After determining the cube's index value, the triangulation order is looked up in a table. +The cube index determines the sequence of edges to split. The index ranges from 0 to 255, representing all possible combinations of the 8 corners of the cube being greater or less than the isosurface threshold. + +For example, a cube with corners 2, 3, and 7 greater than the threshold isovalue would have the index 10000110, an 8-bit binary number with bits 2, 3, and 7 set to 1, corresponding to decimal index 134. After determining the cube's index value this way, the triangulation order is looked up in a table. Axes are z @@ -50,10 +75,10 @@ Vertex and edge layout (heavier = and # indicate closer to viewer): #/ #/ #/ #/ 0 +==========+ 4 +=====8=====+ -z changes fastest, then y, then x +z changes fastest, then y, then x. ----------------------------------------------------------- -Addition by Alex Matulich: +Addition by Alex: Vertex and face layout for triangulating one voxel face that corrsesponds to a side of the box bounding all voxels. 4(back) @@ -92,7 +117,7 @@ function _bbox_faces(v0, voxsize, bbox) = let( if(b[1]>=0) 5, if(b[2]>=0) 6 ]; -/// End of bounding-box faace-clipping stuff. Back to the marching cubes triangulation.... +/// End of bounding-box face-clipping stuff. Back to the marching cubes triangulation.... /// Pair of vertex indices for each edge on the voxel @@ -108,10 +133,10 @@ _MCEdgeVertexIndices = [ [0, 4], [1, 5], [3, 7], - [2, 6], + [2, 6] ]; -/// For each of the 255 configurations of a marching cube, define a list of triangles, specified as triples of edge indices. +/// For each of the 256 configurations of a marching cube, define a list of triangles, specified as triples of edge indices. _MCTriangleTable = [ [], [3,8,0], @@ -368,7 +393,7 @@ _MCTriangleTable = [ [1,8,3,9,8,1], [1,9,0], [8,3,0], - [], + [] ]; /// Same list as above, but with each row in reverse order. Needed for generating shells (two isosurfaces at slightly different iso values). @@ -633,188 +658,1103 @@ _MCTriangleTable_reverse = [ ]; +/// _cubindex() - private function, called by _isosurface_cubes() +/// Return the index ID of a voxel depending on the field strength at each corner exceeding isoval. +function _cubeindex(f, isoval) = + (f[0] > isoval ? 1 : 0) + + (f[1] > isoval ? 2 : 0) + + (f[2] > isoval ? 4 : 0) + + (f[3] > isoval ? 8 : 0) + + (f[4] > isoval ? 16 : 0) + + (f[5] > isoval ? 32 : 0) + + (f[6] > isoval ? 64 : 0) + + (f[7] > isoval ? 128 : 0); + + +/// isosurface_cubes() - private function, called by isosurface() +/// This implements a marching cube algorithm, sacrificing some memory in favor of speed. +/// Return a list of voxel cube structures that have one or both surfaces isovalmin or isovalmax intersecting them, and cubes inside the isosurface volume that are at the bounds of the bounding box. +/// The cube structure is: +/// [cubecoord, cubeindex_isomin, cubeindex_isomax, field, bfaces] +/// where +/// cubecoord is the [x,y,z] coordinate of the front left bottom corner of the voxel, +/// cubeindex_isomin and cubeindex_isomax are the index IDs of the voxel corresponding to the min and max iso surface intersections +/// cf is vector containing the 6 field strength values at each corner of the voxel cube +/// bfaces is an array of faces corresponding to the sides of the bounding box - this is empty most of the time; it has data only where the isosurface is clipped by the bounding box. +/// The bounding box 'bbox' is expected to be quantized for the voxel size already. + +function _isosurface_cubes(voxsize, bbox, fieldarray, fieldfunc, isovalmin, isovalmax, closed=true) = let( + // get field intensities + field = is_def(fieldarray) + ? fieldarray + : let(v = bbox[0], hv = 0.5*voxsize, b1 = bbox[1]+[hv,hv,hv]) [ + for(x=[v.x:voxsize:b1.x]) [ + for(y=[v.y:voxsize:b1.y]) [ + for(z=[v.z:voxsize:b1.z]) + fieldfunc(x,y,z) + ] + ] + ], + nx = len(field)-2, + ny = len(field[0])-2, + nz = len(field[0][0])-2, + v0 = bbox[0] +) [ + for(i=[0:nx]) let(x=v0[0]+voxsize*i) + for(j=[0:ny]) let(y=v0[1]+voxsize*j) + for(k=[0:nz]) let(z=v0[2]+voxsize*k) + let(i1=i+1, j1=j+1, k1=k+1, + cf = [ // cube corner field values + min(1e9,max(-1e9,field[i][j][k])), + min(1e9,max(-1e9,field[i][j][k1])), + min(1e9,max(-1e9,field[i][j1][k])), + min(1e9,max(-1e9,field[i][j1][k1])), + min(1e9,max(-1e9,field[i1][j][k])), + min(1e9,max(-1e9,field[i1][j][k1])), + min(1e9,max(-1e9,field[i1][j1][k])), + min(1e9,max(-1e9,field[i1][j1][k1])) + ], + mincf = min(cf), + maxcf = max(cf), + cubecoord = [x,y,z], + bfaces = closed ? _bbox_faces(cubecoord, voxsize, bbox) : [], + cubefound_isomin = (mincf<=isovalmin && isovalmin0) for(ei=epathmin) // min surface + let( + edge = _MCEdgeVertexIndices[ei], + vi0 = edge[0], + vi1 = edge[1], + denom = f[vi1] - f[vi0], + u = abs(denom)<0.00001 ? 0.5 : (isovalmin-f[vi0]) / denom + ) + vcube[vi0] + u*(vcube[vi1]-vcube[vi0]), + if(lenmax>0) for(ei=epathmax) // max surface + let( + edge = _MCEdgeVertexIndices[ei], + vi0 = edge[0], + vi1 = edge[1], + denom = f[vi1] - f[vi0], + u = abs(denom)<0.00001 ? 0.5 : (isovalmax-f[vi0]) / denom + ) + vcube[vi0] + u*(vcube[vi1]-vcube[vi0]), + if(n_outer>0) for(bf = bbfaces) + each _bbfacevertices(vcube, f, bf, isovalmax, isovalmin) + ] +]; + + +/// Generate triangles for the special case of voxel faces clipped by the bounding box +function _bbfacevertices(vcube, f, bbface, isovalmax, isovalmin) = let( + vi = _MCFaceVertexIndices[bbface], // four voxel face vertex indices + //vfc = [ for(i=vi) vcube[i] ], // four voxel face vertex coordinates + //fld = [ for(i=vi) f[i] ], // four corner field values + pgon = flatten([ + for(i=[0:3]) let( // for each line segment... + vi0=vi[i], // voxel corner 0 index + vi1=vi[(i+1)%4], // voxel corner 1 index + f0 = f[vi0], // field value at corner 0 + f1 = f[vi1], // field value at corner 1 + fmin = min(f0, f1), // min field of the corners + fmax = max(f0, f1), // max field of the corners + ilowbetween = (fmin < isovalmin && isovalmin < fmax), + ihighbetween = (fmin < isovalmax && isovalmax < fmax), + denom = f1-f0 + ) [ // traverse the edge, output vertices as they are found + if(isovalmin <= f0 && f0 <= isovalmax)// && abs(f1-f0)>0.001) + // vertex 0 is on or between min and max isovalues + //echo(vfc, fld) + vcube[vi0], + //else if (abs(isovalmin-f0)<0.00001 || abs(isovalmax-f0)<0.00001) + // 0.5*(vcube[vi0]+vcube[vi1]), + // for f0f1) + let(u = abs(denom)<0.00001 ? 0.5 : (isovalmax-f0)/denom) + vcube[vi0] + u*(vcube[vi1]-vcube[vi0]), + if(ilowbetween && f0>f1) + let(u = abs(denom)<0.00001 ? 0.5 : (isovalmin-f0)/denom) + vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) + ] + ]), + npgon = len(pgon), + triangles = npgon<3 ? [] : [ + for(i=[1:len(pgon)-2]) [pgon[0], pgon[i], pgon[i+1]] + ]) flatten(triangles); + + +/// _showstats() (Private function) - called by isosurface() and metaballs() +/// Display statistics about isosurface +function _showstats(voxelsize, bbox, isoval, cubes, faces) = let( + v = column(cubes, 0), // extract cube vertices + x = column(v,0), // extract x values + y = column(v,1), // extract y values + z = column(v,2), // extract z values + xmin = min(x), + xmax = max(x)+voxelsize, + ymin = min(y), + ymax = max(y)+voxelsize, + zmin = min(z), + zmax = max(z)+voxelsize, + ntri = len(faces), + nvox = len(cubes) +) echo(str("\nIsosurface statistics:\n Outer isovalue = ", isoval, "\n Voxel size = ", voxelsize, + "\n Voxels found containing surface = ", nvox, "\n Triangles = ", ntri, + "\n Voxel bounding box for all data = ", bbox, + "\n Voxel bounding box for isosurface = ", [[xmin,ymin,zmin], [xmax,ymax,zmax]], + "\n")) 0; + + +/// ---------- metaball stuff starts here ---------- + +/// Animated metaball demo made with BOSL2 here: https://imgur.com/a/m29q8Qd + +/// Built-in metaball functions corresponding to each MB_ index. +/// For speed, they are split into four functions, each handling a different combination of influence != 1 or influence == 1, and cutoff < INF or cutoff == INF. + +/// public metaball cutoff function if anyone wants it (demonstrated in example) + +function mb_cutoff(dist, cutoff) = dist>=cutoff ? 0 : 0.5*(cos(180*(dist/cutoff)^4)+1); + + +/// metaball sphere + +function _mb_sphere_basic(dv, r, neg) = neg*r/norm(dv); +function _mb_sphere_influence(dv, r, ex, neg) = neg * (r/norm(dv))^ex; +function _mb_sphere_cutoff(dv, r, cutoff, neg) = let(dist=norm(dv)) + neg * mb_cutoff(dist, cutoff) * r/dist; +function _mb_sphere_full(dv, r, cutoff, ex, neg) = let(dist=norm(dv)) + neg * mb_cutoff(dist, cutoff) * (r/dist)^ex; + +function mb_sphere(r, cutoff=INF, influence=1, negative=false, d) = + assert(is_num(cutoff) && cutoff>0, "\ncutoff must be a positive number.") + assert(is_finite(influence) && influence>0, "\ninfluence must be a positive number.") + let( + r = get_radius(r=r,d=d), + dummy=assert(is_finite(r) && r>0, "\ninvalid radius or diameter."), + neg = negative ? -1 : 1 + ) + !is_finite(cutoff) && influence==1 ? function(dv) _mb_sphere_basic(dv,r,neg) + : !is_finite(cutoff) ? function(dv) _mb_sphere_influence(dv,r,1/influence, neg) + : influence==1 ? function(dv) _mb_sphere_cutoff(dv,r,cutoff,neg) + : function(dv) _mb_sphere_full(dv,r,cutoff,1/influence,neg); + + +/// metaball rounded cube + +function _mb_cuboid_basic(dv, inv_size, xp, neg) = + let( + dv=inv_size * dv, + dist = xp >= 1100 ? max(v_abs(dv)) + : (abs(dv.x)^xp + abs(dv.y)^xp + abs(dv.z)^xp) ^ (1/xp) + ) neg/dist; +function _mb_cuboid_influence(dv, inv_size, xp, ex, neg) = let( + dv=inv_size * dv, + dist = xp >= 1100 ? max(v_abs(dv)) + :(abs(dv.x)^xp + abs(dv.y)^xp + abs(dv.z)^xp) ^ (1/xp) +) neg / dist^ex; +function _mb_cuboid_cutoff(dv, inv_size, xp, cutoff, neg) = let( + dv = inv_size * dv, + dist = xp >= 1100 ? max(v_abs(dv)) + : (abs(dv.x)^xp + abs(dv.y)^xp + abs(dv.z)^xp) ^ (1/xp) +) neg * mb_cutoff(dist, cutoff) / dist; +function _mb_cuboid_full(dv, inv_size, xp, ex, cutoff, neg) = let( + dv = inv_size * dv, + dist = xp >= 1100 ? max(v_abs(dv)) + :(abs(dv.x)^xp + abs(dv.y)^xp + abs(dv.z)^xp) ^ (1/xp) +) neg * mb_cutoff(dist, cutoff) / dist^ex; + +function mb_cuboid(size, squareness=0.5, cutoff=INF, influence=1, negative=false) = + assert(is_num(cutoff) && cutoff>0, "\ncutoff must be a positive number.") + assert(is_finite(influence) && influence>0, "\ninfluence must be a positive number.") + assert((is_finite(size) && size>0) || (is_vector(size) && all_positive(size)), "\nsize must be a positive number or a 3-vector of positive values.") + let( + xp = _squircle_se_exponent(squareness), + neg = negative ? -1 : 1, + inv_size = is_num(size) ? 2/size + : [[2/size.x,0,0],[0,2/size.y,0],[0,0,2/size.z]] + ) + !is_finite(cutoff) && influence==1 ? function(dv) _mb_cuboid_basic(dv, inv_size, xp, neg) + : !is_finite(cutoff) ? function(dv) _mb_cuboid_influence(dv, inv_size, xp, 1/influence, neg) + : influence==1 ? function(dv) _mb_cuboid_cutoff(dv, inv_size, xp, cutoff, neg) + : function (dv) _mb_cuboid_full(dv, inv_size, xp, 1/influence, cutoff, neg); + + +/// metaball rounded cylinder / cone + +function _revsurf_basic(dv, path, coef, neg) = + let( + pt = [norm([dv.x,dv.y]), dv.z], + segs = pair(path), + dist = min([for(seg=segs) + let( + c=seg[1]-seg[0], + s0 = seg[0]-pt, + t = -s0*c/(c*c) + ) + t<0 ? norm(s0) + : t>1 ? norm(seg[1]-pt) + : norm(s0+t*c)]), + inside_check = [for(seg=segs) + if (cross(seg[1]-seg[0], pt-seg[0]) > EPSILON) 1] + ) + neg * (inside_check==[] ? coef*(1+dist) : coef/(1+dist)); + +function _revsurf_influence(dv, path, coef, exp, neg) = + let( + pt = [norm([dv.x,dv.y]), dv.z], + segs = pair(path), + dist = min([for(seg=segs) + let( + c=seg[1]-seg[0], + s0 = seg[0]-pt, + t = -s0*c/(c*c) + ) + t<0 ? norm(s0) + : t>1 ? norm(seg[1]-pt) + : norm(s0+t*c)]), + inside_check = [for(seg=segs) + if (cross(seg[1]-seg[0], pt-seg[0]) > EPSILON) 1] + ) + neg * (inside_check==[] ? (coef*(1+dist))^exp : (coef/(1+dist))^exp); + +function _revsurf_cutoff(dv, path, coef, cutoff, neg) = + let( + pt = [norm([dv.x,dv.y]), dv.z], + segs = pair(path), + dist = min([for(seg=segs) + let( + c=seg[1]-seg[0], + s0 = seg[0]-pt, + t = -s0*c/(c*c) + ) + t<0 ? norm(s0) + : t>1 ? norm(seg[1]-pt) + : norm(s0+t*c)]), + inside_check = [for(seg=segs) + if (cross(seg[1]-seg[0], pt-seg[0]) > EPSILON) 1] + ) + neg * (inside_check==[] + ? (coef*(1+dist)) : mb_cutoff(dist-coef, cutoff) * (coef/(1+dist)) ); + +function _revsurf_full(dv, path, coef, cutoff, exp, neg) = + let( + pt = [norm([dv.x,dv.y]), dv.z], + segs = pair(path), + dist = min([for(seg=segs) + let( + c=seg[1]-seg[0], + s0 = seg[0]-pt, + t = -s0*c/(c*c) + ) + t<0 ? norm(s0) + : t>1 ? norm(seg[1]-pt) + : norm(s0+t*c)]), + inside_check = [ + for(seg=segs) + if (cross(seg[1]-seg[0], pt-seg[0]) > EPSILON) 1 + ] + ) + neg * (inside_check==[] + ? (coef*(1+dist))^exp : mb_cutoff(dist-coef, cutoff) * (coef/(1+dist))^exp ); + +function mb_cyl(h,r,rounding=0,r1,r2,l,height,length,d1,d2,d, cutoff=INF, influence=1, negative=false) = + let( + r1 = get_radius(r1=r1,r=r, d1=d1, d=d), + r2 = get_radius(r1=r2,r=r, d1=d2, d=d), + h = first_defined([h,l,height,length],"h,l,height,length") + ) + assert(is_finite(rounding) && rounding>=0, "rounding must be a nonnegative number") + assert(is_finite(r1) && r1>0, "r/r1/d/d1 must be a positive number") + assert(is_finite(r2) && r2>0, "r/r2/d/d2 must be a positive number") + let( + vang = atan2(r1-r2,h), + facelen = adj_ang_to_hyp(h, abs(vang)), + roundlen1 = rounding/tan(45-vang/2), + roundlen2 = rounding/tan(45+vang/2), + sides = [[0,h/2], [r2,h/2], [r1,-h/2], [0,-h/2]], + neg = negative ? -1 : 1 + ) + assert(roundlen1 <= r1, "size of rounding is larger than the r1 radius of the cylinder/cone") + assert(roundlen2 <= r2, "size of rounding is larger than the r2 radius of the cylinder/cone") + assert(roundlen1+roundlen2 < facelen, "Roundings don't fit on the edge length of the cylinder/cone") + let(shifted = offset(sides, delta=-rounding, closed=false)) + !is_finite(cutoff) && influence==1 ? function(dv) _revsurf_basic(dv, shifted, 1+rounding, neg) + : !is_finite(cutoff) ? function(dv) _revsurf_influence(dv, shifted, 1+rounding, 1/influence, neg) + : influence==1 ? function(dv) _revsurf_cutoff(dv, shifted, 1+rounding, cutoff, neg) + : function (dv) _revsurf_full(dv, shifted, 1+rounding, cutoff, 1/influence, neg); + +// metaball capsule (round-ended cylinder) + +function _mb_capsule_basic(dv, hl, r, neg) = let( + dist = dv.z<-hl ? norm(dv-[0,0,-hl]) + : dv.z<=hl ? norm([dv.x,dv.y]) : norm(dv-[0,0,hl]) +) neg*r/dist; +function _mb_capsule_influence(dv, hl, r, ex, neg) = let( + dist = dv.z<-hl ? norm(dv-[0,0,-hl]) + : dv.z<=hl ? norm([dv.x,dv.y]) : norm(dv-[0,0,hl]) +) neg * (r/dist)^ex; +function _mb_capsule_cutoff(dv, hl, r, cutoff, neg) = let( + dist = dv.z<-hl ? norm(dv-[0,0,-hl]) + : dv.z0, "\ncutoff must be a positive number.") + assert(is_finite(influence) && influence>0, "\ninfluence must be a positive number.") + let( + h = one_defined([h,l,height,length],"h,l,height,length"), + dum1 = assert(is_finite(h) && h>0, "\ncylinder height must be a positive number."), + r = get_radius(r=r,d=d), + dum2 = assert(is_finite(r) && r>0, "\ninvalid radius or diameter."), + sh = h-2*r, // straight side length + dum3 = assert(sh>0, "\nTotal length must accommodate rounded ends of cylinder."), + neg = negative ? -1 : 1 + ) + !is_finite(cutoff) && influence==1 ? function(dv) _mb_capsule_basic(dv,sh/2,r,neg) + : !is_finite(cutoff) ? function(dv) _mb_capsule_influence(dv,sh/2,r,1/influence, neg) + : influence==1 ? function(dv) _mb_capsule_cutoff(dv,sh/2,r,cutoff,neg) + : function (dv) _mb_capsule_full(dv, sh/2, r, cutoff, 1/influence, neg); + + +/// metaball disk with rounded edge + +function _mb_disk_basic(dv, hl, r, neg) = + let( + rdist=norm([dv.x,dv.y]), + dist = rdist0, "\ncutoff must be a positive number.") + assert(is_finite(influence) && influence>0, "\ninfluence must be a positive number.") + let( + h = one_defined([h,l,height,length],"h,l,height,length"), + dum1 = assert(is_finite(h) && h>0, "\ncylinder height must be a positive number."), + h2 = h/2, + or = get_radius(r=r,d=d), + dum2 = assert(is_finite(r) && or>0, "\ninvalid radius or diameter."), + r = or - h2, + dum3 = assert(r>0, "\nDiameter must be greater than height."), + neg = negative ? -1 : 1 + ) + !is_finite(cutoff) && influence==1 ? function(dv) _mb_disk_basic(dv,h2,r,neg) + : !is_finite(cutoff) ? function(dv) _mb_disk_influence(dv,h2,r,1/influence, neg) + : influence==1 ? function(dv) _mb_disk_cutoff(dv,h2,r,cutoff,neg) + : function (dv) _mb_disk_full(dv, h2, r, cutoff, 1/influence, neg); + + +/// metaball connector cylinder - calls mb_capsule* functions after transform + +function mb_connector(p1, p2, r, cutoff=INF, influence=1, negative=false, d) = + assert(is_num(cutoff) && cutoff>0, "\ncutoff must be a positive number.") + assert(is_finite(influence) && influence>0, "\ninfluence must be a positive number.") + let( + dum1 = assert(is_vector(p1,3), "\nConnector start point p1 must be a 3D coordinate.") + assert(is_vector(p2,3), "\nConnector end point p2 must be a 3D coordinate.") + assert(p1 != p2, "\nStart and end points p1 and p2 cannot be the same."), + r = get_radius(r=r,d=d), + dum2 = assert(is_finite(r) && r>0, "\ninvalid radius or diameter."), + neg = negative ? -1 : 1, + dc = p2-p1, // center-to-center distance + midpt = reverse(-0.5*(p1+p2)), + h = norm(dc)/2, // center-to-center length (cylinder height) + transform = submatrix(down(h)*rot(from=dc,to=UP)*move(-p1) ,[0:2], [0:3]) + ) + !is_finite(cutoff) && influence==1 ? function(dv) + let(newdv = transform * [each dv,1]) + _mb_capsule_basic(newdv,h,r,neg) + : !is_finite(cutoff) ? function(dv) + let(newdv = transform * [each dv,1]) + _mb_capsule_influence(newdv,h,r,1/influence, neg) + : influence==1 ? function(dv) + let(newdv = transform * [each dv,1]) + _mb_capsule_cutoff(newdv,h,r,cutoff,neg) + : function (dv) + let(newdv = transform * [each dv,1]) + _mb_capsule_full(newdv, h, r, cutoff, 1/influence, neg); + + +/// metaball octahedron + +function _mb_octahedron_basic(dv, r, neg) = + let(dist = abs(dv.x) + abs(dv.y) + abs(dv.z)) neg*r/dist; +function _mb_octahedron_influence(dv, r, ex, neg) = + let(dist = abs(dv.x) + abs(dv.y) + abs(dv.z)) neg * (r/dist)^ex; +function _mb_octahedron_cutoff(dv, r, cutoff, neg) = + let(dist = abs(dv.x) + abs(dv.y) + abs(dv.z)) neg * mb_cutoff(dist, cutoff) * r/dist; +function _mb_octahedron_full(dv, r, cutoff, ex, neg) = + let(dist = abs(dv.x) + abs(dv.y) + abs(dv.z)) neg * mb_cutoff(dist, cutoff) * (r/dist)^ex; + +function mb_octahedron(r, cutoff=INF, influence=1, negative=false, d) = + assert(is_num(cutoff) && cutoff>0, "\ncutoff must be a positive number.") + assert(is_finite(influence) && is_num(influence) && influence>0, "\ninfluence must be a positive number.") + let( + r = get_radius(r=r,d=d), + dummy=assert(is_finite(r) && r>0, "\ninvalid radius or diameter."), + neg = negative ? -1 : 1 + ) + !is_finite(cutoff) && influence==1 ? function(dv) _mb_octahedron_basic(dv,r,neg) + : !is_finite(cutoff) ? function(dv) _mb_octahedron_influence(dv,r,1/influence, neg) + : influence==1 ? function(dv) _mb_octahedron_cutoff(dv,r,cutoff,neg) + : function(dv) _mb_octahedron_full(dv,r,cutoff,1/influence,neg); + + +/// metaball torus + +function _mb_torus_basic(dv, rmaj, rmin, neg) = + let(dist = norm([norm([dv.x,dv.y])-rmaj, dv.z])) neg*rmin/dist; +function _mb_torus_influence(dv, rmaj, rmin, ex, neg) = + let(dist = norm([norm([dv.x,dv.y])-rmaj, dv.z])) neg * (rmin/dist)^ex; +function _mb_torus_cutoff(dv, rmaj, rmin, cutoff, neg) = + let(dist = norm([norm([dv.x,dv.y])-rmaj, dv.z])) + neg * mb_cutoff(dist, cutoff) * rmin/dist; +function _mb_torus_full(dv, rmaj, rmin, cutoff, ex, neg) = + let(dist = norm([norm([dv.x,dv.y])-rmaj, dv.z])) + neg * mb_cutoff(dist, cutoff) * (rmin/dist)^ex; + +function mb_torus(r_maj, r_min, cutoff=INF, influence=1, negative=false, d_maj, d_min, or,od,ir,id) = + assert(is_num(cutoff) && cutoff>0, "\ncutoff must be a positive number.") + assert(is_finite(influence) && influence>0, "\ninfluence must be a positive number.") + let( + _or = get_radius(r=or, d=od, dflt=undef), + _ir = get_radius(r=ir, d=id, dflt=undef), + _r_maj = get_radius(r=r_maj, d=d_maj, dflt=undef), + _r_min = get_radius(r=r_min, d=d_min, dflt=undef), + r_maj = is_finite(_r_maj)? _r_maj : + is_finite(_ir) && is_finite(_or)? (_or + _ir)/2 : + is_finite(_ir) && is_finite(_r_min)? (_ir + _r_min) : + is_finite(_or) && is_finite(_r_min)? (_or - _r_min) : + assert(false, "Bad major size parameter."), + r_min = is_finite(_r_min)? _r_min : + is_finite(_ir)? (maj_rad - _ir) : + is_finite(_or)? (_or - maj_rad) : + assert(false, "\nBad minor size parameter."), + neg = negative ? -1 : 1 + ) + !is_finite(cutoff) && influence==1 ? function(dv) _mb_torus_basic(dv, r_maj, r_min, neg) + : !is_finite(cutoff) ? function(dv) _mb_torus_influence(dv, r_maj, r_min, 1/influence, neg) + : influence==1 ? function(dv) _mb_torus_cutoff(dv, r_maj, r_min, cutoff, neg) + : function(dv) _mb_torus_full(dv, r_maj, r_min, cutoff, 1/influence, neg); + + +// Function&Module: metaballs() +// Synopsis: Creates a group of 3D metaballs (smoothly connected blobs). +// SynTags: Geom,VNF +// Topics: Metaballs, Isosurfaces, VNF Generators +// See Also: isosurface() +// Usage: As a module +// metaballs(funcs, bounding_box, voxel_size, [isovalue=], [closed=], [show_stats=], ...) [ATTACHMENTS]; +// Usage: As a function +// vnf = metaballs(funcs, bounding_box, voxel_size, [isovalue=], [closed=], [show_stats=]); +// Description: +// ![Metaball andimation](./images/metaball_demo.png) +// . +// [Metaballs](https://en.wikipedia.org/wiki/Metaballs), also known as "blobby objects", +// can produce soothly varying blobs and organic forms. You create metaballs by placing metaball +// objects at different locations. These objects have a basic size and shape when placed in +// isolation, but if another metaball object is nearby, the two objects interact, growing larger +// and melding together. The closer the objects are, the more they blend and meld. +// . +// The simplest metaball specification is a list of alternating transformation matrices and +// metaball functions: `[trans0, func0, trans1, func1, ... ]`. The transformation matrix +// you supply can be constructed using the usual transformation commands such as {{up()}}, +// {{right()}}, {{back()}}, {{move()}}, {{scale()}}, {{rot()}} and so on. You can multiply +// the transformations together, similar to how the transformations can be applied +// to regular objects in OpenSCAD. For exmaple, to transform an object in regular OpenSCAD you might +// write `up(5) xrot(25) zrot(45) scale(4)`. You would provide that transformation +// as the transformation matrix `up(5) * xrot(25) * zrot(45) * scale(4)`. You can use +// scaling to produce an ellipse from a sphere, and you can even use {{skew()}} if desired. +// When no transformation is needed, give `IDENT` as the transformation. +// . +// You can create metaballs in a variety of standard shapes using the predefined functions +// listed below. If you wish, you can also create custom metaball shapes using your own functions +// (see Example 12). Three parameters are available on all of the built-in metaballs to control the +// interaction of the metaballs with each other: `cutoff`, `influence`, and `negative'. +// . +// The `cutoff` parameter specifies the distance beyond which the metaball has no interaction with +// other balls. When you apply `cutoff`, a smooth suppression factor begins begins decreasing the +// interaction strength at half the cutoff distance and reduces the interaction to zero at the cutoff. +// If you scale a ball, the cutoff values is also scaled. The exact way that cutoff is defined +// geometrically varies for different ball types; see below for details. +// The smooth decrease may cause the interaction to be negligible closer than the cutoff distance +// distance, depending on the voxel size and influence of the ball. Also, depending on the value +// of `influence`, a cutoff that ends in the middle of another ball can result in strange shapes, +// as shown in Example 8, with the metaball interacting one one side of the boundary and not +// interacting on the other side. +// . +// The `influence` parameter adjusts the strength of the interaction metaball objects have with each +// other. If you increase `influence` from its default of 1, the metaball interacts with other +// metaballs at a longer range, and surrounding balls grow bigger. The metaball with larger +// influence can also grow bigger because it couples more strongly with other nearby balls, but it +// can also remain nearly unchanged while influencing others when `isovalue` is greater than 1. +// Decreasing influence has the reverse effect. Small changes in influence can have a large +// effect. For example, setting `influence=2` dramatically increases the interactions at longer +// distances, and you may want to set the `cutoff` argument to limit the range influence. +// . +// The `negative` parameter, if set to `true`, creates a negative metaball, which can create +// hollows or dents in other metaballs, or swallow other metaballs entirely, making them disappear. +// Negative metaballs are always below the isovalue, so they are never directly visible; +// only their effects are visible. See Examples 7 and 8. +// . +// For complicated metaball assemblies you may wish to repeat a structure in different locations or +// otherwise transformed. Nesting metaball specifications are supported: +// Instad of specifying a transform and function, you specify a transform and then a metaball +// specification. For example, you could set `finger=[t0,f0,t1,f1,t2,f2]` and then set +// `hand=[u0,finger,u1,finger,...]` and then invoke metaball with `[s0, hand]`. +// Basically, any list of metaballs is, itself, a metaball. It can be used in place of a function in another list. +// This is a powerful technique that lets you make groups of metaballs that you can use as individual +// metaballs in other groups, and can make your code compact and simpler to understand. See Example 14. +// . +// .h3 Built-in metaball functions +// Several metaballs are defined for you to use in your models. +// All of the built-in metaballs take positional and named parameters that specify the size of the +// metaball (e.g. radius, height). The size arguments are the same as those for the regular objects +// of the same type (e.g. a sphere accepts both `r` for radius and the named parameter `d=` for +// diameter). The size parameters always specify the size of the metaball **in isolation** with +// `isovalue=1`. The metaballs can grow much bigger than their specified sizes when they interact +// with each other. The metaballs also grow bigger than their specified sizes, even in isolation, +// if `isovalue<1` and smaller than their specified sizes if `isovalue>1`. +// . +// All of the built-in functions all accept these named arguments, which are not repeated in the list below: +// * `cutoff` - positive value giving the distance beyond which the metaball does not interact with other balls. Cutoff is measured from the object's center unless otherwise noted below. Default: INF +// * `influence` - a positive number specifying the strength of interaction this ball has with other balls. Default: 1 +// * `negative` - when true, create a negative metaball. Default: false +// . +// The built-in metaball functions are: +// `mb_sphere(r|d=)` - spherical metaball, with radius r or diameter d. You can create an ellipsoid using `scale()` as the last transformation entry of the metaball `funcs` array. +// Figure(3D,NoAxes): Two spheres interacting +// metaballs([ +// left(9), mb_sphere(5), +// right(9), mb_sphere(5) +// ], 0.5, [[-16,-7,-7], [16,7,7]], 1); +// Continues: +// `mb_cuboid(size, [squareness=0.5])` - cuboid metaball with rounded edges and corners. The corner sharpness is controlled by the `squareness` parameter ranging from 0 (spherical) to 1 (cubical), and defaults to 0.5. The `size` is a scalar that specifies the width of the cuboid shape between the face centers. Except when `squareness=1`, the faces are always a little bit curved. +// Figure(3D,NoAxes): Two rounded cuboids interacting +// metaballs([ +// move([-8,-5,-5]), mb_cuboid(10), +// move([8,5,5]), mb_cuboid(10) +// ], 0.5, [[-15,-12,-12], [15,12,12]], 1); +// Continues: +// `mb_cyl(h|l|height|length=, [r|d=], [r1=|d1=], [r2=|d2=], [rounding=0])` - vertical cylinder or cone metaball with the same dimenional arguments as {{cyl()}}. Only one rounding value is allowed: the rounding is the same at both ends. For a fully rounded cylindrical shape, consider `mb_capsule()` or `mb_disk()`, which are less flexible but have faster execution times. For this metaball, the cutoff is measured from surface of the cone with the specified dimensions. +// Figure(3D,NoAxes): Two rounded `mb_cyl()` cones interacting +// metaballs([ +// left(10), mb_cyl(15, r1=8, r2=5, rounding=3), +// right(10), mb_cyl(15, r1=8, r2=5, rounding=3) +// ], 0.5, [[-19,-9,-10], [19,9,10]], 1); +// Continues: +// `mb_disk(h|l|height|length=, [r|d=])` - rounded disk with flat ends. The diameter specifies the total diameter of the shape including the rounded sides and must be greater than its height. +// Figure(3D,NoAxes): Two disks interacting +// metaballs([ +// move([-10,0,2]), mb_disk(5,9), +// move([10,0,-2]), mb_disk(5,9) +// ], 0.5, [[-20,-10,-6], [20,10,6]], 1); +// Continues: +// `mb_capsule(h|l|height|length=, r|d=)` - cylinder of radius `r` or diameter `d` with hemispherical caps. The height or length specifies the **total** height including the rounded ends. +// Figure(3D,NoAxes): Two capsules interacting +// metaballs([ +// move([-8,0,4])*yrot(90), mb_capsule(16,3), +// move([8,0,-4])*yrot(90), mb_capsule(16,3) +// ], 0.5, [[-17,-5,-8], [17,5,8]], 1); +// Continues: +// `mb_connector(p1, p2, r|d=)` - cylinder of radius `r` or diameter `d` with hemispherical caps (like mb_capsule), but specified to connect point `p1` to point `p2` (where `p1` and `p2` must be different 3D vectors). The specified points are at the ends of the straight portion of the shape (the centers of the two capping hemispheres). You may want to set `influence` quite low; the connectors themselves are still influenced by other metaballs, but it may be undesirable to have them influence others, or each other. If two connectors are connected, the joint may appear large and swollen unless `influence` is reduced. +// Figure(3D,NoAxes): A sphere with two connectors +// metaballs([ +// left(20), mb_sphere(6), +// IDENT, mb_connector([-20,0,0], [0,0,10], 2, influence=0.5), +// IDENT, mb_connector([0,0,10], [0,-10,0], 2, influence=0.5) +// ], 0.5, [[-27,-13,-7], [4,7,14]], 1); +// Continues: +// `mb_torus([r_maj|d_maj=], [r_min|d_min=],[or=|od=],[ir=|id=])` - torus metaball oriented perpendicular to the z axis. You can specify the torus dimensions using the same arguments as {{torus()}}; that is, major radius (or diameter) with `r_maj` or `d_maj`, and minor radius and diameter using `r_min` or `d_min`. Alternatively you can give the inner radius or diameter with `ir` or `id` and the outer radius or diameter with `or` or `od`. +// Figure(3D,NoAxes): Two tori interacting +// metaballs([ +// move([-10,0,3]), mb_torus(8,3), +// move([10,0,-3]), mb_torus(8,3) +// ], 0.5, [[-23,-13,-8], [23,13,8]], 1); +// Continues: +// `mb_octahedron(r|d=])` - octahedral metaball with sharp edges and corners. The `r` parameter specifies the distance from center to tip. The vertex parameter specifies the distance between the two opposite tips. +// Figure(3D,NoAxes,VPR=[75,0,20]): Two octahedrons interacting +// metaballs([ +// move([-10,0,3]), mb_octahedron(8), +// move([10,0,-3]), mb_octahedron(8) +// ], 0.5, [[-21,-11,-13], [21,11,13]], 1); +// Continues: +// . +// .h3 Metaball functions and user defined functions +// Each metaball function is defined as a function of a 3-vector that gives the value of the metaball function +// for that point in space. As is common in metaball implementations, we define the built-in metaballs using an +// inverse relationship where the metaball functions fall off as $1/d$, where $d$ is distance from the +// metaball center. The spherical metaball therefore has a simple basic definition as `f(v) = 1/norm(v)`. +// Note that with this framework, `f(v) >= c` defines a bounded object. Increasing the isovalue shrinks the +// object, and decreasing the isovalue grows the object. +// . +// In order to adjust interaction strength, the influence parameter applies an exponent, so if `influence=a` +// then the decay becomes $1/d^(1/a)$. This means, for example, that if you set influence to 2 you get a +// $1/d^2$ falloff. Changing this exponent changes how the balls interact. +// . +// You can pass a custom function as a [function literal](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/User-Defined_Functions_and_Modules#Function_literals) +// that takes a single argument (a 3-vector) and returns a single numerical value. +// The returned value should define a function where in isovalue range [c,INF] defines a bounded object. See Example 12. +// Arguments: +// funcs = a 1-D list of transform and function pairs in the form `[trans0, func0, trans1, func1, ...]`, with one pair for each metaball. The transform should be at least a position such as `move([x,y,z])` to specify the location of the metaball center, but you can also include rotations, such as `move([x,y,z])*rot([ax,ay,az])`. You can multiply together any of BOSL2's affine operations like {{xrot()}}, {{scale()}}, and {{skew()}}. This is useful for orienting non-spherical metaballs. The priority order of the transforms is right to left, that is, `move([4,5,6])*rot([45,0,90])` does the rotation first, and then the move, similar to normal OpenSCAD syntax `translate([4,5,6]) rotate([45,0,90]) children()`. The transform `IDENT` may be used if you don't want to specify a transform, resulting in a metaball positioned at the origin. **Any function in the list may, itself, be another list of metaballs instead of a function name.** See Example 14 for a demonstration. +// voxel_size = The size (scalar) of the voxel cube that determines the resolution of the metaball surface. **Start with a larger size for experimenting, and refine it gradually.** A small voxel size can significantly slow down processing time, especially with a large `bounding_box`. +// bounding_box = A pair of 3D points `[[xmin,ymin,zmin], [xmax,ymax,zmax]]`, specifying the minimum and maximum box corner coordinates. The voxels needn't fit perfectly inside the bounding box. For metaballs with flat surfaces (the ends of `mb_cyl()`, and `mb_cuboid()` with `squareness=1`), avoid letting any side of the bounding box coincide with one of these flat surfaces, otherwise unpredictable triangulation around the edge may result. +// isovalue = A scalar value specifying the isosurface value (threshold value) of the metaballs. At the default value of 1.0, the internal metaball functions are designd so the size arguments correspond to the size parameter (such as radius) of the metaball, when rendered in isolation with no other metaballs. Default: 1.0 +// --- +// closed = When true, maintains a manifold surface where the bounding box clips it (there is a negligible speed penalty in doing this). When false, the bounding box clips the surface, exposing the back sides of facets. Setting this to false can be useful with OpenSCAD's "View > Thrown together" menu option to distinguish inside from outside. Default: true +// show_stats = If true, display statistics about the metaball isosurface in the console window. Besides the number of voxels found to contain the surface, and the number of triangles making up the surface, this is useful for getting information about a smaller bounding box possible, to improve speed for subsequent renders. Enabling this parameter has a small speed penalty. Default: false +// convexity = Maximum number of times a line could intersect a wall of the shape. Affects preview only. Default: 6 +// cp = (Module only) Center point for determining intersection anchors or centering the shape. Determines the base of the anchor vector. Can be "centroid", "mean", "box" or a 3D point. Default: "centroid" +// anchor = (Module only) Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `"origin"` +// spin = (Module only) Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0` +// orient = (Module only) Vector to rotate top toward, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP` +// atype = (Module only) Select "hull" or "intersect" anchor type. Default: "hull" +// Anchor Types: +// "hull" = Anchors to the virtual convex hull of the shape. +// "intersect" = Anchors to the surface of the shape. +// Named Anchors: +// "origin" = Anchor at the origin, oriented UP. +// Example(3D,VPD=110): This is the first of a series of five examples demonstrating the differnent types of metaball interactions. We start with two spheres 30 units apart. Each would have a radius of 10 in isolation, but because they are influencing their surroundings, each sphere mutually contributes to the size of the other. The sum of contributions between the spheres add up so that a surface plotted around the region exceeding the threshold defined by `isovalue=1` looks like a peanut shape surrounding the two spheres. +// funcs = [ +// left(15), mb_sphere(10), +// right(15), mb_sphere(10) +// ]; +// voxelsize = 1; +// boundingbox = [[-30,-19,-19], [30,19,19]]; +// metaballs(funcs, voxelsize, boundingbox, +// isovalue=1); +// Example(3D,VPD=110): Adding a cutoff of 25 to the left sphere causes its influence to disappear completely 25 units away (which is the center of the right sphere). The left sphere is bigger because it still receives the full influence of the right sphere, but the right sphere is smaller because the left sphere has no contribution past 25 units. Setting cutoff too small can remove the interactions of one metaball from all other metaballs, leaving that metaball alone by itself. +// funcs = [ +// left(15), mb_sphere(10, cutoff=25), +// right(15), mb_sphere(10) +// ]; +// voxelsize = 1; +// boundingbox = [[-30,-19,-19], [30,19,19]]; +// metaballs(funcs, voxelsize, boundingbox, +// isovalue=1); +// Example(3D,VPD=110): Here, the left sphere has less influence in addition to a cutoff. Setting `influence=0.5` results in a steeper falloff of contribution from the left sphere. Each sphere has a different size and shape due to unequal contributions based on distance. +// funcs = [ +// left(15), mb_sphere(10, influence=0.5, cutoff=25), +// right(15), mb_sphere(10) +// ]; +// voxelsize = 1; +// boundingbox = [[-30,-19,-19], [30,19,19]]; +// metaballs(funcs, voxelsize, boundingbox, +// isovalue=1); +// Example(3D,VPD=110): In this example, we have two size-10 spheres as before and one tiny sphere of 1.5 units radius offset a bit on the y axis. With an isovalue of 1, this figure would appear similar to Example 1 above, but here the isovalue has been set to 2, causing the surface to shrink around a smaller volume values greater than 2. Remember, higher isovalue thresholds cause metaballs to shrink. +// funcs = [ +// left(15), mb_sphere(10), +// right(15), mb_sphere(10), +// fwd(15), mb_sphere(1.5) +// ]; +// voxelsize = 1; +// boundingbox = [[-30,-19,-19], [30,19,19]]; +// metaballs(funcs, voxelsize, boundingbox, +// isovalue=2); +// Example(3D,VPD=110): Keeping `isovalue=2`, the influence of the tiny sphere has been set quite high, to 10. Notice that the tiny sphere does not change in size, but its contribution to its surroundings has dramatically increased, causing the two other spheres to grow and meld into each other. The `influence` argument on a small metaball affects its surroundings more than itself. +// funcs = [ +// move([-15,0,0]), mb_sphere(10), +// move([15,0,0]), mb_sphere(10), +// move([0,-15,0]), mb_sphere(1.5, influence=10) +// ]; +// voxelsize = 1; +// boundingbox = [[-30,-19,-19], [30,19,19]]; +// metaballs(funcs, voxelsize, boundingbox, +// isovalue=2); +// Example(3D,NoAxes): A group of five spherical metaballs with different sizes. The parameter `show_stats=true` (not shown here) was used to find a compact bounding box for this figure. +// funcs = [ // spheres of different sizes +// move([-20,-20,-20]), mb_sphere(5), +// move([0,-20,-20]), mb_sphere(4), +// IDENT, mb_sphere(3), +// move([0,0,20]), mb_sphere(5), +// move([20,20,10]), mb_sphere(7) +// ]; +// isovalue = 1; +// voxelsize = 1.5; +// boundingbox = [[-30,-31,-31], [32,31,31]]; +// metaballs(funcs, voxelsize, boundingbox, isovalue); +// Example(3D,NoAxes): A metaball can be negative. In this case we have two metaballs in close proximity, with the small negative metaball creating a dent in the large positive one. The positive metaball is shown transparent, and small spheres show the center of each metaball. The negative metaball isn't visible because its field is negative; the isosurface encloses only field values greater than the isovalue of 1. +// centers = [[-1,0,0], [1.25,0,0]]; +// funcs = [ +// move(centers[0]), mb_sphere(8), +// move(centers[1]), mb_sphere(3, negative=true) +// ]; +// voxelsize = 0.25; +// isovalue = 1; +// boundingbox = [[-7,-6,-6], [3,6,6]]; +// #metaballs(funcs, voxelsize, boundingbox, isovalue); +// color("green") move_copies(centers) sphere(d=1, $fn=16); +// Example(3D,VPD=100): When a positive and negative metaball interact, the negative metaball reduces the influence of the positive one, causing it to shrink but not disappear because its contribution approaches infinity at its center. In this example we have a large positive metaball near a small negative metaball at the origin. The negative ball as high influence and a cutoff limiting its influence to 20 units. The negative metaball influences the positive one up to the cutoff, causing the positive metaball to appear smaller inside the cutoff range, and appear its normal size outside the cutoff range. The positive metaball has a small dimple at the origin (the center of the negative metaball) because it cannot overcome the infinite negative contribution of the negative metaball at the origin. +// funcs = [ +// back(10), mb_sphere(20), +// IDENT, mb_sphere(2, influence = 30, cutoff = 20, negative = true), +// ]; +// isovalue = 1; +// voxelsize = 0.5; +// boundingbox = [[-20,-4,-20], [20,30,20]]; +// metaballs(funcs, voxelsize, boundingbox, isovalue); +// Example(3D,NoAxes): A cube, a rounded cube, and an octahedron interacting. Because the surface is generated through cubical voxels, voxel corners are always cut off, resulting in difficulty resolving some sharp edges. +// funcs = [ +// move([-7,-3,27])*zrot(55), mb_cuboid(6, squareness=1), +// move([5,5,21]), mb_cuboid(5), +// move([10,0,10]), mb_octahedron(5) +// ]; +// voxelsize = 0.5; // a bit slow at this resolution +// boundingbox = [[-12,-9,3], [18,10,32]]; +// metaballs(funcs, voxelsize, boundingbox, isovalue=1); +// Example(3D,NoAxes): Interaction between two tori in different orientations. +// funcs = [ +// move([-10,0,17]), mb_torus(r_maj=6, r_min=2), +// move([7,6,21])*xrot(90), mb_torus(r_maj=7, r_min=3) +// ]; +// voxelsize = 0.5; +// boundingbox = [[-19,-9,9], [18,10,32]]; +// metaballs(funcs, voxelsize, boundingbox, isovalue=1); +// Example(3D,NoAxes,VPD=205,Med): A toy airplane, constructed only from metaball spheres with scaling. The bounding box is used to clip the wingtips, tail, and belly of the fuselage. +// bounding_box = [[-55,-50,-5],[35,50,17]]; +// funcs = [ +// move([-20,0,0])*scale([25,4,4]), mb_sphere(1), // fuselage +// move([30,0,5])*scale([4,0.5,8]), mb_sphere(1), // vertical stabilizer +// move([30,0,0])*scale([4,15,0.5]), mb_sphere(1), // horizontal stabilizer +// move([-15,0,0])*scale([6,45,0.5]), mb_sphere(1) // wing +// ]; +// isovalue = 1; +// voxel_size = 1; +// metaballs(funcs, voxel_size, bounding_box, isovalue); +// Example(3D): Demonstration of a custom metaball function, in this case a sphere with some random noise added to its value. The `dv` argument must be first; it is calculated internally as a distance vector from the metaball center to a probe point inside the bounding box, and you convert it to a scalar distance `dist` that is calculated inside your function (`dist` could be a more complicated expression, depending on the shape of the metaball). The call to `mb_cutoff()` at the end handles the cutoff function for the noisy ball consistent with the other internal metaball functions; it requires `dist` and `cutoff` as arguments. You are not required to include the `cutoff` and `influence` arguments in a custom function, but this example shows how. +// function noisy_sphere(dv, r, noise_level, cutoff=INF, influence=1) = +// let( +// noise = rands(0, noise_level, 1)[0], +// dist = norm(dv) + noise +// ) mb_cutoff(dist,cutoff) * (r/dist)^(1/influence); +// +// funcs = [ +// left(9), mb_sphere(5), +// right(9), function (dv) noisy_sphere(dv, 5, 0.2), +// ]; +// voxelsize = 0.5; +// boundingbox = [[-16,-8,-8], [16,8,8]]; +// metaballs(funcs, voxelsize, boundingbox, isovalue=1); +// Example(3D,Med,NoAxes,VPR=[55,0,0],VPD=200,VPT=[7,2,2]): A complex example using ellipsoids, a capsule, spheres, and a torus to make a tetrahedral object with rounded feet and a ring on top. The bottoms of the feet are flattened by limiting the minimum z value of the bounding box. The center of the object is thick due to the contributions of four ellipsoids converging. Designing an object like this using metaballs requires trial and error with low-resolution renders. +// include +// tetpts = zrot(15, p = 22 * regular_polyhedron_info("vertices", "tetrahedron")); +// tettransform = [ for(pt = tetpts) move(pt)*rot(from=RIGHT, to=pt)*scale([7,1.5,1.5]) ]; +// +// funcs = [ +// // vertical cylinder arm +// up(15), mb_capsule(17, 2, influence=0.8), +// // ellipsoid arms +// for(i=[0:2]) each [tettransform[i], mb_sphere(1, cutoff=30)], +// // ring on top +// up(35)*xrot(90), mb_torus(r_maj=8, r_min=2.5, cutoff=35), +// // feet +// for(i=[0:2]) each [move(2.2*tetpts[i]), mb_sphere(5, cutoff=30)], +// ]; +// voxelsize = 1; +// boundingbox = [[-22,-32,-13], [36,32,46]]; +// // useful to save as VNF for copies and manipulations +// vnf = metaballs(funcs, voxelsize, boundingbox, isovalue=1); +// vnf_polyhedron(vnf); +// Example(3D,Med,NoAxes,VPR=[70,0,30],VPD=520,VPT=[0,0,80]): Example of grouping metaballs together and nesting them in lists of other metaballs, to make a crude model of a hand. Here, just one finger is defined, and a thumb is defined from one less joint in the finger. Individual fingers are grouped together with different positions and scaling, along with the thumb. Finally, this group of all fingers is used to combine with a rounded cuboid, with a slight ellipsoid dent subtracted to hollow out the palm, to make the hand. +// joints = [[0,0,1], [0,0,85], [0,-5,125], [0,-16,157], [0,-30,178]]; +// finger = [ +// for(i=[0:3]) each +// [IDENT, mb_connector(joints[i], joints[i+1], 9+i/5, influence=0.22)] +// ]; +// thumb = [ +// for(i=[0:2]) each [ +// scale([1,1,1.2]), +// mb_connector(joints[i], joints[i+1], 9+i/2, influence=.28) +// ] +// ]; +// allfingers = [ +// left(15)*zrot(5)*yrot(-50)*scale([1,1,0.6])*zrot(30), thumb, +// left(15)*yrot(-9)*scale([1,1,0.9]), finger, +// IDENT, finger, +// right(15)*yrot(8)*scale([1,1,0.92]), finger, +// right(30)*yrot(17)*scale([0.9,0.9,0.75]), finger +// ]; +// hand = [ +// IDENT, allfingers, +// move([-5,0,5])*scale([1,0.36,1.55]), mb_cuboid(90, squareness=0.3, cutoff=80), +// move([-10,-95,50])*yrot(10)*scale([2,2,0.95]), +// mb_sphere(r=15, cutoff=50, influence=1.5, negative=true) +// ]; +// voxsize=2.5; +// bbox = [[-104,-40,-10], [79,18,188]]; +// metaballs(hand, voxsize, bbox, isovalue=1); + +module metaballs(funcs, voxel_size, bounding_box, isovalue=1, closed=true, convexity=6, cp="centroid", anchor="origin", spin=0, orient=UP, atype="hull", show_stats=false) { + vnf = metaballs(funcs, voxel_size, bounding_box, isovalue, closed, show_stats); + vnf_polyhedron(vnf, convexity=convexity, cp=cp, anchor=anchor, spin=spin, orient=orient, atype=atype) + children(); +} + +function metaballs(funcs, voxel_size, bounding_box, isovalue=1, closed=true, show_stats=false) = + assert(all_defined([funcs, isovalue, bounding_box, voxel_size]), "\nThe parameters funcs, isovalue, bounding_box, and voxel_size must all be defined.") + assert(len(funcs)%2==0, "\nThe funcs parameter must be an even-length list of alternating transforms and functions") + let( + funclist = _mb_unwind_list(funcs), + nballs = len(funclist)/2, + dummycheck = [ + for(i=[0:len(funcs)/2-1]) let(j=2*i) + assert(is_matrix(funcs[j],4,4), str("\nfuncs entry at position ", j, " must be a 4×4 matrix.")) + assert(is_function(funcs[j+1]) || is_list(funcs[j+1]), str("\nfuncs entry at position ", j+1, " must be a function literal or a metaball list.")) 0 + ], + // set up transformation matrices in advance + transmatrix = [ + for(i=[0:nballs-1]) + let(j=2*i) + transpose(select(matrix_inverse(funclist[j]), 0,2)) + ], + + // new bounding box centered around original, forced to integer multiples of voxel size + halfvox = 0.5*voxel_size, + bbcenter = mean(bounding_box), + bbnums = v_ceil((bounding_box[1]-bounding_box[0]) / voxel_size), + newbbox = [bbcenter - halfvox*bbnums, bbcenter + halfvox*bbnums], + + // set up field array + bot = newbbox[0], + top = newbbox[1], + // accumulate metaball contributions using matrices rather than sums + xset = [bot.x:voxel_size:top.x+halfvox], + yset = list([bot.y:voxel_size:top.y+halfvox]), + zset = list([bot.z:voxel_size:top.z+halfvox]), + allpts = [for(x=xset, y=yset, z=zset) [x,y,z,1]], + trans_pts = [for(i=[0:nballs-1]) allpts*transmatrix[i]], + allvals = [for(i=[0:nballs-1]) [for(pt=trans_pts[i]) funclist[2*i+1](pt)]], + //total = _sum(allvals,allvals[0]*EPSILON), + total = _sum(slice(allvals,1,-1), allvals[0]), + fieldarray = list_to_matrix(list_to_matrix(total,len(zset)),len(yset)) + ) isosurface(fieldarray, isovalue, voxel_size, closed=closed, show_stats=show_stats, _mb_origin=newbbox[0]); + + +function _mb_unwind_list(list, parent_trans=[IDENT]) = + let( + dum1 = assert(is_list(list), "\nDid not find valid list of metaballs."), + n=len(list), + dum2 = assert(n%2==0, "\nList of metaballs must have an even number of elements with alternating transforms and functions/lists.") + ) [ + for(i=[0:2:n-1]) + let( + dum = assert(is_matrix(list[i],4,4), str("\nInvalid 4×4 transformation matrix found at position ",i,".")), + trans = parent_trans[0] * list[i], + j=i+1 + ) if(is_function(list[j])) + each [trans, list[j]] + else if (is_list(list[j])) + each _mb_unwind_list(list[j], [trans]) + else + assert(false, str("\nExpected function literal or list at position ",j,".")) + ]; + + + +/// ---------- isosurface stuff starts here ---------- + // Function&Module: isosurface() -// Synopsis: Creates a 3D isosurface. +// Synopsis: Creates a 3D isosurface (a 3D contour) from a function or array of values. // SynTags: Geom,VNF // Topics: Isosurfaces, VNF Generators // Usage: As a module -// isosurface(voxel_size, bounding_box, isovalue, field_function, [additional=], [reverse=], [close_clip=], [show_stats=]); +// isosurface(f, isovalue, voxel_size, bounding_box, [reverse=], [closed=], [show_stats=], ...) [ATTACHMENTS]; // Usage: As a function -// vnf = isosurface(voxel_size, bounding_box, isovalue, field_function, [additional=], [close_clip=], [show_stats=]); +// vnf = isosurface(f, isovalue, voxel_size, bounding_box, [reverse=], [closed=], [show_stats=]); // Description: -// When called as a function, returns a [VNF structure](vnf.scad) (list of triangles and faces) representing a 3D isosurface within the specified bounding box at a single isovalue or range of isovalues. -// When called as a module, displays the isosurface within the specified bounding box at a single isovalue or range of isovalues. This module just passes the parameters to the function, and then calls {{vnf_polyhedron()}} to display the isosurface. +// Computes a [VNF structure](vnf.scad) of a 3D isosurface within a bounded box at a single +// isovalue or range of isovalues. +// The isosurface of a function $f(x,y,z)$ is the set of points where $f(x,y,z)=c$ for some +// constant isovalue, $c$. +// To provide a function you supply a [function literal](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/User-Defined_Functions_and_Modules#Function_literals) +// taking three parameters as input to define the grid coordinate location (e.g. `x,y,z`) and +// returning a single numerical value. +// You can also define an isosurface using a 3D array of values instead of a function, in which +// case the isosurface is the set of points where the array is equal to the isovalue. The array +// indices are in the order `[x][y][z]`. // . -// A [marching cubes](https://en.wikipedia.org/wiki/Marching_cubes) algorithm is used -// to identify an envelope containing the isosurface within the bounding box. The surface -// intersecttion with a voxel cube is then triangulated to form a surface fragment, which is -// combined with all other surface fragments. Ambiguities in triangulating the surfaces -// in certain voxel cube configurations are resolved so that all triangular facets are -// properly oriented with no holes in the surface. If a side of the bounding box clips -// the isosurface, this clipped area is filled in so that the surface remains manifold. +// The VNF that is computed has the isosurface as its bounding surface, with all the points where +// $f(x,y,z)>c$ on the interior side of the surface. +// When the isovalue is a range, `[c1, c2]`, then the resulting VNF has two bounding surfaces +// corresponding to `c1` and `c2`, and the interior of the object are the points with intermediate +// isovalues; this generally produces a shell object that has an inside and outside surface. The +// range can start at `-INF` or end at `INF`. A single isovalue `c` is equivalent to `[c,INF]`. // . -// Be mindful of how you set `voxel_size` and `bounding_box`. For example a voxel size -// of 1 unit with a bounding box volume of 200×200×200 may be noticeably slow, -// requiring calculation and storage of 8,000,000 field values, and more processing -// and memory to generate the triangulated mesh. On the other hand, a voxel size of 5 -// in a 100×100×100 bounding box requires only 8,000 field values and the mesh -// generates fairly quickly, just a handful of seconds. A good rule is to keep the -// number of field values below 10,000 for preview, and adjust the voxel size -// smaller for final rendering. If the isosurface fits completely within the bounding -// box, you can call {{pointlist_bounds()}} on `vnf[0]` returned from the -// `isosurface()` function to get an idea of a more optimal smaller bounding box to use, -// possibly allowing increasing resolution by decresing the voxel size. You can also set -// the parameter `show_stats=true` to get the bounds of the voxels containing the surface. +// The isosurface is evaluated over a bounding box which is divided into voxels of the specified +// `voxel_size`. Smaller voxels produce a finer, smoother result at the expense of execution time. +// If the voxel size doesn't exactly divide your specified bounding box, then the bounding box is +// enlarged enough to contain all whole voxels, and centered on your requested box. +// If the bounding box clips the isosurface, then if `closed=true` (default) the clipped area is +// filled in to produce a closed surface. Setting `closed=false` causes the VNF to end at the +// bounding box, resulting in a non-manifold shape with holes, exposing the inside of the object. +// . +// The `voxel_size` and `bounding_box` parameters affect the run time, which can be long. +// A voxel size of 1 with a bounding box volume of 200×200×200 may be slow because it requires the +// calculation and storage of 8,000,000 function values, and more processing and memory to generate +// the triangulated mesh. On the other hand, a voxel size of 5 over a 100×100×100 bounding box +// requires only 8,000 function values and a modest computation time. A good rule is to keep the +// number of voxels below 10,000 for preview, and adjust the voxel size smaller for final +// rendering. A bounding box that is larger than your isosurface wastes time computing function +// values that are not needed. If the isosurface fits completely within the bounding box, you can +// call {{pointlist_bounds()}} on `vnf[0]` returned from the `isosurface()` function to get an +// idea of a the optimal bounding box to use. You may be able to decrease run time, or keep the +// same run time but increase the resolution. You can also set the parameter `show_stats=true` to +// get the bounds of the voxels containing the surface. // . // The point list in the VNF structure contains many duplicated points. This is not a // problem for rendering the shape, but if you want to eliminate these, you can pass // the structure to {{vnf_merge_points()}}. Additionally, flat surfaces (often // resulting from clipping by the bounding box) are triangulated at the voxel size // resolution, and these can be unified into a single face by passing the vnf -// structure to {{vnf_unify_faces()}}. These steps can be expensive for execution time +// structure to {{vnf_unify_faces()}}. These steps can be computationall expensive // and are not normally necessary. // Arguments: -// voxel_size = The size (scalar) of the voxel cube that determines the resolution of the surface. -// bounding_box = A pair of 3D points `[[xmin,ymin,zmin], [xmax,ymax,zmax]]`, specifying the minimum and maximum corner coordinates of the bounding box. You don't have ensure that the voxels fit perfectly inside the bounding box. While the voxel at the minimum bounding box corner is aligned on that corner, the last voxel at the maximum box corner may extend a bit beyond it. -// isovalue = As a scalar, specifies the output value of `field_function` corresponding to the isosurface. As a vector `[min_isovalue, max_isovalue]`, specifies the range of isovalues around which to generate a surface. For closed surfaces, a single value results in a closed volume, and a range results in a shell (with an inside and outside surface) enclosing a volume. A range must be specified for infinite-extent surfaces (such as gyroids) to create a manifold shape within the bounding box. -// field_function = A [function literal](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/User-Defined_Functions_and_Modules#Function_literals) taking as input an `[x,y,z]` coordinate and optional additional parameters, and returns a single value. +// f = The isosurface function or array. +// isovalue = a scalar giving the isovalue parameter or a 2-vector giving an isovalue range. +// voxel_size = scalar size of the voxel cube that is used to sample the surface. +// bounding_box = When `f` is a function, a pair of 3D points `[[xmin,ymin,zmin], [xmax,ymax,zmax]]`, specifying the minimum and maximum corner coordinates of the bounding box. The actual bounding box enlarged if necessary to make the voxels fit perfectly, and centered around your requested box. // --- -// additional = A single value, or an array of optional additional parameters that may be required by the field function. It is your responsibility to create a function literal compatible with these inputs. If `additional` is not set, only the `[x,y,z]` parameter is passed to the function; no additional parameters are passed. Default: undef -// reverse = When true, reverses the orientation of the facets in the mesh. Default: false -// close_clip = When true, maintains a manifold surface where the bounding box clips it (there is a negligible speed penalty in doing this). When false, the bounding box clips the surface, exposing the back sides of facets. Setting this to false can be useful with OpenSCAD's "View > Thrown Together" menu option to distinguish inside from outside. Default: true -// show_stats = If true, display statistics about the isosurface in the console window. Besides the number of voxels found to contain the surface, and the number of triangles making up the surface, this is useful for getting information about a smaller bounding box possible for the isosurface, to improve speed for subsequent renders. Enabling this parameter has a speed penalty. Default: false -// Example(3D,ThrownTogether,NoAxes): A gyroid is an isosurface defined by all the zero values of a 3D periodic function. To illustrate what the surface looks like, `close_clip=false` has been set to expose both sides of the surface. The surface is periodic and tileable along all three axis directions. This a non-manifold surface as displayed, not useful for 3D modeling. This example also demonstrates the use of the `additional` parameter, which in this case controls the wavelength of the gyroid. -// gyroid = function (xyz, wavelength) let( +// closed = When true, close the surface if it intersects the bounding box by adding a closing face. When false, do not add a closing face and instead produce a non-manfold VNF that has holes. Default: true +// reverse = When true, reverses the orientation of the VNF faces. Default: false +// show_stats = If true, display statistics in the console window about the isosurface: number of voxels that contain the surface, number of triangles, bounding box of the voxels, and voxel-rounded bounding box of the surface, which may help you reduce your bounding box to improve speed. Enabling this parameter has a slight speed penalty. Default: false +// convexity = Maximum number of times a line could intersect a wall of the shape. Affects preview only. Default: 6 +// cp = (Module only) Center point for determining intersection anchors or centering the shape. Determines the base of the anchor vector. Can be "centroid", "mean", "box" or a 3D point. Default: "centroid" +// anchor = (Module only) Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `"origin"` +// spin = (Module only) Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0` +// orient = (Module only) Vector to rotate top toward, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP` +// atype = (Module only) Select "hull" or "intersect" anchor type. Default: "hull" +// Anchor Types: +// "hull" = Anchors to the virtual convex hull of the shape. +// "intersect" = Anchors to the surface of the shape. +// Named Anchors: +// "origin" = Anchor at the origin, oriented UP. +// Example(3D,ThrownTogether,NoAxes): A gyroid is an isosurface defined by all the zero values of a 3D periodic function. To illustrate what the surface looks like, `closed=false` has been set to expose both sides of the surface. The surface is periodic and tileable along all three axis directions. This a non-manifold surface as displayed, not useful for 3D modeling. This example also demonstrates using an additional parameters in the field function beyond just x,y,z; in this case controls the wavelength of the gyroid. +// function gyroid(x,y,z, wavelength) = let( // p = 360/wavelength, -// px = p*xyz[0], -// py = p*xyz[1], -// pz = p*xyz[2] +// px = p*x, py = p*y, pz = p*z // ) sin(px)*cos(py) + sin(py)*cos(pz) + sin(pz)*cos(px); -// +// isovalue = 0; // bbox = [[-100,-100,-100], [100,100,100]]; -// isosurface(voxel_size=5, bounding_box=bbox, isovalue=0, -// field_function=gyroid, additional=200, close_clip=false); -// Example(3D,NoAxes): If we remove the `close_clip` parameter or set it to true, the isosurface algorithm encloses the entire half-space bounded by the "inner" gyroid surface, leaving only the "outer" surface exposed. This is a manifold shape but not what we want if trying to model a gyroid. -// gyroid = function (xyz, wavelength) let( +// isosurface(function (x,y,z) gyroid(x,y,z, wavelength=200), +// isovalue, voxel_size=5, bounding_box=bbox, +// closed=false); +// Example(3D,NoAxes): If we remove the `closed` parameter or set it to true, the isosurface algorithm encloses the entire half-space bounded by the "inner" gyroid surface, leaving only the "outer" surface exposed. This is a manifold shape but not what we want if trying to model a gyroid. +// function gyroid(x,y,z, wavelength) = let( // p = 360/wavelength, -// px = p*xyz[0], -// py = p*xyz[1], -// pz = p*xyz[2] +// px = p*x, py = p*y, pz = p*z // ) sin(px)*cos(py) + sin(py)*cos(pz) + sin(pz)*cos(px); -// +// isovalue = 0; // bbox = [[-100,-100,-100], [100,100,100]]; -// isosurface(voxel_size=5, bounding_box=bbox, isovalue=0, -// field_function=gyroid, additional=200); -// Example(3D,ThrownTogether,NoAxes): To make the gyroid a double-sided surface, we need to specify a small range around zero for `isovalue`. Now we have a double-sided surface although with `close_clip=false` the edges are not closed where the surface is clipped by the bounding box. -// gyroid = function (xyz, wavelength) let( +// isosurface(function (x,y,z) gyroid(x,y,z, wavelength=200), +// isovalue, voxel_size=5, bounding_box=bbox); +// Example(3D,ThrownTogether,NoAxes): To make the gyroid a double-sided surface, we need to specify a small range around zero for `isovalue`. Now we have a double-sided surface although with `closed=false` the edges are not closed where the surface is clipped by the bounding box. +// function gyroid(x,y,z, wavelength) = let( // p = 360/wavelength, -// px = p*xyz[0], -// py = p*xyz[1], -// pz = p*xyz[2] +// px = p*x, py = p*y, pz = p*z // ) sin(px)*cos(py) + sin(py)*cos(pz) + sin(pz)*cos(px); -// +// isovalue = [-0.3, 0.3]; // bbox = [[-100,-100,-100], [100,100,100]]; -// isosurface(voxel_size=5, bounding_box=bbox, isovalue=[-0.3, 0.3], -// field_function=gyroid, additional=200, close_clip=false); -// Example(3D,ThrownTogether,NoAxes): To make the gyroid a valid manifold 3D object, we remove the `close_clip` parameter (same as setting `close_clip=true`), which closes the edges where the surface is clipped by the bounding box. The resulting object can be tiled, the VNF returned by the functional version can be wrapped around an axis using {{vnf_bend()}}, and other operations. -// gyroid = function (xyz, wavelength) let( +// isosurface(function (x,y,z) gyroid(x,y,z, wavelength=200), +// isovalue, voxel_size=5, bounding_box=bbox, +// closed = false); +// Example(3D,ThrownTogether,NoAxes): To make the gyroid a valid manifold 3D object, we remove the `closed` parameter (same as setting `closed=true`), which closes the edges where the surface is clipped by the bounding box. The resulting object can be tiled, the VNF returned by the functional version can be wrapped around an axis using {{vnf_bend()}}, and other operations. +// function gyroid(x,y,z, wavelength) = let( // p = 360/wavelength, -// px = p*xyz[0], -// py = p*xyz[1], -// pz = p*xyz[2] +// px = p*x, py = p*y, pz = p*z // ) sin(px)*cos(py) + sin(py)*cos(pz) + sin(pz)*cos(px); -// +// isovalue = [-0.3, 0.3]; // bbox = [[-100,-100,-100], [100,100,100]]; -// isosurface(voxel_size=5, bounding_box=bbox, isovalue=[-0.3, 0.3], -// field_function=gyroid, additional=200); +// isosurface(function (x,y,z) gyroid(x,y,z, wavelength=200), +// isovalue, voxel_size=5, bounding_box=bbox); // Example(3D,NoAxes): An approximation of the triply-periodic minimal surface known as [Schwartz P](https://en.wikipedia.org/wiki/Schwarz_minimal_surface). -// schwartz_p = function (xyz, wavelength) let( +// function schwartz_p(x,y,z, wavelength) = let( // p = 360/wavelength, -// px = p*xyz[0], -// py = p*xyz[1], -// pz = p*xyz[2] +// px = p*x, py = p*y, pz = p*z // ) cos(px) + cos(py) + cos(pz); -// +// isovalue = [-0.2, 0.2]; // bbox = [[-100,-100,-100], [100,100,100]]; -// isosurface(voxel_size=4, bounding_box=bbox, isovalue=[-0.2,0.2], -// field_function=schwartz_p, additional=100); +// isosurface(function (x,y,z) schwartz_p(x,y,z, 100), +// isovalue, voxel_size=4, bounding_box=bbox); // Example(3D,NoAxes): Another approximation of the triply-periodic minimal surface known as [Neovius](https://en.wikipedia.org/wiki/Neovius_surface). -// neovius = function (xyz, wavelength) let( +// function neovius(x,y,z, wavelength) = let( // p = 360/wavelength, -// px = p*xyz[0], -// py = p*xyz[1], -// pz = p*xyz[2] +// px = p*x, py = p*y, pz = p*z // ) 3*(cos(px) + cos(py) + cos(pz)) + 4*cos(px)*cos(py)*cos(pz); -// +// isovalue = [-0.3, 0.3]; // bbox = [[-100,-100,-100], [100,100,100]]; -// isosurface(voxel_size=4, bounding_box=bbox, isovalue=[-0.3,0.3], -// field_function=neovius, additional=200); - -module isosurface(voxel_size, bounding_box, isovalue, field_function, additional, reverse=false, close_clip=true, show_stats=false) { - vnf = isosurface(voxel_size, bounding_box, isovalue, field_function, additional, reverse, close_clip, show_stats); - vnf_polyhedron(vnf); -} - -function isosurface(voxel_size, bounding_box, isovalue, field_function, additional, reverse=false, close_clip=true, show_stats=false) = - assert(all_defined([voxel_size, bounding_box, isovalue, field_function]), "The parameters voxel_size, bounding_box, isovalue, and field_function must all be defined.") - let( - isovalmin = is_list(isovalue) ? isovalue[0] : isovalue, - isovalmax = is_list(isovalue) ? isovalue[1] : INF, - newbbox = let( // new bounding box quantized for voxel_size - hv = 0.5*voxel_size, - bbn = (bounding_box[1]-bounding_box[0]+[hv,hv,hv]) / voxel_size, - bbsize = [round(bbn[0]), round(bbn[1]), round(bbn[2])] * voxel_size - ) [bounding_box[0], bounding_box[0]+bbsize], - cubes = _isosurface_cubes(voxel_size, bbox=newbbox, fieldfunc=field_function, additional=additional, isovalmin=isovalmin, isovalmax=isovalmax, close_clip=close_clip), - tritablemin = reverse ? _MCTriangleTable_reverse : _MCTriangleTable, - tritablemax = reverse ? _MCTriangleTable : _MCTriangleTable_reverse, - trianglepoints = _isosurface_triangles(cubes, voxel_size, isovalmin, isovalmax, tritablemin, tritablemax), - faces = [ for(i=[0:3:len(trianglepoints)-1]) [i,i+1,i+2] ], - dummy = show_stats ? _showstats(voxel_size, newbbox, isovalmin, cubes, faces) : 0 -) [trianglepoints, faces]; - - -// Function&Module: isosurface_array() -// Synopsis: Creates a 3D isosurface from a 3D array of densities. -// SynTags: Geom,VNF -// Topics: Isosurfaces, VNF Generators -// Usage: As a module -// isosurface_array(voxel_size, isovalue, fields, [origin=], [reverse=], [close_clip=], [show_stats=]); -// Usage: As a function -// vnf = isosurface_array(voxel_size, isovalue, fields, [origin=], [reverse=], [close_clip=], [show_stats=]); -// Description: -// When called as a function, returns a [VNF structure](vnf.scad) (list of triangles and -// faces) representing a 3D isosurface within the passed array at a single isovalue or -// range of isovalues. -// When called as a module, displays the isosurface within the passed array at a single -// isovalue or range of isovalues. This module just passes the parameters to the function, -// and then calls {{vnf_polyhedron()}} to display the isosurface. -// . -// Use this when you already have a 3D array of intensity or density data, for example like -// what you may get from a [CT scan](https://en.wikipedia.org/wiki/CT_scan). -// . -// By default, the returned VNF structure occupies a volume with its origin at [0,0,0] -// extending in the positive x, y, and z directions by multiples of `voxel_size`. -// This origin can be overridden by the `origin` parameter. -// . -// The point list in the VNF structure contains many duplicated points. This is not a -// problem for rendering the shape, but if you want to eliminate these, you can pass -// the structure to {{vnf_merge_points()}}. Additionally, flat surfaces at the outer limits -// of the `fields` array are triangulated at the voxel size -// resolution, and these can be unified into a single face by passing the vnf -// structure to {{vnf_unify_faces()}}. These steps can be expensive for execution time -// and are not normally necessary. -// Arguments: -// voxel_size = The size (scalar) of the voxel cube that determines the resolution of the surface. -// isovalue = As a scalar, specifies the output value of `field_function` corresponding to the isosurface. As a vector `[min_isovalue, max_isovalue]`, specifies the range of isovalues around which to generate a surface. For closed surfaces, a single value results in a closed volume, and a range results in a shell (with an inside and outside surface) enclosing a volume. A range must be specified for surfaces (such as gyroids) that have both sides exposed within the bounding box. -// fields = 3D array of field intesities. This array should be organized so that the indices are in order of x, y, and z when the array is referenced; that is, `fields[x_index][y_index][z_index]` has `z_index` changing most rapidly as the array is traversed. If you organize the array differently, you may have to perform a `rotate()` or `mirror()` operation on the final result to orient it properly. -// --- -// origin = Origin in 3D space corresponding to `fields[0][0][0]`. The bounding box of the isosurface extends from this origin by multiples of `voxel_size` according to the size of the `fields` array. Default: [0,0,0] -// reverse = When true, reverses the orientation of the facets in the mesh. Default: false -// close_clip = When true, maintains a manifold surface where the bounding box clips it (there is a negligible speed penalty in doing this). When false, the bounding box clips the surface, exposes the back sides of facets. Setting this to false can be useful with OpenSCAD's "View > Thrown together" menu option to distinguish inside from outside. Default: true -// show_stats = If true, display statistics about the isosurface in the console window. Besides the number of voxels found to contain the surface, and the number of triangles making up the surface, this is useful for getting information about a smaller bounding box possible for the isosurface, to improve speed for subsequent renders. Enabling this parameter has a speed penalty. Default: false -// Example(3D): -// fields = [ +// isosurface(function (x,y,z) neovius(x,y,z,200), +// isovalue, voxel_size=4, bounding_box=bbox); +// Example(3D): Using an array for the `f` argument instead of a function literal. {{metaballs()}} also makes use of this feature, calculating the the 3D grid first. +// field = [ // repeat(0,[6,6]), // [ [0,1,2,2,1,0], // [1,2,3,3,2,1], @@ -840,574 +1780,40 @@ function isosurface(voxel_size, bounding_box, isovalue, field_function, addition // repeat(0,[6,6]) // ]; // rotate([0,-90,180]) -// isosurface_array(voxel_size=10, -// isovalue=0.5, fields=fields); +// isosurface(field, isovalue=0.5, +// voxel_size=10); -module isosurface_array(voxel_size, isovalue, fields, origin=[0,0,0], reverse=false, close_clip=true, show_stats=false) { - vnf = isosurface_array(voxel_size, isovalue, fields, origin, reverse, close_clip, show_stats); - vnf_polyhedron(vnf); +module isosurface(f, isovalue, voxel_size, bounding_box, reverse=false, closed=true, convexity=6, cp="centroid", anchor="origin", spin=0, orient=UP, atype="hull", show_stats=false, _mb_origin=undef) { + vnf = isosurface(f, isovalue, voxel_size, bounding_box, reverse, closed, show_stats, _mb_origin); + vnf_polyhedron(vnf, convexity=convexity, cp=cp, anchor=anchor, spin=spin, orient=orient, atype=atype) + children(); } -function isosurface_array(voxel_size, isovalue, fields, origin=[0,0,0], reverse=false, close_clip=true, show_stats=false) = - assert(all_defined([voxel_size, fields, isovalue]), "The parameters voxel_size, fields, and isovalue must all be defined.") + +function isosurface(f, isovalue, voxel_size, bounding_box, reverse=false, closed=true, show_stats=false, _mb_origin=undef) = + assert(all_defined([f, isovalue, voxel_size]), "\nThe parameters f, isovalue, and bounding_box must all be defined.") + assert((is_function(f) && is_def(bounding_box)) || (is_list(f) && is_undef(bounding_box)), + "\nbounding_box must be passed if f is a function, and cannot be passed if f is an array.") let( isovalmin = is_list(isovalue) ? isovalue[0] : isovalue, isovalmax = is_list(isovalue) ? isovalue[1] : INF, - bbox = let( - nx = len(fields)-1, - ny = len(fields[0])-1, - nz = len(fields[0][0])-1 - ) [origin, origin+[nx*voxel_size, ny*voxel_size, nz*voxel_size]], - cubes = _isosurface_cubes(voxel_size, bbox, fieldarray=fields, isovalmin=isovalmin, isovalmax=isovalmax, close_clip=close_clip), + dum1 = assert(isovalmin < isovalmax, str("\nBad isovalue range (", isovalmin, ", >= ", isovalmax, "), should be expressed as [min_value, max_value].")), + hv = 0.5*voxel_size, + bbox = is_function(f) + ? let( // new bounding box quantized for voxel_size, centered around original box + bbcenter = mean(bounding_box), + bbn = v_ceil((bounding_box[1]-bounding_box[0]) / voxel_size) + ) [bbcenter - hv*bbn, bbcenter + hv*bbn] + : let( // new bounding box, either centered on origin or using metaball origin + dims = list_shape(f) - [1,1,1] + ) is_def(_mb_origin) + ? [_mb_origin, _mb_origin+voxel_size*dims] // metaball bounding box + : [-hv*dims, hv*dims], // centered bounding box + cubes = _isosurface_cubes(voxel_size, bbox, + fieldarray=is_function(f)?undef:f, fieldfunc=is_function(f)?f:undef, + isovalmin=isovalmin, isovalmax=isovalmax, closed=closed), tritablemin = reverse ? _MCTriangleTable_reverse : _MCTriangleTable, tritablemax = reverse ? _MCTriangleTable : _MCTriangleTable_reverse, trianglepoints = _isosurface_triangles(cubes, voxel_size, isovalmin, isovalmax, tritablemin, tritablemax), faces = [ for(i=[0:3:len(trianglepoints)-1]) [i,i+1,i+2] ], - dummy = show_stats ? _showstats(voxel_size, bbox, isovalmin, cubes, faces) : 0 + dum2 = show_stats ? _showstats(voxel_size, bbox, isovalmin, cubes, faces) : 0 ) [trianglepoints, faces]; - - -/// isosurface_cubes() - private function, called by isosurface() -/// This implements a marching cube algorithm, sacrificing some memory in favor of speed. -/// Return a list of voxel cube structures that have one or both surfaces isovalmin or isovalmax intersecting them, and cubes inside the isosurface volume that are at the bounds of the bounding box. -/// The cube structure is: -/// [cubecoord, cubeindex_isomin, cubeindex_isomax, field, bfaces] -/// where -/// cubecoord is the [x,y,z] coordinate of the front left bottom corner of the voxel, -/// cubeindex_isomin and cubeindex_isomax are the index IDs of the voxel corresponding to the min and max iso surface intersections -/// cf is vector containing the 6 field strength values at each corner of the voxel cube -/// bfaces is an array of faces corresponding to the sides of the bounding box - this is empty most of the time; it has data only where the isosurface is clipped by the bounding box. -/// The bounding box 'bbox' is expected to be quantized for the voxel size already. - -function _isosurface_cubes(voxsize, bbox, fieldarray, fieldfunc, additional, isovalmin, isovalmax, close_clip=true) = let( - // get field intensities - fields = is_def(fieldarray) - ? fieldarray - : let(v = bbox[0], hv = 0.5*voxsize, b1 = bbox[1]+[hv,hv,hv]) [ - for(x=[v[0]:voxsize:b1[0]]) [ - for(y=[v[1]:voxsize:b1[1]]) [ - for(z=[v[2]:voxsize:b1[2]]) - additional==undef - ? fieldfunc([x,y,z]) - : fieldfunc([x,y,z], additional) - ] - ] - ], - nx = len(fields)-2, - ny = len(fields[0])-2, - nz = len(fields[0][0])-2, - v0 = bbox[0] -) [ - for(i=[0:nx]) let(x=v0[0]+voxsize*i) - for(j=[0:ny]) let(y=v0[1]+voxsize*j) - for(k=[0:nz]) let(z=v0[2]+voxsize*k) - let(i1=i+1, j1=j+1, k1=k+1, - cf = [ - fields[i][j][k], - fields[i][j][k1], - fields[i][j1][k], - fields[i][j1][k1], - fields[i1][j][k], - fields[i1][j][k1], - fields[i1][j1][k], - fields[i1][j1][k1] - ], - mincf = min(cf), - maxcf = max(cf), - cubecoord = [x,y,z], - bfaces = close_clip ? _bbox_faces(cubecoord, voxsize, bbox) : [], - cubefound_isomin = (mincf<=isovalmin && isovalmin isoval ? 1 : 0) + - (f[1] > isoval ? 2 : 0) + - (f[2] > isoval ? 4 : 0) + - (f[3] > isoval ? 8 : 0) + - (f[4] > isoval ? 16 : 0) + - (f[5] > isoval ? 32 : 0) + - (f[6] > isoval ? 64 : 0) + - (f[7] > isoval ? 128 : 0); - - -/// _isosurface_trangles() - called by isosurface() -/// Given a list of voxel cubes structures, triangulate the isosurface(s) that intersect each cube and return a list of triangle vertices. -function _isosurface_triangles(cubelist, cubesize, isovalmin, isovalmax, tritablemin, tritablemax) = [ - for(cl=cubelist) let( - v = cl[0], - cbidxmin = cl[1], - cbidxmax = cl[2], - f = cl[3], - bbfaces = cl[4], - vcube = [ - v, v+[0,0,cubesize], v+[0,cubesize,0], v+[0,cubesize,cubesize], - v+[cubesize,0,0], v+[cubesize,0,cubesize], - v+[cubesize,cubesize,0], v+[cubesize,cubesize,cubesize] - ], - epathmin = tritablemin[cbidxmin], - epathmax = tritablemax[cbidxmax], - lenmin = len(epathmin), - lenmax = len(epathmax), - outfacevertices = flatten([ - for(bf = bbfaces) - _bbfacevertices(vcube, f, bf, isovalmax, isovalmin) - ]), - n_outer = len(outfacevertices) - ) - // bunch of repeated code here in an attempt to gain some speed to avoid function calls and calls to flatten(). - // Where the face of the bounding box clips a voxel, those are done in separate if() blocks and require require a concat(), but the majority of voxels can have triangles generated directly. If there is no clipping, the list of trianges is generated all at once. - if(lenmin>0 && lenmax>0) let( - // both min and max surfaces intersect a voxel clipped by bounding box - list = concat( - // min surface - [ for(ei=epathmin) let( - edge = _MCEdgeVertexIndices[ei], - vi0 = edge[0], - vi1 = edge[1], - denom = f[vi1] - f[vi0], - u = abs(denom)<0.0001 ? 0.5 : (isovalmin-f[vi0]) / denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) ], - // max surface - [ for(ei=epathmax) let( - edge = _MCEdgeVertexIndices[ei], - vi0 = edge[0], - vi1 = edge[1], - denom = f[vi1] - f[vi0], - u = abs(denom)<0.0001 ? 0.5 : (isovalmax-f[vi0]) / denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) ], outfacevertices) - ) for(ls = list) ls - else if(n_outer>0 && lenmin>0) let( - // only min surface intersects a voxel clipped by bounding box - list = concat( - [ for(ei=epathmin) let( - edge = _MCEdgeVertexIndices[ei], - vi0 = edge[0], - vi1 = edge[1], - denom = f[vi1] - f[vi0], - u = abs(denom)<0.0001 ? 0.5 : (isovalmin-f[vi0]) / denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) ], outfacevertices) - ) for(ls = list) ls - else if(lenmin>0) - // only min surface intersects a voxel - for(ei=epathmin) let( - edge = _MCEdgeVertexIndices[ei], - vi0 = edge[0], - vi1 = edge[1], - denom = f[vi1] - f[vi0], - u = abs(denom)<0.0001 ? 0.5 : (isovalmin-f[vi0]) / denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) - else if(n_outer>0 && lenmax>0) let( - // only max surface intersects the voxel on the bounding box - list = concat( - [ for(ei=epathmax) let( - edge = _MCEdgeVertexIndices[ei], - vi0 = edge[0], - vi1 = edge[1], - denom = f[vi1] - f[vi0], - u = abs(denom)<0.0001 ? 0.5 : (isovalmax-f[vi0]) / denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) ], outfacevertices) - ) for(ls = list) ls - else if(lenmax>0) - // only max surface intersects the voxel - for(ei=epathmax) let( - edge = _MCEdgeVertexIndices[ei], - vi0 = edge[0], - vi1 = edge[1], - denom = f[vi1] - f[vi0], - u = abs(denom)<0.0001 ? 0.5 : (isovalmax-f[vi0]) / denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) - else if(n_outer>0) - // no surface intersects a voxel clipped by bounding box but the bounding box at this voxel is inside the volume between isomin and isomax - for(ls = outfacevertices) ls -]; - - -/// Generate triangles for voxel faces clipped by the bounding box -function _bbfacevertices(vcube, f, bbface, isovalmax, isovalmin) = let( - vi = _MCFaceVertexIndices[bbface], - vfc = [ for(i=vi) vcube[i] ], - fld = [ for(i=vi) f[i] ], - pgon = flatten([ - for(i=[0:3]) let( - vi0=vi[i], - vi1=vi[(i+1)%4], - f0 = f[vi0], - f1 = f[vi1], - lowhiorder = (f0=f1) let( - u = abs(denom)<0.0001 ? 0.5 : (isovalmax-f0)/denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]), - if(fbetweenlow && f0>=f1) let( - u = abs(denom)<0.0001 ? 0.5 : (isovalmin-f0)/denom - ) vcube[vi0] + u*(vcube[vi1]-vcube[vi0]) - - ] - ]), - npgon = len(pgon), - triangles = npgon==0 ? [] : [ - for(i=[1:len(pgon)-2]) [pgon[0], pgon[i], pgon[i+1]] - ]) flatten(triangles); - - -/// _showstats() (Private function) - called by isosurface() and isosurface_array() -/// Display statistics about isosurface -function _showstats(voxelsize, bbox, isoval, cubes, faces) = let( - v = column(cubes, 0), // extract cube vertices - x = column(v,0), // extract x values - y = column(v,1), // extract y values - z = column(v,2), // extract z values - xmin = min(x), - xmax = max(x)+voxelsize, - ymin = min(y), - ymax = max(y)+voxelsize, - zmin = min(z), - zmax = max(z)+voxelsize, - ntri = len(faces), - nvox = len(cubes) -) echo(str("\nIsosurface statistics:\n Outer isovalue = ", isoval, "\n Voxel size = ", voxelsize, - "\n Voxels found containing surface = ", nvox, "\n Triangles = ", ntri, - "\n Bounding box for all data = ", bbox, - "\n Bounding box for isosurface = ", [[xmin,ymin,zmin], [xmax,ymax,zmax]], - "\n")) 0; - - -/// ---------- metaball stuff starts here, uses isosurface_array() above ---------- - -/// metaball function literal indices - -MB_SPHERE=0; -MB_ELLIPSOID=1; -MB_ROUNDCUBE=2; -MB_CUBE=3; -MB_OCTAHEDRON=4; -MB_TORUS=5; -MB_CUSTOM=6; - -/// Built-in metaball functions corresponding to each MB_ index. -/// Each function takes three parameters: -/// cdist = cartesian distance, a vector [dx,dy,dz] being the distances from the ball center to the volume sample point -/// charge = the charge of the metaball, can be a vector if the charges are different on each axis. -/// additional (named whatever's convenient) = additional value or array of values needed by the function. -/// rcutoff = radial cutoff; effect suppression increases with distance until zero at the rcutoff distance, and is zero from that point farther out. Default: INF - -_metaball_sphere = function (cdist, charge, unused, rotm, rcutoff) -let( - r = norm(cdist), - suppress = let(a=min(r,rcutoff)/rcutoff) 1-a*a -) r==0 ? 10000*charge : suppress*charge / r; - -_metaball_ellipsoid = function (cdist, charge, unused, rotm, rcutoff) -let( - dist = concat(cdist,1) * rotm, - r = norm([dist[0]/charge[0], dist[1]/charge[1], dist[2]/charge[2]]), - suppress = let(a=min(r,rcutoff)/rcutoff) 1-a*a, - sgn = sign(charge[0]*charge[1]*charge[2]) -) r==0 ? 10000*sgn*max(abs(charge[0]), abs(charge[1]), abs(charge[2])) - : suppress*sgn / r; - -_metaball_roundcube = function (cdist, charge, exponent, rotm, rcutoff) -let( - dist = concat(cdist,1) * rotm, - r = abs(dist[0])^exponent + abs(dist[1])^exponent + abs(dist[2])^exponent, - suppress = let(a=min(r,rcutoff)/rcutoff) 1-a*a -) r==0 ? 10000*charge : suppress*sign(charge)*abs(charge)^exponent / r; - -_metaball_cube = function (cdist, charge, unused, rotm, rcutoff) -let( - dist = concat(cdist,1) * rotm, - r = max(abs(dist[0]), abs(dist[1]), abs(dist[2])), - suppress = let(a=min(r,rcutoff)/rcutoff) 1-a*a -) r==0 ? 10000*charge : suppress*sign(charge)*abs(charge) / r; - -_metaball_octahedron = function (cdist, charge, unused, rotm, rcutoff) -let( - dist = concat(cdist,1) * rotm, - r = abs(dist[0]) + abs(dist[1]) + abs(dist[2]), - suppress = let(a=min(r,rcutoff)/rcutoff) 1-a*a -) r==0 ? 10000*charge : suppress*sign(charge)*abs(charge) / r; - -_metaball_torus = function (cdist, charge, axis, rotm, rcutoff) -let( - tmp = concat(cdist,1) * rotm, - dist = [tmp[0], tmp[1], tmp[2]], - bigdia = abs(charge[0]), - smalldia = charge[1], - d_axisplane = norm(v_mul([1,1,1]-axis, dist)) - bigdia, - d_axis = axis*dist, - r = norm([d_axisplane, d_axis]), - suppress = let(a=min(r,rcutoff)/rcutoff) 1-a*a -) r==0 ? 1000*max(charge) : suppress*sign(charge[0])*smalldia / r; - - -/// metaball field function, calling any of the other metaball functions above to accumulate -/// the contribution of each metaball at point xyz -_metaball_fieldfunc = function(xyz, nballs, ball_centers, charges, ball_type, rotmatrix, additional, rcutoff, funcs) -let( - contrib = [ - for(i=[0:nballs-1]) let( - dist = xyz-ball_centers[i], - func = ball_type[i]==MB_CUSTOM ? funcs[MB_CUSTOM][i] : funcs[ball_type[i]] - ) func(dist, charges[i], additional[i], rotmatrix[i], rcutoff[i]) - ] -) sum(contrib); - - -// Function&Module: metaballs() -// Synopsis: Creates a model of metaballs within a bounding box. -// SynTags: Geom,VNF -// Topics: Metaballs, Isosurfaces, VNF Generators -// See Also: isosurface_array() -// Usage: As a module -// metaballs(voxel_size, bounding_box, isovalue, ball_centers, [ball_sizes=], [ball_type=], [rotation=], [field_function=], [radial_cutoff=], [close_clip=], [show_stats=]); -// Usage: As a function -// vnf = metaballs(voxel_size, bounding_box, isovalue, ball_centers, [ball_sizes=], [ball_type=], [rotation=], [field_function=], [radial_cutoff=], [close_clip=], [show_stats=]); -// Description: -// [Metaballs](https://en.wikipedia.org/wiki/Metaballs), also known as "blobby objects", -// are organic-looking ball-shaped blobs that meld together when in close proximity. -// The melding property is determined by an interaction formula based on the "charge" of -// each ball and their distance from one another. If you consider a "ball" to be a point -// charge in 3D space, the electric field surrounding that charge decreases in intensity -// with distance from the charge. The metaball is the isosurface corresponding to all value -// where the electric field intensity is a constant value. -// A stronger charge results in a stronger the electric field, and correspondingly a -// larger metaball. Fields from two charges add together, changing the shape of the two -// corresponding metaballs when they are in close proximity. -// . -// In physics, the electric field intensity falls off as an inverse-square relationship -// with distance; that is, the field is proportional to $1/r^2$ where $r$ is the radial -// distance from the point charge. However, most implementations of metaballs instead use -// a simple inverse relationship proportional to $1/r$. That is true for the field -// types available here, or you can define your own falloff function as the -// `field_function` parameter. -// . -// Six shapes of fields around each metaball center are possible. You can specify -// different types for each metaball in the list, and you can also specify your own -// custom field equation. The five types are: -// * `MB_SPHERE` - the standard spherical metaball with a 1/r field strength falloff. -// * `MB_ELLIPSOID` - an ellipsoid-shaped field that requires specifying a [x,y,z] vector for the charge, representing field strength in each of the x, y, and z directions -// * `MB_ROUNDCUBE` - a cube-shaped metaball with corners that get more rounded with size. The squareness can be controlled with a value between 0 (spherical) or 1 (cubical) in the `additional` parameter, and defaults to 0.5 if omitted. -// * `MB_CUBE` - a cube-shaped metaball with sharp edges and corners, resulting from using [Chebyshev distance](https://en.wikipedia.org/wiki/Chebyshev_distance) rather than Euclidean distance calculations. -// * `MB_OCTAHEDRON` - an octahedron-shaped metaball with sharp edges and corners, resulting from using [taxicab distance](https://en.wikipedia.org/wiki/Taxicab_geometry) rather than Euclidean distance calculations. -// * `MB_TORUS` - a toroidal field oriented perpendicular to the x, y, or z axis. The `charge` is a two-element vector determining the major and minor diameters, and the `additional` paramater sets the axis directions for each ball center (defaults to [0,0,1] if not set). -// * `MB_CUSTOM` - your own custom field definition, requiring you to set the `field_function` parameter to your own function literal. -// If either `MB_ELLIPSOID` or `MB_TORUS` occur in the list, the list of charges **must** be explicitly defined rather than supplying a single value for all. -// Arguments: -// voxel_size = The size (scalar) of the voxel cube that determines the resolution of the metaball surface. -// bounding_box = A pair of 3D points `[[xmin,ymin,zmin], [xmax,ymax,zmax]]`, specifying the minimum and maximum box corner coordinates. The voxels needn't fit perfectly inside the bounding box. -// isovalue = A scalar value specifying the isosurface value of the metaballs. -// ball_centers = an array of 3D points specifying each of the metaball centers. -// --- -// charge = a single value, or an array of values corresponding to `ball_centers`, specifying the charge intensity of each ball center. Default: 10 -// ball_type = shape of field that falls off from the metaball center. Can be one of `MB_SPHERE`, `MB_ELLIPSOID`, `MB_ROUNDCUBE`, `MB_CUBE`, `MB_OCTAHEDRON`, `MB_TORUS`, or `MB_CUSTOM`. This may be an array of values corresponding to each ball. Where this value is `MB_CUSTOM`, the corresponding array element in `field_function` must also be set. Default: `_MB_SPHERE` -// rotation = A vector `[x_rotation, y_rotation, z_rotation]`, or list of vectors for each ball, specifying the rotation angle in degrees around the x, y, and z axes. This is meaningless for `_MB_SPHERE` but allows you to orient the other metaball types. Default: undef -// field_function = A single [function literal](https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/User-Defined_Functions_and_Modules#Function_literals) or array of function literals that return a single field value from one metaball, and takes as inputs a 3D distance vector, a single charge or list of charges, and a single additional parameter or list of parameters (that third parameter must exist in the function definition even if it isn't used). If the corresponding `ball_type` parameter is not `MB_CUSTOM`, then the function specified in `ball_type` is used instead; only where `ball_type` is `MB_CUSTOM` does this custom field function get invoked. Default: undef -// additional = A single value, or a list of optional additional parameters that may be required by the field function. If you make a custom function, it is your responsibility to create a function literal compatible with these inputs. Nothing is passed to the function literal if `additional` is not set. This parameter must be specified as an entire list for all metaballs if MB_ELLIPSOID or MB_TORUS is included in `ball_type`. Default: `undef` for `ball_type=CUSTOM` -// radial_cutoff = Maximum radial distance of a metaball's influence. This isn't a sharp cutoff; rather, the suppression increases with distance until the influence is zero at the `radial_cutoff` distance. Can be a single value or an array of values corresponding to each ball center, but typically it's sufficient to supply a single value approximately the average separation of each ball, so each ball mostly acts on its nearest neighbors. Default: INF -// close_clip = When true, maintains a manifold surface where the bounding box clips it (there is a negligible speed penalty in doing this). When false, the bounding box clips the surface, exposing the back sides of facets. Setting this to false can be useful with OpenSCAD's "View > Thrown together" menu option to distinguish inside from outside. Default: true -// show_stats = If true, display statistics about the metaball isosurface in the console window. Besides the number of voxels found to contain the surface, and the number of triangles making up the surface, this is useful for getting information about a smaller bounding box possible, to improve speed for subsequent renders. Enabling this parameter has a speed penalty. Default: false -// Example(3D,NoAxes): A group of five spherical metaballs with different charges. The parameter `show_stats=true` (not shown here) was used to find a compact bounding box for this figure. -// centers = [[-20,-20,-20], [-0,-20,-20], -// [0,0,0], [0,0,20], [20,20,10] ]; -// charges = [5, 4, 3, 5, 7]; -// type = MB_SPHERE; -// isovalue = 1; -// voxelsize = 1.5; -// boundingbox = [[-30,-31,-31], [32,31,31]]; -// metaballs(voxelsize, boundingbox, isovalue=isovalue, -// ball_centers=centers, charge=charges, ball_type=type); -// Example(3D,NoAxes): A metaball can have negative charge. In this case we have two metaballs in close proximity, with the small negative metaball creating a dent in the large positive one. The positive metaball is shown transparent, and small spheres show the center of each metaball. The negative metaball isn't visible because its field is negative; the isosurface encloses only field values greater than the isovalue of 1. -// centers = [[-1,0,0], [1.25,0,0]]; -// charges = [8, -3]; -// type = MB_SPHERE; -// voxelsize = 0.25; -// isovalue = 1; -// boundingbox = [[-7,-6,-6], [3,6,6]]; -// -// #metaballs(voxelsize, boundingbox, isovalue=isovalue, -// ball_centers=centers, charge=charges, ball_type=type); -// color("green") for(c=centers) translate(c) sphere(d=1, $fn=16); -// Example(3D,NoAxes): A cube, a rounded cube, and an octahedron interacting. -// centers = [[-7,-3,27], [7,5,21], [10,0,10]]; -// charge = 5; -// type = [MB_CUBE, MB_ROUNDCUBE, MB_OCTAHEDRON]; -// voxelsize = 0.4; // a bit slow at this resolution -// isovalue = 1; -// boundingbox = [[-13,-9,3], [16,11,33]]; -// -// metaballs(voxelsize, boundingbox, isovalue=isovalue, -// ball_centers=centers, charge=charge, ball_type=type); -// Example(3D,NoAxes): Interaction between two torus-shaped fields in different orientations. -// centers = [[-10,0,17], [7,6,21]]; -// charges = [[6,2], [7,3]]; -// type = MB_TORUS; -// axis_orient = [[0,0,1], [0,1,0]]; -// voxelsize = 0.5; -// isovalue = 1; -// boundingbox = [[-19,-9,9], [18,10,32]]; -// -// metaballs(voxelsize, boundingbox, isovalue=isovalue, -// ball_centers=centers, charge=charges, ball_type=type, -// additional=axis_orient); -// Example(3D): Demonstration of a custom metaball function, in this case a sphere with some random noise added to its electric field. -// noisy_sphere = function (cdist, charge, additional, -// rotation_matrix_unused, rcutoff=INF) -// let( -// r = norm(cdist) + rands(0, 0.2, 1)[0], -// suppress = let(a=min(r,rcutoff)/rcutoff) 1-a*a -// ) r==0 ? 1000*charge : suppress*charge / r; -// -// centers = [[-9,0,0], [9,0,0]]; -// charge = 5; -// type = [MB_SPHERE, MB_CUSTOM]; -// fieldfuncs = [undef, noisy_sphere]; -// voxelsize = 0.4; -// boundingbox = [[-16,-8,-8], [16,8,8]]; -// -// metaballs(voxelsize, boundingbox, isovalue=1, -// ball_centers=centers, charge=charge, ball_type=type, -// field_function=fieldfuncs); -// Example(3D,Med,NoAxes,VPR=[55,0,0],VPD=200,VPT=[7,2,2]): A complex example using ellipsoids, spheres, and a torus to make a tetrahedral object with rounded feet and a ring on top. The bottoms of the feet are flattened by limiting the minimum z value of the bounding box. The center of the object is thick due to the contributions of four ellipsoids converging. Designing an object like this using metaballs requires trial and error with low-resolution renders. -// ztheta = 90-acos(-1/3); -// cz = cos(ztheta); -// sz = sin(ztheta); -// type = [ -// MB_ELLIPSOID, MB_ELLIPSOID, -// MB_ELLIPSOID, MB_ELLIPSOID, -// MB_TORUS, MB_SPHERE, MB_SPHERE, MB_SPHERE -// ]; -// centers = [ -// [0,0,20], [20*cz,0,20*sz], -// zrot(120, p=[20*cz,0,20*sz]), -// zrot(-120, p=[20*cz,0,20*sz]), -// [0,0,35], [32*cz,0,32*sz], -// zrot(120, p=[32*cz,0,32*sz]), -// zrot(-120, p=[32*cz,0,32*sz])]; -// cutoff = 40; // extent of influence of each ball -// rotation = [ -// [0,90,0], [0,-ztheta,0], [0,-ztheta,120], [0,-ztheta,-120], -// [0,0,0], undef, undef, undef]; -// axis = [ -// undef, undef, undef, undef, -// [0,1,0], undef, undef, undef -// ]; -// charge = [ -// [6,2,2], [7,2,2], [7,2,2], [7,2,2], -// [8,2], 5, 5, 5 -// ]; -// -// voxelsize = 1; -// isovalue = 1; -// boundingbox = [[-23,-36,-15], [39,36,46]]; -// -// // useful to save as VNF for copies and manipulations -// vnf = metaballs(voxelsize, boundingbox, isovalue=isovalue, ball_centers=centers, -// charge=charge, ball_type=type, additional=axis, rotation=rotation, -// radial_cutoff=cutoff); -// vnf_polyhedron(vnf); - -module metaballs(voxel_size, bounding_box, isovalue, ball_centers, charge=10, ball_type=MB_SPHERE, rotation=undef, field_function=undef, additional=undef, radial_cutoff=INF, close_clip=true, show_stats=false) { - vnf = metaballs(voxel_size, bounding_box, isovalue, ball_centers, charge, ball_type, rotation, field_function, additional, radial_cutoff, close_clip, show_stats); - vnf_polyhedron(vnf); -} - -function metaballs(voxel_size, bounding_box, isovalue, ball_centers, charge=10, ball_type=MB_SPHERE, rotation=undef, field_function=undef, additional=undef, radial_cutoff=INF, close_clip=true, show_stats=false) = let( - isoval = is_vector(isovalue) ? isovalue[0] : isovalue, - nballs = len(ball_centers), - chg = is_list(charge) ? charge : repeat(charge, nballs), - interact = is_list(ball_type) ? ball_type : repeat(ball_type, nballs), - rotations = is_list(rotation) ? rotation : repeat(rotation, nballs), - fieldfuncs = is_list(field_function) ? field_function : repeat(field_function, nballs), - addl0 = is_list(additional) ? additional : repeat(additional, nballs), - rlimit = is_list(radial_cutoff) ? radial_cutoff : repeat(radial_cutoff, nballs) -) - assert(all_defined([voxel_size, bounding_box, isovalue, ball_centers]), "\nThe parameters voxel_size, bounding_box, isovalue, and ball centers must all be defined.") - assert(is_list(ball_centers), "\nball_centers must be a list of [x,y,z] coordinates; for a single value use [[x,y,z]].") - assert(len(chg)==nballs, "\nThe list of charges must be equal in length to the list of ball_centers.") - assert(len(interact)==nballs, "\nThe list of ball_types must be equal in length to the list of ball centers.") - assert(len(rotations)==nballs, "\nThe list of rotation vectors must be equal in length to the list of ball centers.") - assert(len(fieldfuncs)==nballs, "\nThe list of field_functions must be equal in length to the list of ball centers.") - assert(len(addl0)==nballs, "\nThe list of additional field function parameters must be equal in length to the list of ball centers.") - assert(len(rlimit)==nballs, "\nThe radial_cutoff list must be equal in length to the list of ball_centers.") -let( - dum_align = _metaball_errchecks(nballs, interact, chg, addl0, fieldfuncs), - - // change MB_ROUNDCUBE squareness to exponents - addl = [ - for(i=[0:nballs-1]) - if (interact[i]==MB_ROUNDCUBE) - _squircle_se_exponent(addl0[i]==undef ? 0.5 : addl0[i]) - else if (interact[i]==MB_TORUS) - addl0[i]==undef ? [0,0,1] : addl0[i] - else - addl0[i] - ], - - // set up rotation matrices in advance - rotmatrix = [ - for(i=[0:nballs-1]) - rotations[i]==undef ? rot([0,0,0]) : rot(rotations[i]) - ], - - //set up function call array - funcs = [ - _metaball_sphere, //MB_SPHERE - _metaball_ellipsoid, //MB_ELLIPSOID - _metaball_roundcube, //MB_ROUNDCUBE - _metaball_cube, //MB_CUBE - _metaball_octahedron, //MB_OCTAHEDRON - _metaball_torus, //MB_TORUS - fieldfuncs //MB_CUSTOM - ], - - // set up field array - v0 = bounding_box[0], - b1 = bounding_box[1], - halfvox = 0.5*voxel_size, - fieldarray = [ - for(x=[v0[0]:voxel_size:b1[0]+halfvox]) [ - for(y=[v0[1]:voxel_size:b1[1]+halfvox]) [ - for(z=[v0[2]:voxel_size:b1[2]+halfvox]) - _metaball_fieldfunc([x,y,z], nballs, ball_centers, chg, interact, rotmatrix, addl, rlimit, funcs) - ] - ] - ] -) isosurface_array(voxel_size, isovalue, fieldarray, origin=v0, close_clip=close_clip, show_stats=show_stats); - - -function _metaball_errchecks(nballs, interact, charge, addl0, fieldfuncs) = [ -for(i=[0:nballs-1]) let( - dumm0 = assert(interact[i] != MB_ELLIPSOID || (interact[i]==MB_ELLIPSOID && is_vector(charge[i]) && len(charge[i])==3), "\nThe MB_ELLIPSOID charge value must be a vector of three numbers.") 0, - dumm1 = assert(interact[i] != MB_ROUNDCUBE || (interact[i]==MB_ROUNDCUBE && (is_undef(addl0[i]) || (is_num(addl0[i]) && 0<=addl0[i] && addl0[i]<=1))), "\nFor MB_ROUNDCUBE, additional parameter must be undef or a single number between 0.0 and 1.0.") 0, - dumm2 = assert(interact[i] != MB_TORUS || (interact[i]==MB_TORUS && is_vector(charge[i]) && len(charge[i])==2), "\nThe MB_TORUS charge value must be a vector of two numbers representing major and minor charges.") 0, - dumm4 = assert(interact[i] != MB_TORUS || (interact[i]==MB_TORUS && (addl0[i]==undef || (norm(addl0[i])==1 && sum(addl0[i])==1))), str("\nMB_TORUS ", i, " additional parameters (", addl0[i], ") must be a unit vector in the x, y, or z direction only.")) 0, - dumm5 = assert(interact[i] != MB_CUSTOM || (interact[i]==MB_CUSTOM && is_def(fieldfuncs[i])), "\nThe MB_CUSTOM ball_type requires a field_function to be defined.") 0 - ) 0 -];