mirror of
https://github.com/BelfrySCAD/BOSL2.git
synced 2024-12-29 16:29:40 +00:00
Parameter fixes and doc fixes
This commit is contained in:
Adrian Mariano
parent
ba6d7654c5
commit
622333c8d7
2 changed files with 57 additions and 52 deletions
|
|
@ -646,7 +646,7 @@ module prismoid(
|
|||
size1, size2, h, shift=[0,0],
|
||||
rounding=0, rounding1, rounding2,
|
||||
chamfer=0, chamfer1, chamfer2,
|
||||
l, center,
|
||||
l, height, length, center,
|
||||
anchor, spin=0, orient=UP
|
||||
) {
|
||||
checks =
|
||||
|
|
@ -691,7 +691,7 @@ function prismoid(
|
|||
size1, size2, h, shift=[0,0],
|
||||
rounding=0, rounding1, rounding2,
|
||||
chamfer=0, chamfer1, chamfer2,
|
||||
l, center,
|
||||
l, height, length, center,
|
||||
anchor=DOWN, spin=0, orient=UP
|
||||
) =
|
||||
assert(is_vector(size1,2))
|
||||
|
|
@ -730,7 +730,7 @@ function prismoid(
|
|||
)
|
||||
let(
|
||||
eps = pow(2,-14),
|
||||
h = first_defined([h,l,1]),
|
||||
h = one_defined([h,l,length,height],"h,l,length,height",dflt=1),
|
||||
shiftby = point3d(point2d(shift)),
|
||||
s1 = [max(size1.x, eps), max(size1.y, eps)],
|
||||
s2 = [max(size2.x, eps), max(size2.y, eps)],
|
||||
|
|
@ -1206,7 +1206,7 @@ function cylinder(h, r1, r2, center, l, r, d, d1, d2, anchor, spin=0, orient=UP)
|
|||
// stroke(arc(cp=[r2+8,-10], angle=[180-30,180], n=20, r=5), width=.18, endcaps="arrow2");
|
||||
// }
|
||||
// Arguments:
|
||||
// l / h = Length of cylinder along oriented axis. Default: 1
|
||||
// l / h / length / height = Length of cylinder along oriented axis. Default: 1
|
||||
// r = Radius of cylinder. Default: 1
|
||||
// center = If given, overrides `anchor`. A true value sets `anchor=CENTER`, false sets `anchor=DOWN`.
|
||||
// ---
|
||||
|
|
@ -1376,12 +1376,12 @@ function cyl(
|
|||
from_end, from_end1, from_end2,
|
||||
texture, tex_size=[5,5], tex_counts,
|
||||
tex_inset=false, tex_rot=false,
|
||||
tex_scale=1, tex_samples,
|
||||
tex_scale=1, tex_samples, h, height,
|
||||
tex_taper, tex_style="min_edge",
|
||||
anchor, spin=0, orient=UP
|
||||
) =
|
||||
let(
|
||||
l = first_defined([l, h, length, height, 1]),
|
||||
l = one_defined([l, h, length, height],"l,h,length,height",dflt=1),
|
||||
_r1 = get_radius(r1=r1, r=r, d1=d1, d=d, dflt=1),
|
||||
_r2 = get_radius(r1=r2, r=r, d1=d2, d=d, dflt=1),
|
||||
sides = segs(max(_r1,_r2)),
|
||||
|
|
@ -1497,11 +1497,11 @@ module cyl(
|
|||
from_end, from_end1, from_end2,
|
||||
texture, tex_size=[5,5], tex_counts,
|
||||
tex_inset=false, tex_rot=false,
|
||||
tex_scale=1, tex_samples,
|
||||
tex_scale=1, tex_samples, length, height,
|
||||
tex_taper, tex_style="min_edge",
|
||||
anchor, spin=0, orient=UP
|
||||
) {
|
||||
l = first_defined([l, h, 1]);
|
||||
l = one_defined([l, h, length, height],"l,h,length,height",dflt=1);
|
||||
_r1 = get_radius(r1=r1, r=r, d1=d1, d=d, dflt=1);
|
||||
_r2 = get_radius(r1=r2, r=r, d1=d2, d=d, dflt=1);
|
||||
sides = segs(max(_r1,_r2));
|
||||
|
|
@ -1845,18 +1845,18 @@ module tube(
|
|||
// Creates a pie slice shape.
|
||||
//
|
||||
// Usage: As Module
|
||||
// pie_slice(l|h, r, ang, [center]);
|
||||
// pie_slice(l|h, d=, ang=, ...);
|
||||
// pie_slice(l|h, r1=|d1=, r2=|d2=, ang=, ...);
|
||||
// pie_slice(l|h=|height=|length=, r, ang, [center]);
|
||||
// pie_slice(l|h=|height=|length=, d=, ang=, ...);
|
||||
// pie_slice(l|h=|height=|length=, r1=|d1=, r2=|d2=, ang=, ...);
|
||||
// Usage: As Function
|
||||
// vnf = pie_slice(l|h, r, ang, [center]);
|
||||
// vnf = pie_slice(l|h, d=, ang=, ...);
|
||||
// vnf = pie_slice(l|h, r1=|d1=, r2=|d2=, ang=, ...);
|
||||
// vnf = pie_slice(l|h=|height=|length=, r, ang, [center]);
|
||||
// vnf = pie_slice(l|h=|height=|length=, d=, ang=, ...);
|
||||
// vnf = pie_slice(l|h=|height=|length=, r1=|d1=, r2=|d2=, ang=, ...);
|
||||
// Usage: Attaching Children
|
||||
// pie_slice(l|h, r, ang, ...) ATTACHMENTS;
|
||||
//
|
||||
// Arguments:
|
||||
// h / l = height of pie slice.
|
||||
// h / l / height / length = height of pie slice.
|
||||
// r = radius of pie slice.
|
||||
// ang = pie slice angle in degrees.
|
||||
// center = If given, overrides `anchor`. A true value sets `anchor=CENTER`, false sets `anchor=UP`.
|
||||
|
|
@ -1882,10 +1882,10 @@ module tube(
|
|||
|
||||
module pie_slice(
|
||||
h, r, ang=30, center,
|
||||
r1, r2, d, d1, d2, l,
|
||||
r1, r2, d, d1, d2, l, length, height,
|
||||
anchor, spin=0, orient=UP
|
||||
) {
|
||||
l = first_defined([l, h, 1]);
|
||||
l = one_defined([l, h,height,length],"l,h,height,length",dflt=1);
|
||||
r1 = get_radius(r1=r1, r=r, d1=d1, d=d, dflt=10);
|
||||
r2 = get_radius(r1=r2, r=r, d1=d2, d=d, dflt=10);
|
||||
maxd = max(r1,r2)+0.1;
|
||||
|
|
@ -1905,11 +1905,11 @@ module pie_slice(
|
|||
|
||||
function pie_slice(
|
||||
h, r, ang=30, center,
|
||||
r1, r2, d, d1, d2, l,
|
||||
r1, r2, d, d1, d2, l, length, height,
|
||||
anchor, spin=0, orient=UP
|
||||
) = let(
|
||||
anchor = get_anchor(anchor, center, BOT, BOT),
|
||||
l = first_defined([l, h, 1]),
|
||||
l = one_defined([l, h,height,length],"l,h,height,length",dflt=1),
|
||||
r1 = get_radius(r1=r1, r=r, d1=d1, d=d, dflt=10),
|
||||
r2 = get_radius(r1=r2, r=r, d1=d2, d=d, dflt=10),
|
||||
maxd = max(r1,r2)+0.1,
|
||||
|
|
@ -2478,18 +2478,18 @@ function torus(
|
|||
// Note that with caps, the chamfer must not be so big that it makes the cap height illegal.
|
||||
//
|
||||
// Usage: Typical
|
||||
// teardrop(h|l|length|height, r, [ang], [cap_h], [chamfer=], ...) [ATTACHMENTS];
|
||||
// teardrop(h|l|length|height, d=, [ang=], [cap_h=], [chamfer=], ...) [ATTACHMENTS];
|
||||
// teardrop(h|l=|length=|height=, r, [ang], [cap_h], [chamfer=], ...) [ATTACHMENTS];
|
||||
// teardrop(h|l=|length=|height=, d=, [ang=], [cap_h=], [chamfer=], ...) [ATTACHMENTS];
|
||||
// Usage: Psuedo-Conical
|
||||
// teardrop(h|l, r1=, r2=, [ang=], [cap_h1=], [cap_h2=], ...) [ATTACHMENTS];
|
||||
// teardrop(h|l, d1=, d2=, [ang=], [cap_h1=], [cap_h2=], ...) [ATTACHMENTS];
|
||||
// teardrop(h|l=|height=|length=, r1=, r2=, [ang=], [cap_h1=], [cap_h2=], ...) [ATTACHMENTS];
|
||||
// teardrop(h|l=|height=|length=, d1=, d2=, [ang=], [cap_h1=], [cap_h2=], ...) [ATTACHMENTS];
|
||||
// Usage: As Function
|
||||
// vnf = teardrop(h|l=, r|d=, [ang=], [cap_h=], ...);
|
||||
// vnf = teardrop(h|l=, r1=|d1=, r2=|d2=, [ang=], [cap_h=], ...);
|
||||
// vnf = teardrop(h|l=, r1=|d1=, r2=|d2=, [ang=], [cap_h1=], [cap_h2=], ...);
|
||||
// vnf = teardrop(h|l=|height=|length=, r|d=, [ang=], [cap_h=], ...);
|
||||
// vnf = teardrop(h|l=|height=|length=, r1=|d1=, r2=|d2=, [ang=], [cap_h=], ...);
|
||||
// vnf = teardrop(h|l=|height=|length=, r1=|d1=, r2=|d2=, [ang=], [cap_h1=], [cap_h2=], ...);
|
||||
//
|
||||
// Arguments:
|
||||
// h / l = Thickness of teardrop. Default: 1
|
||||
// h / l / height / length = Thickness of teardrop. Default: 1
|
||||
// r = Radius of circular part of teardrop. Default: 1
|
||||
// ang = Angle of hat walls from the Z axis. Default: 45 degrees
|
||||
// cap_h = If given, height above center where the shape will be truncated. Default: `undef` (no truncation)
|
||||
|
|
@ -2721,7 +2721,7 @@ function onion(r, ang=45, cap_h, d, anchor=CENTER, spin=0, orient=UP) =
|
|||
// go to the Help menu and select "Font List".
|
||||
// Arguments:
|
||||
// text = Text to create.
|
||||
// h = Extrusion height for the text. Default: 1
|
||||
// h / height / thickness = Extrusion height for the text. Default: 1
|
||||
// size = The font will be created at this size divided by 0.72. Default: 10
|
||||
// font = Font to use. Default: "Liberation Sans"
|
||||
// ---
|
||||
|
|
@ -2745,8 +2745,11 @@ function onion(r, ang=45, cap_h, d, anchor=CENTER, spin=0, orient=UP) =
|
|||
// text3d("Foobar", h=2, anchor=str("baseline",CENTER));
|
||||
// text3d("Foobar", h=2, anchor=str("baseline",BOTTOM+RIGHT));
|
||||
|
||||
module text3d(text, h=1, size=10, font="Helvetica", halign, valign, spacing=1.0, direction="ltr", language="em", script="latin", anchor="baseline[-1,0,-1]", spin=0, orient=UP) {
|
||||
module text3d(text, h, size=10, font="Helvetica", halign, valign, spacing=1.0, direction="ltr", language="em", script="latin",
|
||||
height, thickness,
|
||||
anchor="baseline[-1,0,-1]", spin=0, orient=UP) {
|
||||
no_children($children);
|
||||
h = one_defined([h,height,thickness],"h,height,thickness",dflt=1);
|
||||
dummy1 =
|
||||
assert(is_undef(anchor) || is_vector(anchor) || is_string(anchor), str("Got: ",anchor))
|
||||
assert(is_undef(spin) || is_vector(spin,3) || is_num(spin), str("Got: ",spin))
|
||||
|
|
@ -2814,7 +2817,7 @@ function _cut_interp(pathcut, path, data) =
|
|||
|
||||
// Module: path_text()
|
||||
// Usage:
|
||||
// path_text(path, text, [size], [thickness], [font], [lettersize], [offset], [reverse], [normal], [top], [textmetrics], [kern])
|
||||
// path_text(path, text, [size], [thickness], [font], [lettersize=], [offset=], [reverse=], [normal=], [top=], [textmetrics=], [kern=])
|
||||
// Description:
|
||||
// Place the text letter by letter onto the specified path using textmetrics (if available and requested)
|
||||
// or user specified letter spacing. The path can be 2D or 3D. In 2D the text appears along the path with letters upright
|
||||
|
|
@ -2866,8 +2869,8 @@ function _cut_interp(pathcut, path, data) =
|
|||
// Arguments:
|
||||
// path = path to place the text on
|
||||
// text = text to create
|
||||
// size = The font will be created at this size divided by 0.72. Default: 10
|
||||
// thickness = thickness of letters (not allowed for 2D path)
|
||||
// size = The font will be created at this size divided by 0.72.
|
||||
// thickness / h / height = thickness of letters (not allowed for 2D path)
|
||||
// font = font to use. Default: "Liberation Sans"
|
||||
// ---
|
||||
// lettersize = scalar or array giving size of letters
|
||||
|
|
@ -2940,22 +2943,23 @@ function _cut_interp(pathcut, path, data) =
|
|||
// kern = [1,1.2,1,1,.3,-.2,1,0,.8,1,1.1,1];
|
||||
// path_text(path, "Example text", font="Courier", size=5, lettersize = 5/1.2, kern=kern, normal=UP);
|
||||
|
||||
module path_text(path, text, font, size, thickness, lettersize, offset=0, reverse=false, normal, top, center=false, textmetrics=false, kern=0)
|
||||
module path_text(path, text, font, size, thickness, lettersize, offset=0, reverse=false, normal, top, center=false, textmetrics=false, kern=0, height,h)
|
||||
{
|
||||
no_children($children);
|
||||
dummy2=assert(is_path(path,[2,3]),"Must supply a 2d or 3d path")
|
||||
assert(num_defined([normal,top])<=1, "Cannot define both \"normal\" and \"top\"");
|
||||
assert(num_defined([normal,top])<=1, "Cannot define both \"normal\" and \"top\"")
|
||||
assert(all_positive([size]), "Must give positive text size");
|
||||
dim = len(path[0]);
|
||||
normalok = is_undef(normal) || is_vector(normal,3) || (is_path(normal,3) && len(normal)==len(path));
|
||||
topok = is_undef(top) || is_vector(top,dim) || (dim==2 && is_vector(top,3) && top[2]==0)
|
||||
|| (is_path(top,dim) && len(top)==len(path));
|
||||
dummy4 = assert(dim==3 || is_undef(thickness), "Cannot give a thickness with 2d path")
|
||||
dummy4 = assert(dim==3 || !any_defined([thickness,h,height]), "Cannot give a thickness or height with 2d path")
|
||||
assert(dim==3 || !reverse, "Reverse not allowed with 2d path")
|
||||
assert(dim==3 || offset==0, "Cannot give offset with 2d path")
|
||||
assert(dim==3 || is_undef(normal), "Cannot define \"normal\" for a 2d path, only \"top\"")
|
||||
assert(normalok,"\"normal\" must be a vector or path compatible with the given path")
|
||||
assert(topok,"\"top\" must be a vector or path compatible with the given path");
|
||||
thickness = first_defined([thickness,1]);
|
||||
thickness = one_defined([thickness,h,height],"thickness,h,height",dflt=1);
|
||||
normal = is_vector(normal) ? repeat(normal, len(path))
|
||||
: is_def(normal) ? normal
|
||||
: undef;
|
||||
|
|
@ -3031,10 +3035,10 @@ module path_text(path, text, font, size, thickness, lettersize, offset=0, revers
|
|||
//
|
||||
// Usage: Typical
|
||||
// interior_fillet(l, r, [ang], [overlap], ...) [ATTACHMENTS];
|
||||
// interior_fillet(l, d=, [ang=], [overlap=], ...) [ATTACHMENTS];
|
||||
// interior_fillet(l|length=|h=|height=, d=, [ang=], [overlap=], ...) [ATTACHMENTS];
|
||||
//
|
||||
// Arguments:
|
||||
// l = Length of edge to fillet.
|
||||
// l / length / h / height = Length of edge to fillet.
|
||||
// r = Radius of fillet.
|
||||
// ang = Angle between faces to fillet.
|
||||
// overlap = Overlap size for unioning with faces.
|
||||
|
|
@ -3070,7 +3074,8 @@ module path_text(path, text, font, size, thickness, lettersize, offset=0, revers
|
|||
// interior_fillet(l=50, r=10, spin=180, orient=RIGHT);
|
||||
// }
|
||||
|
||||
module interior_fillet(l=1.0, r, ang=90, overlap=0.01, d, anchor=CENTER, spin=0, orient=UP) {
|
||||
module interior_fillet(l=1.0, r, ang=90, overlap=0.01, d, length, h, height, anchor=CENTER, spin=0, orient=UP) {
|
||||
l = one_defined([l,length,h,height],"l,length,h,height");
|
||||
r = get_radius(r=r, d=d, dflt=1);
|
||||
steps = ceil(segs(r)*(180-ang)/360);
|
||||
arc = arc(n=steps+1, r=r, corner=[polar_to_xy(r,ang),[0,0],[r,0]]);
|
||||
|
|
@ -3224,9 +3229,9 @@ function heightfield(data, size=[100,100], bottom=-20, maxz=100, xrange=[-1:0.04
|
|||
|
||||
// Function&Module: cylindrical_heightfield()
|
||||
// Usage: As Function
|
||||
// vnf = cylindrical_heightfield(data, l, r|d=, [base=], [transpose=], [aspect=]);
|
||||
// vnf = cylindrical_heightfield(data, l|length=|h=|height=, r|d=, [base=], [transpose=], [aspect=]);
|
||||
// Usage: As Module
|
||||
// cylindrical_heightfield(data, l, r|d=, [base=], [transpose=], [aspect=]) [ATTACHMENTS];
|
||||
// cylindrical_heightfield(data, l|length=|h=|height=, r|d=, [base=], [transpose=], [aspect=]) [ATTACHMENTS];
|
||||
// Topics: Extrusion, Textures, Knurling, Heightfield
|
||||
// Description:
|
||||
// Given a regular rectangular 2D grid of scalar values, or a function literal of signature (x,y), generates
|
||||
|
|
@ -3236,7 +3241,7 @@ function heightfield(data, size=[100,100], bottom=-20, maxz=100, xrange=[-1:0.04
|
|||
// https://raw.githubusercontent.com/revarbat/BOSL2/master/scripts/img2scad.py
|
||||
// Arguments:
|
||||
// data = This is either the 2D rectangular array of heights, or a function literal of signature `(x, y)`.
|
||||
// l = The length of the cylinder to wrap around.
|
||||
// l / length / h / height = The length of the cylinder to wrap around.
|
||||
// r = The radius of the cylinder to wrap around.
|
||||
// ---
|
||||
// r1 = The radius of the bottom of the cylinder to wrap around.
|
||||
|
|
@ -3286,11 +3291,11 @@ function cylindrical_heightfield(
|
|||
style="min_edge", maxh=99,
|
||||
xrange=[-1:0.01:1],
|
||||
yrange=[-1:0.01:1],
|
||||
r1, r2, d, d1, d2, h, height,
|
||||
r1, r2, d, d1, d2, h, height, length,
|
||||
anchor=CTR, spin=0, orient=UP
|
||||
) =
|
||||
let(
|
||||
l = first_defined([l, h, height]),
|
||||
l = one_defined([l, h, height, length], "l,h,height,l"),
|
||||
r1 = get_radius(r1=r1, r=r, d1=d1, d=d),
|
||||
r2 = get_radius(r1=r2, r=r, d1=d2, d=d)
|
||||
)
|
||||
|
|
@ -3349,10 +3354,10 @@ module cylindrical_heightfield(
|
|||
transpose=false, aspect=1,
|
||||
style="min_edge", convexity=10,
|
||||
xrange=[-1:0.01:1], yrange=[-1:0.01:1],
|
||||
maxh=99, r1, r2, d, d1, d2, h, height,
|
||||
maxh=99, r1, r2, d, d1, d2, h, height, length,
|
||||
anchor=CTR, spin=0, orient=UP
|
||||
) {
|
||||
l = first_defined([l, h, height]);
|
||||
l = one_defined([l, h, height, length], "l,h,height,length");
|
||||
r1 = get_radius(r1=r1, r=r, d1=d1, d=d);
|
||||
r2 = get_radius(r1=r2, r=r, d1=d2, d=d);
|
||||
vnf = cylindrical_heightfield(
|
||||
|
|
|
|||
10
skin.scad
10
skin.scad
|
|
@ -518,7 +518,7 @@ function skin(profiles, slices, refine=1, method="direct", sampling, caps, close
|
|||
// twisted extrusions by using `maxseg` to subsample flat faces.
|
||||
// Arguments:
|
||||
// region = The 2D [Region](regions.scad) or polygon that is to be extruded.
|
||||
// h / height = The height to extrude the region. Default: 1
|
||||
// h / height / l / length = The height to extrude the region. Default: 1
|
||||
// center = If true, the created polyhedron will be vertically centered. If false, it will be extruded upwards from the XY plane. Default: `false`
|
||||
// ---
|
||||
// twist = The number of degrees to rotate the top of the shape, clockwise around the Z axis, relative to the bottom. Default: 0
|
||||
|
|
@ -688,10 +688,10 @@ module linear_sweep(
|
|||
texture, tex_size=[5,5], tex_counts,
|
||||
tex_inset=false, tex_rot=false,
|
||||
tex_scale=1, tex_samples,
|
||||
cp, atype="hull", h,
|
||||
cp, atype="hull", h,l,length,
|
||||
anchor, spin=0, orient=UP
|
||||
) {
|
||||
h = first_defined([h, height, 1]);
|
||||
h = one_defined([h, height,l,length],"h,height,l,length",dflt=1);
|
||||
region = force_region(region);
|
||||
check = assert(is_region(region),"Input is not a region");
|
||||
anchor = center==true? "origin" :
|
||||
|
|
@ -739,7 +739,7 @@ function linear_sweep(
|
|||
cp, atype="hull", h,
|
||||
texture, tex_size=[5,5], tex_counts,
|
||||
tex_inset=false, tex_rot=false,
|
||||
tex_scale=1, tex_samples,
|
||||
tex_scale=1, tex_samples, h, l, length,
|
||||
anchor, spin=0, orient=UP
|
||||
) =
|
||||
let( region = force_region(region) )
|
||||
|
|
@ -748,7 +748,7 @@ function linear_sweep(
|
|||
assert(is_vector(shift, 2), str(shift))
|
||||
assert(is_bool(caps) || is_bool_list(caps,2), "caps must be boolean or a list of two booleans")
|
||||
let(
|
||||
h = first_defined([h, height, 1])
|
||||
h = one_defined([h, height,l,length],"h,height,l,length",dflt=1)
|
||||
)
|
||||
!is_undef(texture)? _textured_linear_sweep(
|
||||
region, h=h, caps=caps,
|
||||
|
|
|
|||
Loading…
Reference in a new issue