mirror of
https://github.com/BelfrySCAD/BOSL2.git
synced 2024-12-29 16:29:40 +00:00
SynTags for masks2d, masks3d and partitions
This commit is contained in:
Richard Milewski
parent
7b7e6ba21d
commit
a36fcd2d81
3 changed files with 29 additions and 1 deletions
|
|
@ -16,6 +16,7 @@
|
|||
|
||||
// Function&Module: mask2d_roundover()
|
||||
// Synopsis: Creates a 2D beading mask shape useful for rounding 90° edges.
|
||||
// SynTags: Geom, Path
|
||||
// Topics: Shapes (2D), Paths (2D), Path Generators, Attachable, Masks (2D)
|
||||
// See Also: corner_profile(), edge_profile(), face_profile(), fillet()
|
||||
// Usage: As module
|
||||
|
|
@ -80,6 +81,7 @@ function mask2d_roundover(r, inset=0, excess=0.01, d, anchor=CENTER,spin=0) =
|
|||
|
||||
// Function&Module: mask2d_cove()
|
||||
// Synopsis: Creates a 2D cove (quarter-round) mask shape.
|
||||
// SynTags: Geom, Path
|
||||
// Topics: Shapes (2D), Paths (2D), Path Generators, Attachable, Masks (2D)
|
||||
// See Also: corner_profile(), edge_profile(), face_profile()
|
||||
// Usage: As module
|
||||
|
|
@ -144,6 +146,7 @@ function mask2d_cove(r, inset=0, excess=0.01, d, anchor=CENTER,spin=0) =
|
|||
|
||||
// Function&Module: mask2d_chamfer()
|
||||
// Synopsis: Produces a 2D chamfer mask shape.
|
||||
// SynTags: Geom, Path
|
||||
// Topics: Shapes (2D), Paths (2D), Path Generators, Attachable, Masks (2D)
|
||||
// See Also: corner_profile(), edge_profile(), face_profile()
|
||||
// Usage: As Module
|
||||
|
|
@ -223,6 +226,7 @@ function mask2d_chamfer(edge, angle=45, inset=0, excess=0.01, x, y, anchor=CENTE
|
|||
|
||||
// Function&Module: mask2d_rabbet()
|
||||
// Synopsis: Creates a rabbet mask shape.
|
||||
// SynTags: Geom, Path
|
||||
// Topics: Shapes (2D), Paths (2D), Path Generators, Attachable, Masks (2D)
|
||||
// See Also: corner_profile(), edge_profile(), face_profile()
|
||||
// Usage: As Module
|
||||
|
|
@ -281,6 +285,7 @@ function mask2d_rabbet(size, excess=0.01, anchor=CENTER,spin=0) =
|
|||
|
||||
// Function&Module: mask2d_dovetail()
|
||||
// Synopsis: Creates a 2D dovetail mask shape.
|
||||
// SynTags: Geom, Path
|
||||
// Topics: Masks (2D), Shapes (2D), Paths (2D), Path Generators, Attachable
|
||||
// See Also: corner_profile(), edge_profile(), face_profile()
|
||||
// Usage: As Module
|
||||
|
|
@ -359,6 +364,7 @@ function mask2d_dovetail(edge, angle=30, inset=0, shelf=0, excess=0.01, x, y, an
|
|||
|
||||
// Function&Module: mask2d_teardrop()
|
||||
// Synopsis: Creates a 2D teardrop mask shape with a controllable maximum angle from vertical.
|
||||
// SynTags: Geom, Path
|
||||
// Topics: Shapes (2D), Paths (2D), Path Generators, Attachable, Masks (2D), FDM Optimized
|
||||
// See Also: corner_profile(), edge_profile(), face_profile()
|
||||
// Usage: As Module
|
||||
|
|
@ -423,6 +429,7 @@ module mask2d_teardrop(r, angle=45, excess=0.01, d, anchor=CENTER, spin=0) {
|
|||
|
||||
// Function&Module: mask2d_ogee()
|
||||
// Synopsis: Creates a 2D ogee mask shape.
|
||||
// SynTags: Geom, Path
|
||||
// Topics: Shapes (2D), Paths (2D), Path Generators, Attachable, Masks (2D)
|
||||
// See Also: corner_profile(), edge_profile(), face_profile()
|
||||
// Usage: As Module
|
||||
|
|
|
|||
11
masks3d.scad
11
masks3d.scad
|
|
@ -15,6 +15,7 @@
|
|||
|
||||
// Module: chamfer_edge_mask()
|
||||
// Synopsis: Creates a shape to chamfer a 90° edge.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Chamfers, Shapes (3D)
|
||||
// See Also: chamfer_corner_mask()
|
||||
// Usage:
|
||||
|
|
@ -56,6 +57,7 @@ module chamfer_edge_mask(l, chamfer=1, excess=0.1, h, length, height, anchor=CEN
|
|||
|
||||
// Module: chamfer_corner_mask()
|
||||
// Synopsis: Creates a shape to chamfer a 90° corner.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Chamfers, Shapes (3D)
|
||||
// See Also: chamfer_edge_mask()
|
||||
// Usage:
|
||||
|
|
@ -94,6 +96,7 @@ module chamfer_corner_mask(chamfer=1, anchor=CENTER, spin=0, orient=UP) {
|
|||
|
||||
// Module: chamfer_cylinder_mask()
|
||||
// Synopsis: Creates a shape to chamfer the end of a cylinder.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Chamfers, Cylinders
|
||||
// Usage:
|
||||
// chamfer_cylinder_mask(r|d=, chamfer, [ang], [from_end]) [ATTACHMENTS];
|
||||
|
|
@ -158,6 +161,7 @@ module chamfer_cylinder_mask(r, chamfer, d, ang=45, from_end=false, anchor=CENTE
|
|||
|
||||
// Module: rounding_edge_mask()
|
||||
// Synopsis: Creates a shape to round a 90° edge.
|
||||
// SynTags: Geom
|
||||
// Topics: Masks, Rounding, Shapes (3D)
|
||||
// See Also: rounding_angled_edge_mask(), rounding_corner_mask(), rounding_angled_corner_mask()
|
||||
// Usage:
|
||||
|
|
@ -237,6 +241,7 @@ module rounding_edge_mask(l, r, r1, r2, d, d1, d2, excess=0.1, anchor=CENTER, sp
|
|||
|
||||
// Module: rounding_corner_mask()
|
||||
// Synopsis: Creates a shape to round 90° corners.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Rounding, Shapes (3D)
|
||||
// See Also: rounding_angled_corner_mask(), rounding_edge_mask(), rounding_angled_edge_mask()
|
||||
// Usage:
|
||||
|
|
@ -290,6 +295,7 @@ module rounding_corner_mask(r, d, style="octa", excess=0.1, anchor=CENTER, spin=
|
|||
|
||||
// Module: rounding_angled_edge_mask()
|
||||
// Synopsis: Creates a shape to round edges of any angle.
|
||||
// SynTags: Geom
|
||||
// Topics: Masks, Rounding
|
||||
// See Also: rounding_angled_corner_mask(), rounding_edge_mask(), rounding_corner_mask()
|
||||
// Usage:
|
||||
|
|
@ -359,6 +365,7 @@ module rounding_angled_edge_mask(h, r, r1, r2, d, d1, d2, ang=90, anchor=CENTER,
|
|||
|
||||
// Module: rounding_angled_corner_mask()
|
||||
// Synopsis: Creates a shape to round the corner of an arbitrary angle.
|
||||
// SynTags: Geom
|
||||
// Topics: Masks, Rounding, Shapes (3D)
|
||||
// See Also: rounding_angled_edge_mask(), rounding_corner_mask(), rounding_edge_mask()
|
||||
// Usage:
|
||||
|
|
@ -410,6 +417,7 @@ module rounding_angled_corner_mask(r, ang=90, d, anchor=CENTER, spin=0, orient=U
|
|||
|
||||
// Module: rounding_cylinder_mask()
|
||||
// Synopsis: Creates a shape to round the end of a cylinder.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Rounding, Cylinders
|
||||
// See Also: rounding_hole_mask()
|
||||
// Usage:
|
||||
|
|
@ -461,6 +469,7 @@ module rounding_cylinder_mask(r, rounding, d, anchor=CENTER, spin=0, orient=UP)
|
|||
|
||||
// Module: rounding_hole_mask()
|
||||
// Synopsis: Creates a shape to round the edge of a round hole.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Rounding
|
||||
// See Also: rounding_cylinder_mask()
|
||||
// Usage:
|
||||
|
|
@ -513,6 +522,7 @@ module rounding_hole_mask(r, rounding, excess=0.1, d, anchor=CENTER, spin=0, ori
|
|||
|
||||
// Module: teardrop_edge_mask()
|
||||
// Synopsis: Creates a shape to round a 90° edge but limit the angle of overhang.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Rounding, Shapes (3D), FDM Optimized
|
||||
// See Also: teardrop_corner_mask()
|
||||
// Usage:
|
||||
|
|
@ -555,6 +565,7 @@ module teardrop_edge_mask(l, r, angle=45, excess=0.1, d, anchor=CTR, spin=0, ori
|
|||
|
||||
// Module: teardrop_corner_mask()
|
||||
// Synopsis: Creates a shape to round a 90° corner but limit the angle of overhang.
|
||||
// SynTags: Geom
|
||||
// Topics: Masking, Rounding, Shapes (3D), FDM Optimized
|
||||
// See Also: teardrop_edge_mask()
|
||||
// Usage:
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@
|
|||
|
||||
// Function&Module: half_of()
|
||||
// Synopsis: Masks half of an object at a cut plane.
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Topics: Partitions, Masking
|
||||
// See Also: back_half(), front_half(), left_half(), right_half(), top_half(), bottom_half()
|
||||
//
|
||||
|
|
@ -122,6 +123,7 @@ function half_of(p, v=UP, cp) =
|
|||
|
||||
// Function&Module: left_half()
|
||||
// Synopsis: Masks the right half of an object along the Y-Z plane, leaving the left half.
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Topics: Partitions, Masking
|
||||
// See Also: back_half(), front_half(), right_half(), top_half(), bottom_half(), half_of()
|
||||
//
|
||||
|
|
@ -167,6 +169,7 @@ function left_half(p,x=0) = half_of(p, LEFT, [x,0,0]);
|
|||
|
||||
|
||||
// Function&Module: right_half()
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Synopsis: Masks the left half of an object along the Y-Z plane, leaving the right half.
|
||||
// Topics: Partitions, Masking
|
||||
// See Also: back_half(), front_half(), left_half(), top_half(), bottom_half(), half_of()
|
||||
|
|
@ -212,6 +215,7 @@ function right_half(p,x=0) = half_of(p, RIGHT, [x,0,0]);
|
|||
|
||||
// Function&Module: front_half()
|
||||
// Synopsis: Masks the back half of an object along the X-Z plane, leaving the front half.
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Topics: Partitions, Masking
|
||||
// See Also: back_half(), left_half(), right_half(), top_half(), bottom_half(), half_of()
|
||||
//
|
||||
|
|
@ -257,6 +261,7 @@ function front_half(p,y=0) = half_of(p, FRONT, [0,y,0]);
|
|||
|
||||
// Function&Module: back_half()
|
||||
// Synopsis: Masks the front half of an object along the X-Z plane, leaving the back half.
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Topics: Partitions, Masking
|
||||
// See Also: front_half(), left_half(), right_half(), top_half(), bottom_half(), half_of()
|
||||
//
|
||||
|
|
@ -302,6 +307,7 @@ function back_half(p,y=0) = half_of(p, BACK, [0,y,0]);
|
|||
|
||||
// Function&Module: bottom_half()
|
||||
// Synopsis: Masks the top half of an object along the X-Y plane, leaving the bottom half.
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Topics: Partitions, Masking
|
||||
// See Also: back_half(), front_half(), left_half(), right_half(), top_half(), half_of()
|
||||
//
|
||||
|
|
@ -339,6 +345,7 @@ function bottom_half(p,z=0) = half_of(p,BOTTOM,[0,0,z]);
|
|||
|
||||
// Function&Module: top_half()
|
||||
// Synopsis: Masks the bottom half of an object along the X-Y plane, leaving the top half.
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Topics: Partitions, Masking
|
||||
// See Also: back_half(), front_half(), left_half(), right_half(), bottom_half(), half_of()
|
||||
//
|
||||
|
|
@ -420,6 +427,7 @@ function _partition_cutpath(l, h, cutsize, cutpath, gap) =
|
|||
|
||||
// Module: partition_mask()
|
||||
// Synopsis: Creates a mask to remove half an object with the remaining half suitable for reassembly.
|
||||
// SynTags: Geom
|
||||
// Topics: Partitions, Masking, Paths
|
||||
// See Also: partition_cut_mask(), partition()
|
||||
// Usage:
|
||||
|
|
@ -473,6 +481,7 @@ module partition_mask(l=100, w=100, h=100, cutsize=10, cutpath="jigsaw", gap=0,
|
|||
|
||||
// Module: partition_cut_mask()
|
||||
// Synopsis: Creates a mask to cut an object into two subparts that can be reassembled.
|
||||
// SynTags: Geom
|
||||
// Topics: Partitions, Masking, Paths
|
||||
// See Also: partition_mask(), partition()
|
||||
// Usage:
|
||||
|
|
@ -518,7 +527,8 @@ module partition_cut_mask(l=100, h=100, cutsize=10, cutpath="jigsaw", gap=0, anc
|
|||
|
||||
|
||||
// Module: partition()
|
||||
// Synopsis: Cuts an object in two with matched joining edges, then separates the parts .
|
||||
// Synopsis: Cuts an object in two with matched joining edges, then separates the parts.
|
||||
// SynTags: Geom, VNF, Path, Region
|
||||
// Topics: Partitions, Masking, Paths
|
||||
// See Also: partition_cut_mask(), partition_mask()
|
||||
// Usage:
|
||||
|
|
|
|||
Loading…
Reference in a new issue