grey/BOSL2
1
0
Fork 0
mirror of https://github.com/BelfrySCAD/BOSL2.git synced 2024-12-29 16:29:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document texture inset/gap arguments and fix textures for consistent

Browse source 
use of inset argument.
This commit is contained in:
Adrian Mariano 2023-02-04 12:36:53 -05:00
parent bf7218d56f
commit 29dec56cd2
1 changed files with 111 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

159
skin.scad
View file

@ -2659,34 +2659,35 @@ function associate_vertices(polygons, split, curpoly=0) =
// Topics: Textures, Knurling // Topics: Textures, Knurling
// Description: // Description:
// Given a texture name, returns a texture. Textures can come in two varieties: // Given a texture name, returns a texture. Textures can come in two varieties:
// - Heightfield textures which are 2D arrays of scalars. These are faster to render, but are less precise and prone to triangulation errors. // - Heightfield textures which are 2D arrays of scalars. These are usually faster to render, but can be less precise and prone to triangulation errors. The table below gives the recommended style for the best triangulation. If results are still incorrect, switch to the similar VNF tile by adding the "_vnf" suffix.
// - VNF Tile textures, which are VNFs that completely tile the rectangle `[0,0]` to `[1,1]`. These tend to be slower to render, but are more precise. // - VNF Tile textures, which are VNFs that cover the unit square [0,0] x [1,1]. These tend to be slower to render, but allow greater flexibility and precision for shapes that don't align with a grid.
// Sometimes the geometry of a shape to be textured will cause a heightfield texture to be badly triangulated. The table below gives the recommended // In the descriptions below, imagine the textures positioned on the XY plane, so "horizontal" refers to the "sideways" dimensions of the texture and
// style for the best triangulation of height field textures, but if results are still incorrect, switch to the similar VNF tile by adding the "_vnf" suffix // "up" and "down" refer to the depth dimension. If a texture is placed on a cylinder the "depth" will become the radial direction and the "horizontal"
// to the texture name. // direction will be the vertical and tangential directions on the cylindrical surface. All horizontal dimensions for VNF textures are relative to the unit square
// on which the textures are defined, so a value of 0.25 for a gap or inset will refer to 1/4 of the texture's full length and width.
// Texture Values: // Texture Values:
// "bricks" = Heightfield = A brick-wall pattern. Giving `n=` sets the number of heightfield samples to `n` by `n`. Giving `roughness=` adds a level of height randomization to add roughness to the texture. Use `style="convex"`. // "bricks" = Heightfield = A brick-wall pattern. Giving `n=` sets the number of heightfield samples to `n x n`. Default: 24. Giving `roughness=` adds a level of height randomization to add roughness to the texture. Use `style="convex"`.
// "bricks_vnf" = VNF Tile = Like "bricks", but slower and more consistent in triangulation. Giving `gap=` sets the mortar gap between bricks. Giving `inset=` specifies the inset of the brick tops, relative to their bottoms. // "bricks_vnf" = VNF Tile = VNF version of "bricks". Giving `gap=` sets the mortar gap between bricks at the bottom, default 0.05. Giving `inset=` specifies that the top face of the brick is smaller than the bottom of the brick by `inset` on each of the four sides. If `gap` is zero then `inset` close to 0.5 will cause bricks to come to a sharp pointed edge, with just a tiny flat top surface. Note that `gap+inset` must be strictly smaller than 0.5. Default is `inset=0.05`.
// "checkers" = VNF Tile = A pattern of alternating checkerboard squares. Giving `inset=` specifies the inset of the raised checker tile tops, relative to the lowered tiles. // "checkers" = VNF Tile = A pattern of alternating checkerboard squares. Giving `inset=` specifies that the top face of the checker surface is smaller than the bottom by `inset` on each of the four sides. As `inset` approaches 0.5 the tops come to sharp corners. You must set `inset` strictly between 0 and 0.5. Default: 0.05.
// "cones" = VNF Tile = Raised conical spikes. Giving `n=` sets the number of sides to the cone. Giving `inset=` specifies the inset of the base of the cone, relative to the tile edges. // "cones" = VNF Tile = Raised conical spikes. Giving `n=` sets `$fn` for the cone (will be rounded to a multiple of 4). Default: 16. Giving `inset=` specifies the horizontal inset of the base of the cone, relative to the tile edges. The `inset` value must be nonnegative and smaller than 0.5. Default: 0.
// "cubes" = VNF Tile = Cornercubes texture. // "cubes" = VNF Tile = Cornercubes texture.
// "diamonds" = Heightfield = Diamond shapes with tips aligned with the axes. Useful for knurling. Giving `n=` sets the number of heightfield samples to `n` by `n`. Use `style="concave"` for pointed bumps, or `style="default"` or `style="alt"` for diagonal ribs. // "diamonds" = Heightfield = Four-sided pyramid with the corners of the base aligned aligned with the axes. Compare to "pyramids". Useful for knurling. Giving `n=` sets the number of heightfield samples to `n x n`. Default: 2. Use `style="concave"` for pointed bumps, or `style="default"` or `style="alt"` for a diagonal ribs.
// "diamonds_vnf" = VNF Tile = Like "diamonds", but slower and more consistent in triangulation. // "diamonds_vnf" = VNF Tile = VNF version of "diamonds".
// "dimples" = VNF Tile = Small round divots. Giving `n=` sets the resolution of the divot curve. Giving `inset=` specifies the inset of the dimples, relative to the edge of the tile. // "dimples" = VNF Tile = Round divots. Giving `n=` sets `$fn` for the curve (will be rounded to a multiple of 4). Default: 16. Giving `inset=` specifies the horizontal distance of the flat region around the dimple relative to the edge of the tile. Default: 0.05.
// "dots" = VNF Tile = Raised small round bumps. Giving `n=` sets the resolution of the bump curve. Giving `inset=` specifies the inset of the dots, relative to the edge of the tile. // "dots" = VNF Tile = Raised round bumps. Giving `n=` sets `$fn` for the curve (will be rounded to a multiple of 4). Default: 16. Giving `inset=` specifies the horizontal inset of the dots, relative to the edge of the tile. Must be nonnegative and strictly less than 0.5. Default: 0.05.
// "hex_grid" = VNF Tile = A hexagonal grid of thin lines. Giving `inset=` specifies the inset of the hex tops, relative to their bottoms. // "hex_grid" = VNF Tile = A hexagonal grid defined by V-grove borders. Giving `inset=` specifies the X-direction horizontal inset of the hexagonal tops, relative to their bottoms. This means the V-groove top width for grooves running parallel to the Y axis will be double the inset value. If the texture is scaled in the Y direction by sqrt(3) then the groove will be uniform on all six sides of the hexagon. Inset must be strictly between 0 and 0.5, default: 0.1.
// "hills" = Heightfield = Wavy sine-wave hills and valleys, Giving `n=` sets the number of heightfield samples to `n` by `n`. Set `style="quincunx"`. // "hills" = Heightfield = Wavy sine-wave hills and valleys, Giving `n=` sets the number of heightfield samples to `n` x `n`. Default: 12. Set `style="quincunx"`.
// "pyramids" = Heightfield = Pyramids shapes with flat sides aligned with the axes. Also useful for knurling. Giving `n=` sets the number of heightfield samples to `n` by `n`. // "pyramids" = Heightfield = Four-sided pyramid with the edges of the base aligned with the axess. Compare to "diamonds". Useful for knurling. Giving `n=` sets the number of heightfield samples to `n` by `n`. Default: 2. Set style to "convex". Note that style="concave" or style="min_edge" produce mini-diamonds with flat squares in between.
// "pyramids_vnf" = VNF Tile = Like "pyramids", but slower and more consistent in triangulation. // "pyramids_vnf" = VNF Tile = VNF version of "pyramids".
// "ribs" = Heightfield = Vertically aligned triangular ribs. Giving `n=` sets the number of heightfield samples to `n` by `1`. The choice of style does not matter. // "ribs" = Heightfield = Vertically aligned triangular ribs. Giving `n=` sets the number of heightfield samples to `n` by 1. Default: 2. The choice of style does not matter.
// "rough" = Heightfield = A pseudo-randomized rough surace texture. Giving `n=` sets the number of heightfield samples to `n` by `n`. Giving `roughness=` adds a level of height randomization to add roughness to the texture. // "rough" = Heightfield = A pseudo-randomized rough texture. Giving `n=` sets the number of heightfield samples to `n` by `n`. Default: 32. The `roughness=` parameter specifies the height of the random texture. Default: 0.2.
// "tri_grid" = VNF Tile = A triangular grid of thin lines. Giving `inset=` specifies the inset of the triangle tops, relative to their bottoms. // "tri_grid" = VNF Tile = A triangular grid defined by V-groove borders Giving `inset=` specifies the horizontal inset of the triangular tops, relative to their bottoms, along all three sides. This means the V-groove top width will be double the inset value. Inset must be strictly between 0 and 0.5, default: 0.1.
// "trunc_diamonds" = VNF Tile = Truncated diamonds. A grid of thin lines at 45º angles. Giving `inset=` specifies the inset of the truncated diamond tops, relative to their bottoms. // "trunc_diamonds" = VNF Tile = Truncated diamonds, four-sided pyramids with the base corners aligned with the axes and the top cut off. Or you can interpret it as V-groove lines at 45º angles. Giving `inset=` specifies the horizontal inset of the square top face compared to the bottom face along all four edges. This means the V-groove top width will be double the inset value. The inset must be strictly between 0 and sqrt(2)/4, which is about 0.35. Default: 0.1.
// "trunc_pyramids" = Heightfield = Truncated pyramids. Like "pyramids" but with flattened tips. Giving `n=` sets the number of heightfield samples to `n` by `n`. Set `style="convex"`. // "trunc_pyramids" = Heightfield = Truncated pyramids, four sided pyramids with the base edges aligned to the axes and the top cut off. Giving `n=` sets the number of heightfield samples to `n` by `n`. Default: 6. Set `style="convex"`.
// "trunc_pyramids_vnf" = VNF Tile = Like "trunc_pyramids", but slower and more consistent in triangulation. Giving `inset=` specifies the inset of the truncated pyramid tops, relative to their bottoms. // "trunc_pyramids_vnf" = VNF Tile = Truncated pyramids, four sided pyramids with the base edges aligned to the axes and the top cut off. You can also regard this as a grid of V-grooves. Giving `inset=` specifies the horizontal inset of the flat square tops on all four sides relative to their bottoms. This means the V-groove top width will be double the inset value. The inset must be strictly between 0 and 0.5. Default: 0.1.
// "trunc_ribs" = Heightfield = Truncated ribs. Like "ribs" but with flat rib tips. Giving `n=` sets the number of heightfield samples to `n` by `1`. The style does not matter. // "trunc_ribs" = Heightfield = Truncated ribs. Vertically aligned triangular ribs with the tops cut off, and with rib separation equal to the width of the flat tops. Giving `n=` sets the number of heightfield samples to `n` by `1`. Default: 4. The style does not matter.
// "trunc_ribs_vnf" = VNF Tile = Like "trunc_ribs", but slower and more adjustable. Giving `gap=` sets the bottom gap between ribs. Giving `inset=` specifies the inset of the rib tops, relative to their bottoms. // "trunc_ribs_vnf" = VNF Tile = Vertically aligned triangular ribs with the tops cut off. Giving `gap=` sets the bottom gap between ribs. Giving `inset=` specifies the horizontal inset of the rib top face, relative to the bottom on both sides. In order to fit, gap+2*inset must be less than 1. (This is because the gap is counted once but the inset counts on both sides.) Defaults: gap=1/4, inset=1/4.
// "wave_ribs" = Heightfield = Vertically aligned wavy ribs. Giving `n=` sets the number of heightfield samples to `n` by `1`. The style does not matter. // "wave_ribs" = Heightfield = Vertically aligned wavy ribs. Giving `n=` sets the number of heightfield samples to `n` by `1`. Default: 8. The style does not matter.
// Arguments: // Arguments:
// tex = The name of the texture to get. // tex = The name of the texture to get.
// --- // ---
@ -2708,8 +2709,8 @@ function associate_vertices(polygons, split, curpoly=0) =
// tex_scale=3, tex_size=[10,10], // tex_scale=3, tex_size=[10,10],
// style="concave" // style="concave"
// ); // );
// Example(3D): "trunc_ribs_vnf" texture. Slower, but more controllable. // Example(3D): "trunc_ribs_vnf" texture.
// tex = texture("trunc_ribs_vnf", gap=0.25, inset=0.333); // tex = texture("trunc_ribs_vnf", gap=0.25, inset=1/6);
// linear_sweep( // linear_sweep(
// rect(50), h=40, texture=tex, // rect(50), h=40, texture=tex,
// tex_scale=3, tex_size=[10,10] // tex_scale=3, tex_size=[10,10]
@ -2726,19 +2727,37 @@ function associate_vertices(polygons, split, curpoly=0) =
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10], style="concave" // tex_size=[10,10], style="concave"
// ); // );
// Example(3D): "diamonds_vnf" texture. Slower, but more consistent around complex curves. // Example(3D): "diamonds" texture can give diagonal ribbing.
// tex = texture("diamonds");
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[10,10], style="default"
// );
// Example(3D): "diamonds" texture gives diagonal ribbing the other direction.
// tex = texture("diamonds");
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[10,10], style="alt"
// );
// Example(3D): "diamonds_vnf" texture.
// tex = texture("diamonds_vnf"); // tex = texture("diamonds_vnf");
// linear_sweep( // linear_sweep(
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10] // tex_size=[10,10]
// ); // );
// Example(3D): "pyramids" texture. // Example(3D): "pyramids" texture, with the style that produces the advertised pyramid shape.
// tex = texture("pyramids"); // tex = texture("pyramids");
// linear_sweep( // linear_sweep(
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10], style="convex" // tex_size=[10,10], style="convex"
// ); // );
// Example(3D): "pyramids_vnf" texture. Slower, but more consistent around complex curves. // Example(3D): "pyramids" texture, with "concave" produces a mini-diamon texture. Note that "min_edge" also gives this result.
// tex = texture("pyramids");
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[10,10], style="concave"
// );
// Example(3D): "pyramids_vnf" texture.
// tex = texture("pyramids_vnf"); // tex = texture("pyramids_vnf");
// linear_sweep( // linear_sweep(
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
@ -2750,12 +2769,18 @@ function associate_vertices(polygons, split, curpoly=0) =
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10], style="convex" // tex_size=[10,10], style="convex"
// ); // );
// Example(3D): "trunc_pyramids_vnf" texture. Slower, but more consistent around complex curves. // Example(3D): "trunc_pyramids_vnf" texture.
// tex = texture("trunc_pyramids_vnf"); // tex = texture("trunc_pyramids_vnf");
// linear_sweep( // linear_sweep(
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10] // tex_size=[10,10]
// ); // );
// Example(3D): "trunc_pyramids_vnf" texture with large inset
// tex = texture("trunc_pyramids_vnf", inset=.4);
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[10,10]
// );
// Example(3D): "hills" texture. // Example(3D): "hills" texture.
// tex = texture("hills"); // tex = texture("hills");
// linear_sweep( // linear_sweep(
@ -2786,6 +2811,12 @@ function associate_vertices(polygons, split, curpoly=0) =
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10] // tex_size=[10,10]
// ); // );
// Example(3D): "bricks" texture.
// tex = texture("bricks", inset=.25);
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[10,10]
// );
// Example(3D): "bricks_vnf" texture. // Example(3D): "bricks_vnf" texture.
// tex = texture("bricks_vnf"); // tex = texture("bricks_vnf");
// linear_sweep( // linear_sweep(
@ -2798,6 +2829,12 @@ function associate_vertices(polygons, split, curpoly=0) =
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10] // tex_size=[10,10]
// ); // );
// Example(3D): "trunc_diamonds" texture with large inset.
// tex = texture("trunc_diamonds",inset=.25);
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[10,10]
// );
// Example(3D): "tri_grid" texture. // Example(3D): "tri_grid" texture.
// tex = texture("tri_grid"); // tex = texture("tri_grid");
// linear_sweep( // linear_sweep(
@ -2810,12 +2847,24 @@ function associate_vertices(polygons, split, curpoly=0) =
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[12.5,20] // tex_size=[12.5,20]
// ); // );
// Example(3D): "hex_grid" texture with large inset
// tex = texture("hex_grid", inset=0.4);
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[12.5,20]
// );
// Example(3D): "checkers" texture. // Example(3D): "checkers" texture.
// tex = texture("checkers"); // tex = texture("checkers");
// linear_sweep( // linear_sweep(
// rect(50), texture=tex, h=40, // rect(50), texture=tex, h=40,
// tex_size=[10,10] // tex_size=[10,10]
// ); // );
// Example(3D): "checkers" texture.
// tex = texture("checkers",inset=0.25);
// linear_sweep(
// rect(50), texture=tex, h=40,
// tex_size=[10,10]
// );
// Example(3D): "rough" texture. // Example(3D): "rough" texture.
// tex = texture("rough"); // tex = texture("rough");
// linear_sweep( // linear_sweep(
@ -2824,6 +2873,10 @@ function associate_vertices(polygons, split, curpoly=0) =
// ); // );
function texture(tex, n, inset, gap, roughness) = function texture(tex, n, inset, gap, roughness) =
assert(is_undef(n) || all_positive([n]), "n must be a positive value if given")
assert(is_undef(inset) || is_finite(inset), "inset must be a number if given")
assert(is_undef(gap) || is_finite(gap), "gap must be a number if given")
assert(is_undef(roughness) || all_nonnegative([roughness]), "roughness must be a nonnegative value if given")
tex=="ribs"? tex=="ribs"?
let( let(
n = quantup(default(n,2),2) n = quantup(default(n,2),2)
@ -2842,13 +2895,12 @@ function texture(tex, n, inset, gap, roughness) =
]] : ]] :
tex=="trunc_ribs_vnf"? tex=="trunc_ribs_vnf"?
let( let(
inset = default(inset,1/2), inset = default(inset,1/4)*2,
gap = default(gap,1/4) gap = default(gap,1/4)
) )
assert(inset >= 0) assert(all_nonnegative([inset,gap]), "trunc_ribs_vnf texture requires gap>=0 and inset>=0")
assert(gap >= 0) assert(gap+inset > 0, "trunc_ribs_vnf texture requires that gap+inset>0")
assert(gap+inset > 0) assert(gap+inset <= 1, "trunc_ribs_vnf texture requires that gap+2*inset<=1")
assert(gap+inset <= 1)
[ [
[ [
each move([0.5,0.5], p=path3d(rect([1-gap,1]),0)), each move([0.5,0.5], p=path3d(rect([1-gap,1]),0)),
@ -2920,8 +2972,10 @@ function texture(tex, n, inset, gap, roughness) =
] : ] :
tex=="trunc_pyramids_vnf"? tex=="trunc_pyramids_vnf"?
let( let(
inset = default(inset,0.25) inset = default(inset,0.1)
) [ )
assert(inset>0 && inset<.5, "trunc_pyramids_vnf texture requires inset in (0,0.5)")
[
[ [
each path3d(square(1)), each path3d(square(1)),
each move([1/2,1/2,1], p=path3d(rect(1-2*inset))), each move([1/2,1/2,1], p=path3d(rect(1-2*inset))),
@ -2959,7 +3013,11 @@ function texture(tex, n, inset, gap, roughness) =
let( let(
inset = default(inset,0.05), inset = default(inset,0.05),
gap = default(gap,0.05) gap = default(gap,0.05)
) [ )
assert(inset>=0,"bricks_vnf texture requires nonnegative inset")
assert(gap>0, "bricks_vnf requires gap greater than 0")
assert(gap+inset<0.5, "bricks_vnf requires gap+inset<0.5")
[
[ [
each path3d(square(1)), each path3d(square(1)),
each move([gap/2, gap/2, 0], p=path3d(square([1-gap, 0.5-gap]))), each move([gap/2, gap/2, 0], p=path3d(square([1-gap, 0.5-gap]))),
@ -2983,7 +3041,9 @@ function texture(tex, n, inset, gap, roughness) =
tex=="checkers"? tex=="checkers"?
let( let(
inset = default(inset,0.05) inset = default(inset,0.05)
) [ )
assert(inset>0 && inset<.5, "checkers texture requires inset in (0,0.5)")
[
[ [
each move([0,0], p=path3d(square(0.5-inset),1)), each move([0,0], p=path3d(square(0.5-inset),1)),
each move([0,0.5], p=path3d(square(0.5-inset))), each move([0,0.5], p=path3d(square(0.5-inset))),
@ -3007,13 +3067,13 @@ function texture(tex, n, inset, gap, roughness) =
] : ] :
tex=="cones"? tex=="cones"?
let( let(
n = quant(default(n,12),4), n = quant(default(n,16),4),
inset = default(inset,0) inset = default(inset,0)
) )
assert(inset>=0 && inset<0.5) assert(inset>=0 && inset<0.5)
[ [
[ [
each move([1/2,1/2], p=path3d(circle(d=1-inset,$fn=n))), each move([1/2,1/2], p=path3d(circle(d=1-2*inset,$fn=n))),
[1/2,1/2,1], [1/2,1/2,1],
each path3d(square(1)), each path3d(square(1)),
], [ ], [
@ -3036,7 +3096,7 @@ function texture(tex, n, inset, gap, roughness) =
] : ] :
tex=="trunc_diamonds"? tex=="trunc_diamonds"?
let( let(
inset = default(inset,0.1) inset = default(inset,0.1)/sqrt(2)*2
) )
assert(inset>0 && inset<0.5) assert(inset>0 && inset<0.5)
[ [
@ -3086,7 +3146,10 @@ function texture(tex, n, inset, gap, roughness) =
) [verts, faces] : ) [verts, faces] :
tex=="tri_grid"? tex=="tri_grid"?
let( let(
inset = default(inset,0.1), inset = default(inset,0.1)
)
assert(inset>0 && inset<0.5, "tri_grid texture requires inset in (0,0.5)")
let(
aspect = 1 / adj_ang_to_opp(1,60), aspect = 1 / adj_ang_to_opp(1,60),
adj = opp_ang_to_adj(inset, 30), adj = opp_ang_to_adj(inset, 30),
hyp = opp_ang_to_hyp(inset, 30), hyp = opp_ang_to_hyp(inset, 30),
@ -3095,9 +3158,9 @@ function texture(tex, n, inset, gap, roughness) =
y3 = 0.5 - inset * aspect, y3 = 0.5 - inset * aspect,
y4 = 0.5 + inset * aspect, y4 = 0.5 + inset * aspect,
y5 = 1 - adj * aspect, y5 = 1 - adj * aspect,
y6 = 1 - inset * aspect y6 = 1 - inset * aspect,
fdas= echo(adj=adj, hyp=hyp, y1=y1, y2=y2, y3=y3, y4=y4,y5=y5,y6=y6)
) )
assert(inset>0 && inset<0.5)
[ [
[ [
[0,0,0], [1,0,0], [0,0,0], [1,0,0],
@ -3125,7 +3188,7 @@ function texture(tex, n, inset, gap, roughness) =
let( let(
inset=default(inset,0.1) inset=default(inset,0.1)
) )
assert(inset>=0 && inset<0.5) assert(inset>0 && inset<0.5)
let( let(
diag=opp_ang_to_hyp(inset,60), diag=opp_ang_to_hyp(inset,60),
side=adj_ang_to_opp(1,30), side=adj_ang_to_opp(1,30),