diff --git a/rounding.scad b/rounding.scad index 6f96b50..5f27877 100644 --- a/rounding.scad +++ b/rounding.scad @@ -14,7 +14,7 @@ include // Function: round_corners() // // Usage: -// rounded_path = round_corners(path, , *, , , , *); +// rounded_path = round_corners(path, , , , , , ); // // Description: // Takes a 2D or 3D path as input and rounds each corner @@ -404,7 +404,7 @@ function _rounding_offsets(edgespec,z_dir=1) = // Function: smooth_path() // Usage: -// smoothed = smooth_path(path, , *, , , *) +// smoothed = smooth_path(path, , , , , ); // Description: // Smooths the input path using a cubic spline. Every segment of the path will be replaced by a cubic curve // with `splinesteps` points. The cubic interpolation will pass through every input point on the path @@ -487,7 +487,7 @@ function _scalar_to_vector(value,length,varname) = // Function: path_join() // Usage: -// joined_path = path_join(paths, , *, , *) +// joined_path = path_join(paths, , , , ); // Description: // Connect a sequence of paths together into a single path with optional rounding // applied at the joints. By default the first path is taken as specified and subsequent paths are @@ -649,9 +649,9 @@ function _path_join(paths,joint,k=0.5,i=0,result=[],relocate=true,closed=false) // Function&Module: offset_sweep() // Usage: most common module arguments. See Arguments list below for more. -// offset_sweep(path, , , , *, *) +// offset_sweep(path, , , , , ,...) // Usage: most common function arguments. See Arguments list below for more. -// vnf = offset_sweep(path, , , , **) +// vnf = offset_sweep(path, , , , , ...) // Description: // Takes a 2d path as input and extrudes it upwards and/or downward. Each layer in the extrusion is produced using `offset()` to expand or shrink the previous layer. When invoked as a function returns a VNF; when invoked as a module produces geometry. // Using the `top` and/or `bottom` arguments you can specify a sequence of offsets values, or you can use several built-in offset profiles that @@ -1279,10 +1279,10 @@ function _remove_undefined_vals(list) = // Function&Module: offset_stroke() // Usage: as module -// offset_stroke(path, , *, , , , , , , *) +// offset_stroke(path, , , , , , , , , ); // Usage: as function -// path = offset_stroke(path, , *closed=false, , , , , , , *) -// region = offset_stroke(path, , *closed=true, , , , , , , *) +// path = offset_stroke(path, , closed=false, , , , , , , ); +// region = offset_stroke(path, , closed=true, , , , , , , ); // Description: // Uses `offset()` to compute a stroke for the input path. Unlike `stroke`, the result does not need to be // centered on the input path. The corners can be rounded, pointed, or chamfered, and you can make the ends @@ -1663,9 +1663,9 @@ function _rp_compute_patches(top, bot, rtop, rsides, ktop, ksides, concave) = // Function&Module: rounded_prism() // Usage: as a module -// rounded_prism(bottom, , *, , , , , , , , , , *); +// rounded_prism(bottom, , , , , , , , , , , , ,...) ; // Usage: as a function -// vnf = rounded_prism(bottom, , *, , , , , , , , , *); +// vnf = rounded_prism(bottom, , , , , , , , , , , ); // Description: // Construct a generalized prism with continuous curvature rounding. You supply the polygons for the top and bottom of the prism. The only // limitation is that joining the edges must produce a valid polyhedron with coplanar side faces. You specify the rounding by giving @@ -2045,7 +2045,7 @@ function _circle_mask(r) = // Module: bent_cutout_mask() // Usage: -// bent_cutout_mask(r|radius, thickness, path) +// bent_cutout_mask(r|radius, thickness, path); // Description: // Creates a mask for cutting a round-edged hole out of a vertical cylindrical shell. The specified radius // is the center radius of the cylindrical shell. The path needs to be sampled finely enough diff --git a/skin.scad b/skin.scad index 3dc5368..2d95458 100644 --- a/skin.scad +++ b/skin.scad @@ -13,7 +13,7 @@ // Function&Module: skin() // Usage: As module: -// skin(profiles, slices, , , , , , , , ,,,,) ... +// skin(profiles, slices, , , , , , , , ,,,,) ; // Usage: As function: // vnf = skin(profiles, slices, , , , , , ); // Description: @@ -823,7 +823,7 @@ function associate_vertices(polygons, split, curpoly=0) = // Function&Module: sweep() // Usage: As Module -// sweep(shape, transforms, , ) ... +// sweep(shape, transforms, , , , , , , ) ; // Usage: As Function // vnf = sweep(shape, transforms, , ); // Description: @@ -845,6 +845,7 @@ function associate_vertices(polygons, split, curpoly=0) = // transforms = list of 4x4 matrices to apply // closed = set to true to form a closed (torus) model. Default: false // caps = true to create endcap faces when closed is false. Can be a singe boolean to specify endcaps at both ends, or a length 2 boolean array. Default is true if closed is false. +// --- // convexity = convexity setting for use with polyhedron. (module only) Default: 10 // anchor = Translate so anchor point is at the origin. (module only) Default: "origin" // spin = Rotate this many degrees around Z axis after anchor. (module only) Default: 0 @@ -915,7 +916,7 @@ module sweep(shape, transforms, closed=false, caps, convexity=10, // Function&Module: path_sweep() // Usage: As module -// path_sweep(shape, path, , , , , , , , , , , , , , , , , )... +// path_sweep(shape, path, , , , , , , , , , , , , , , , , ) ; // vnf = path_sweep(shape, path, , , , , , , , , , , , ); // Description: // Takes as input a 2D polygon path or region, and a 2d or 3d path and constructs a polyhedron by sweeping the shape along the path. @@ -1305,7 +1306,7 @@ function path_sweep(shape, path, method="incremental", normal, closed=false, twi // Function&Module: path_sweep2d() // Usage: as module -// path_sweep2d(shape, path, , , , , , , , , )... +// path_sweep2d(shape, path, , , , , , , , , ) ; // Usage: as function // vnf = path_sweep2d(shape, path, , , ); // Description: