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

Merge pull request #384 from adrianVmariano/master

Browse source 
doc updates
This commit is contained in:
Revar Desmera 2021-01-15 15:39:08 -08:00 committed by GitHub
commit 3825bd0cc8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
rounding.scad
View file

@ -14,7 +14,7 @@ include <structs.scad>
// Function: round_corners()
//
// Usage:
// rounded_path = round_corners(path, <method>, *<radius>, <cut>, <joint>, <closed>, <verbose>*);
// rounded_path = round_corners(path, <method>, <radius=>, <cut=>, <joint=>, <closed=>, <verbose=>);
//
// 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, <tangents>, *<size|relsize>, <splinesteps>, <closed>, <uniform>*)
// smoothed = smooth_path(path, <tangents>, <size=|relsize=>, <splinesteps=>, <closed=>, <uniform=>);
// 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, <joint>, *<k>, <relocate>, <closed>*)
// joined_path = path_join(paths, <joint>, <k=>, <relocate=>, <closed=>);
// 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, <height|h|l>, <bottom>, <top>, *<offset>, <convexity>*)
// offset_sweep(path, <height|h|l>, <bottom>, <top>, <offset=>, <convexity=>,...) <attachments>
// Usage: most common function arguments. See Arguments list below for more.
// vnf = offset_sweep(path, <height|h|l>, <bottom>, <top>, *<offset>*)
// vnf = offset_sweep(path, <height|h|l>, <bottom>, <top>, <offset=>, ...)
// 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, <width>, *<rounded>, <chamfer>, <start>, <end>, <check_valid>, <quality>, <maxstep>, <closed>*)
// offset_stroke(path, <width>, <rounded=>, <chamfer=>, <start=>, <end=>, <check_valid=>, <quality=>, <maxstep=>, <closed=>);
// Usage: as function
// path = offset_stroke(path, <width>, *closed=false, <rounded>, <chamfer>, <start>, <end>, <check_valid>, <quality>, <maxstep>*)
// region = offset_stroke(path, <width>, *closed=true, <rounded>, <chamfer>, <start>, <end>, <check_valid>, <quality>, <maxstep>*)
// path = offset_stroke(path, <width>, closed=false, <rounded=>, <chamfer=>, <start=>, <end=>, <check_valid=>, <quality=>, <maxstep=>);
// region = offset_stroke(path, <width>, closed=true, <rounded=>, <chamfer=>, <start=>, <end=>, <check_valid=>, <quality=>, <maxstep=>);
// 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, <top>, *<height|h|length|l>, <joint_top>, <joint_bot>, <joint_sides>, <k>, <k_top>, <k_bot>, <k_sides>, <splinesteps>, <debug>, <convexity>*);
// rounded_prism(bottom, <top>, <height=|h=|length=|l=>, <joint_top=>, <joint_bot=>, <joint_sides=>, <k=>, <k_top=>, <k_bot=>, <k_sides=>, <splinesteps=>, <debug=>, <convexity=>,...) <attachments>;
// Usage: as a function
// vnf = rounded_prism(bottom, <top>, *<height|h|length|l>, <joint_top>, <joint_bot>, <joint_sides>, <k>, <k_top>, <k_bot>, <k_sides>, <splinesteps>, <debug>*);
// vnf = rounded_prism(bottom, <top>, <height=|h=|length=|l=>, <joint_top=>, <joint_bot=>, <joint_sides=>, <k=>, <k_top=>, <k_bot=>, <k_sides=>, <splinesteps=>, <debug=>);
// 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

9
skin.scad
View file

@ -13,7 +13,7 @@
// Function&Module: skin()
// Usage: As module:
// skin(profiles, slices, <z=>, <refine=>, <method=>, <sampling=>, <caps=>, <closed=>, <convexity=>, <anchor=>,<cp=>,<spin=>,<orient=>,<extent=>) ...
// skin(profiles, slices, <z=>, <refine=>, <method=>, <sampling=>, <caps=>, <closed=>, <convexity=>, <anchor=>,<cp=>,<spin=>,<orient=>,<extent=>) <attachments>;
// Usage: As function:
// vnf = skin(profiles, slices, <z=>, <refine=>, <method=>, <sampling=>, <caps=>, <closed=>);
// Description:
@ -823,7 +823,7 @@ function associate_vertices(polygons, split, curpoly=0) =
// Function&Module: sweep()
// Usage: As Module
// sweep(shape, transforms, <closed>, <caps>) ...
// sweep(shape, transforms, <closed>, <caps>, <convexity=>, <anchor=>, <spin=>, <orient=>, <extent=>) <attachments>;
// Usage: As Function
// vnf = sweep(shape, transforms, <closed>, <caps>);
// 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, <method>, <normal=>, <closed=>, <twist=>, <twist_by_length=>, <symmetry=>, <last_normal=>, <tangent=>, <relaxed=>, <caps=>, <convexity=>, <transforms=>, <anchor=>, <cp=>, <spin=>, <orient=>, <extent=>)...
// path_sweep(shape, path, <method>, <normal=>, <closed=>, <twist=>, <twist_by_length=>, <symmetry=>, <last_normal=>, <tangent=>, <relaxed=>, <caps=>, <convexity=>, <transforms=>, <anchor=>, <cp=>, <spin=>, <orient=>, <extent=>) <attachments>;
// vnf = path_sweep(shape, path, <method>, <normal=>, <closed=>, <twist=>, <twist_by_length=>, <symmetry=>, <last_normal=>, <tangent=>, <relaxed=>, <caps=>, <convexity=>, <transforms=>);
// 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, <closed>, <caps>, <quality>, <convexity=>, <anchor=>, <spin=>, <orient=>, <extent=>, <cp=>)...
// path_sweep2d(shape, path, <closed>, <caps>, <quality>, <convexity=>, <anchor=>, <spin=>, <orient=>, <extent=>, <cp=>) <attachments>;
// Usage: as function
// vnf = path_sweep2d(shape, path, <closed>, <caps>, <quality>);
// Description: