mirror of
https://github.com/revarbat/BOSL2.git
synced 2025-01-16 13:50:23 +01:00
Attachments Synopses
This commit is contained in:
Richard Milewski
parent
ad3a775155
commit
891ddfe65e
137
attachments.scad
137
attachments.scad
@ -2,7 +2,7 @@
|
||||
// LibFile: attachments.scad
|
||||
// The modules in this file allows you to attach one object to another by making one object the child of another object.
|
||||
// You can place the child object in relation to its parent object and control the position and orientation
|
||||
// relative to the parent. The modifiers allow you to treat children in different ways that simple union, such
|
||||
// relative to the parent. The modifiers allow you to treat children in ways different from simple union, such
|
||||
// as differencing them from the parent, or changing their color. Attachment only works when the parent and child
|
||||
// are both written to support attachment. Also included in this file are the tools to make your own "attachable" objects.
|
||||
// Includes:
|
||||
@ -42,7 +42,7 @@ _ANCHOR_TYPES = ["intersect","hull"];
|
||||
// This library adds the concept of anchoring, spin and orientation to the `cube()`, `cylinder()`
|
||||
// and `sphere()` builtins, as well as to most of the shapes provided by this library itself.
|
||||
// - An anchor is a place on an object which you can align the object to, or attach other objects
|
||||
// to using `attach()` or `position()`. An anchor has a position, a direction, and a spin.
|
||||
// to using `attach()` or `position()`. An anchor has a position, a direction, and a spin.
|
||||
// The direction and spin are used to orient other objects to match when using `attach()`.
|
||||
// - Spin is a simple rotation around the Z axis.
|
||||
// - Orientation is rotating an object so that its top is pointed towards a given vector.
|
||||
@ -270,7 +270,7 @@ _ANCHOR_TYPES = ["intersect","hull"];
|
||||
// _show_edges(edges="NONE");
|
||||
// }
|
||||
// }
|
||||
// Figure(3D,Big,VPD=310,NoScales): Next are some examples showing how you can combine edge descriptors to obtain different edge sets. You can specify the top front edge with a numerical vector or by combining the named direction vectors. If you combine them as a list you get all the edges around the front or top faces. Adding `except` removes an edge.
|
||||
// Figure(3D,Big,VPD=310,NoScales): Next are some examples showing how you can combine edge descriptors to obtain different edge sets. You can specify the top front edge with a numerical vector or by combining the named direction vectors. If you combine them as a list you get all the edges around the front and top faces. Adding `except` removes an edge.
|
||||
// xdistribute(43){
|
||||
// _show_edges(_edges([0,-1,1]),toplabel=["edges=[0,-1,1]"]);
|
||||
// _show_edges(_edges(TOP+FRONT),toplabel=["edges=TOP+FRONT"]);
|
||||
@ -391,12 +391,13 @@ _ANCHOR_TYPES = ["intersect","hull"];
|
||||
// Section: Attachment Positioning
|
||||
|
||||
// Module: position()
|
||||
// Usage:
|
||||
// PARENT() position(from) CHILDREN;
|
||||
//
|
||||
// Synopsis: Attaches children to a parent object at an anchor point.
|
||||
// Topics: Attachments
|
||||
// See Also: attachable(), attach(), orient()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() position(from) CHILDREN;
|
||||
//
|
||||
// Description:
|
||||
// Attaches children to a parent object at an anchor point. For a step-by-step explanation
|
||||
// of attachments, see the [[Attachments Tutorial|Tutorial-Attachments]].
|
||||
@ -428,9 +429,12 @@ module position(from)
|
||||
|
||||
|
||||
// Module: orient()
|
||||
// Synopsis: Orients children's tops in the directon of the speccified anchor.
|
||||
// Topics: Attachments
|
||||
// See Also: attachable(), attach(), orient()
|
||||
|
||||
// Usage:
|
||||
// PARENT() orient(anchor, [spin]) CHILDREN;
|
||||
// Topics: Attachments
|
||||
// Description:
|
||||
// Orients children such that their top is tilted in the direction of the specified parent anchor point.
|
||||
// For a step-by-step explanation of attachments, see the [[Attachments Tutorial|Tutorial-Attachments]].
|
||||
@ -441,7 +445,7 @@ module position(from)
|
||||
// `$attach_anchor` is set to the `[ANCHOR, POSITION, ORIENT, SPIN]` information for the `anchor=`, if given.
|
||||
// `$attach_to` is set to `undef`.
|
||||
// `$attach_norot` is set to `true`.
|
||||
// See Also: attachable(), attach(), orient()
|
||||
//
|
||||
// Example: When orienting to an anchor, the spin of the anchor may cause confusion:
|
||||
// prismoid([50,50],[30,30],h=40) {
|
||||
// position(TOP+RIGHT)
|
||||
@ -479,11 +483,13 @@ module orient(anchor, spin) {
|
||||
|
||||
|
||||
// Module: attach()
|
||||
// Synopsis: Attaches children to a parent object at an anchor point and orientation.
|
||||
// Topics: Attachments
|
||||
// See Also: attachable(), position(), face_profile(), edge_profile(), corner_profile()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() attach(from, [overlap=], [norot=]) CHILDREN;
|
||||
// PARENT() attach(from, to, [overlap=], [norot=]) CHILDREN;
|
||||
// Topics: Attachments
|
||||
// See Also: attachable(), position(), face_profile(), edge_profile(), corner_profile()
|
||||
// Description:
|
||||
// Attaches children to a parent object at an anchor point and orientation. Attached objects will
|
||||
// be overlapped into the parent object by a little bit, as specified by the `$overlap`
|
||||
@ -534,10 +540,12 @@ module attach(from, to, overlap, norot=false)
|
||||
// Section: Tagging
|
||||
|
||||
// Module: tag()
|
||||
// Usage:
|
||||
// PARENT() tag(tag) CHILDREN;
|
||||
// Synopsis: Assigns a tag to an object
|
||||
// Topics: Attachments
|
||||
// See Also: force_tag(), recolor(), hide(), show_only(), diff(), intersect()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() tag(tag) CHILDREN;
|
||||
// Description:
|
||||
// Assigns the specified tag to all of the children. Note that if you want
|
||||
// to apply a tag to non-tag-aware objects you need to use {{force_tag()}} instead.
|
||||
@ -571,10 +579,12 @@ module tag(tag)
|
||||
|
||||
|
||||
// Module: force_tag()
|
||||
// Usage:
|
||||
// PARENT() force_tag([tag]) CHILDREN;
|
||||
// Assigns a tag to a non-attachable object.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), recolor(), hide(), show_only(), diff(), intersect()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() force_tag([tag]) CHILDREN;
|
||||
// Description:
|
||||
// You use this module when you want to make a non-attachable or non-BOSL2 module respect tags.
|
||||
// It applies to its children the tag specified (or the tag currently in force if you don't specify a tag),
|
||||
@ -633,10 +643,12 @@ module force_tag(tag)
|
||||
|
||||
|
||||
// Module: default_tag()
|
||||
// Usage:
|
||||
// PARENT() default_tag(tag) CHILDREN;
|
||||
// Synopsis: Sets a default tag for all children.
|
||||
// Topics: Attachments
|
||||
// See Also: force_tag(), recolor(), hide(), show_only(), diff(), intersect()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() default_tag(tag) CHILDREN;
|
||||
// Description:
|
||||
// Sets a default tag for all of the children. This is intended to be used to set a tag for a whole module
|
||||
// that is then used outside the module, such as setting the tag to "remove" for easy operation with {{diff()}}.
|
||||
@ -716,12 +728,14 @@ module tag_scope(scope){
|
||||
// Section: Attachment Modifiers
|
||||
|
||||
// Module: diff()
|
||||
// Usage:
|
||||
// diff([remove], [keep]) PARENT() CHILDREN;
|
||||
// Synopsis: Performs a differencing operation using tags rather than hierarchy to control what happens.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), force_tag(), recolor(), show_only(), hide(), tag_diff(), intersect(), tag_intersect()
|
||||
//
|
||||
// Usage:
|
||||
// diff([remove], [keep]) PARENT() CHILDREN;
|
||||
// Description:
|
||||
// Perform a differencing operation using tags to control what happens. This is specifically intended to
|
||||
// Performs a differencing operation using tags to control what happens. This is specifically intended to
|
||||
// address the situation where you want differences between a parent and child object, something
|
||||
// that is impossible with the native difference() module.
|
||||
// The children to diff are grouped into three categories, regardless of nesting level.
|
||||
@ -904,10 +918,12 @@ module diff(remove="remove", keep="keep")
|
||||
|
||||
|
||||
// Module: tag_diff()
|
||||
// Usage:
|
||||
// tag_diff(tag, [remove], [keep]) PARENT() CHILDREN;
|
||||
// Synopsis: Performs a {{diff()}} and then sets a tag on the result.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), force_tag(), recolor(), show_only(), hide(), diff(), intersect(), tag_intersect()
|
||||
//
|
||||
// Usage:
|
||||
// tag_diff(tag, [remove], [keep]) PARENT() CHILDREN;
|
||||
// Description:
|
||||
// Perform a differencing operation in the manner of {{diff()}} using tags to control what happens,
|
||||
// and then tag the resulting difference object with the specified tag. This forces the specified
|
||||
@ -974,10 +990,12 @@ module tag_diff(tag,remove="remove", keep="keep")
|
||||
|
||||
|
||||
// Module: intersect()
|
||||
// Usage:
|
||||
// intersect([intersect], [keep]) PARENT() CHILDREN;
|
||||
// Synopsis: Perform an intersection operation on children using tags rather than hierarchy to control what happens.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), force_tag(), recolor(), show_only(), hide(), diff(), tag_diff(), tag_intersect()
|
||||
//
|
||||
// Usage:
|
||||
// intersect([intersect], [keep]) PARENT() CHILDREN;
|
||||
// Description:
|
||||
// Performs an intersection operation on its children, using tags to
|
||||
// determine what happens. This is specifically intended to address
|
||||
@ -1043,10 +1061,12 @@ module intersect(intersect="intersect",keep="keep")
|
||||
|
||||
|
||||
// Module: tag_intersect()
|
||||
// Usage:
|
||||
// tag_intersect(tag, [intersect], [keep]) PARENT() CHILDREN;
|
||||
// Synopsis: Performs an {{intersect()}} and then tags the result.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), force_tag(), recolor(), show_only(), hide(), diff(), tag_diff(), intersect()
|
||||
//
|
||||
// Usage:
|
||||
// tag_intersect(tag, [intersect], [keep]) PARENT() CHILDREN;
|
||||
// Description:
|
||||
// Perform an intersection operation in the manner of {{intersect()}} using tags to control what happens,
|
||||
// and then tag the resulting difference object with the specified tag. This forces the specified
|
||||
@ -1098,10 +1118,12 @@ module tag_intersect(tag,intersect="intersect",keep="keep")
|
||||
|
||||
|
||||
// Module: conv_hull()
|
||||
// Usage:
|
||||
// conv_hull([keep]) CHILDREN;
|
||||
// Synopsis: Performs a hull operation on the children using tags to determine what happens.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), recolor(), show_only(), hide(), diff(), intersect()
|
||||
//
|
||||
// Usage:
|
||||
// conv_hull([keep]) CHILDREN;
|
||||
// Description:
|
||||
// Performs a hull operation on the children using tags to determine what happens. The items
|
||||
// not tagged with the `keep` tags are combined into a convex hull, and the children tagged with the keep tags
|
||||
@ -1134,10 +1156,12 @@ module conv_hull(keep="keep")
|
||||
|
||||
|
||||
// Module: tag_conv_hull()
|
||||
// Usage:
|
||||
// tag_conv_hull(tag, [keep]) CHILDREN;
|
||||
// Synopsis: Performs a {{conv_hull()}} and then sets a tag on the result.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), recolor(), show_only(), hide(), diff(), intersect()
|
||||
//
|
||||
// Usage:
|
||||
// tag_conv_hull(tag, [keep]) CHILDREN;
|
||||
// Description:
|
||||
// Perform a convex hull operation in the manner of {{conv_hull()}} using tags to control what happens,
|
||||
// and then tag the resulting hull object with the specified tag. This forces the specified
|
||||
@ -1184,10 +1208,12 @@ module tag_conv_hull(tag,keep="keep")
|
||||
|
||||
|
||||
// Module: hide()
|
||||
// Synopsis: Hides attachable children with the given tags.
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), recolor(), show_only(), show_all(), show_int(), diff(), intersect()
|
||||
//
|
||||
// Usage:
|
||||
// hide(tags) CHILDREN;
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), recolor(), show_only(), diff(), intersect()
|
||||
// Description:
|
||||
// Hides all attachable children with the given tags, which you supply as a space separated string. Previously hidden objects remain hidden, so hiding is cumulative, unlike `show_only()`.
|
||||
// For a step-by-step explanation of attachments, see the [[Attachments Tutorial|Tutorial-Attachments]].
|
||||
@ -1218,10 +1244,12 @@ module hide(tags)
|
||||
|
||||
|
||||
// Module: show_only()
|
||||
// Synopsis: Show only the children with the listed tags.
|
||||
// See Also: tag(), recolor(), show_all(), show_int(), diff(), intersect()
|
||||
// Topics: Attachments
|
||||
//
|
||||
// Usage:
|
||||
// show_only(tags) CHILDREN;
|
||||
// Topics: Attachments
|
||||
// See Also: tag(), recolor(), hide(), diff(), intersect()
|
||||
// Description:
|
||||
// Show only the children with the listed tags, which you sply as a space separated string. Only unhidden objects will be shown, so if an object is hidden either before or after the `show_only()` call then it will remain hidden. This overrides any previous `show_only()` calls. Unlike `hide()`, calls to `show_only()` are not cumulative.
|
||||
// For a step-by-step explanation of attachments, see the [[Attachments Tutorial|Tutorial-Attachments]].
|
||||
@ -1244,6 +1272,10 @@ module show_only(tags)
|
||||
}
|
||||
|
||||
// Module: show_all()
|
||||
// Synopsis: Shows all children and clears tags.
|
||||
// See Also: tag(), recolor(), show_only(), show_int(), diff(), intersect()
|
||||
// Topics: Attachments
|
||||
//
|
||||
// Usage;
|
||||
// show_all() CHILDREN;
|
||||
// Description:
|
||||
@ -1262,6 +1294,10 @@ module show_all()
|
||||
|
||||
|
||||
// Module: show_int()
|
||||
// Synopsis: Shows children with the listed tags which were already shown in the parent context.
|
||||
// See Also: tag(), recolor(), show_only(), show_all(), show_int(), diff(), intersect()
|
||||
// Topics: Attachments
|
||||
//
|
||||
// Usage:
|
||||
// show_int(tags) CHILDREN;
|
||||
// Description:
|
||||
@ -1285,9 +1321,12 @@ module show_int(tags)
|
||||
|
||||
|
||||
// Module: face_mask()
|
||||
// Synopsis: Ataches a 3d mask shape to the given faces of the parent.
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), edge_mask(), corner_mask(), face_profile(), edge_profile(), corner_profile()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() face_mask(faces) CHILDREN;
|
||||
// Topics: Attachments, Masking
|
||||
// Description:
|
||||
// Takes a 3D mask shape, and attaches it to the given faces, with the appropriate orientation to be
|
||||
// differenced away. The mask shape should be vertically oriented (Z-aligned) with the bottom half
|
||||
@ -1327,10 +1366,12 @@ module face_mask(faces=[LEFT,RIGHT,FRONT,BACK,BOT,TOP]) {
|
||||
|
||||
|
||||
// Module: edge_mask()
|
||||
// Synopsis: Attaches a 3D mask shape to the given edges of the parent.
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_mask(), corner_mask(), face_profile(), edge_profile(), corner_profile()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() edge_mask([edges], [except]) CHILDREN;
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_profile(), edge_profile(), corner_mask(), face_mask()
|
||||
// Description:
|
||||
// Takes a 3D mask shape, and attaches it to the given edges, with the appropriate orientation to be
|
||||
// differenced away. The mask shape should be vertically oriented (Z-aligned) with the back-right
|
||||
@ -1390,10 +1431,12 @@ module edge_mask(edges=EDGES_ALL, except=[]) {
|
||||
|
||||
|
||||
// Module: corner_mask()
|
||||
// Synopsis: Attaches a 3d mask shape to the given corners of the parent.
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_mask(), edge_mask(), face_profile(), edge_profile(), corner_profile()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() corner_mask([corners], [except]) CHILDREN;
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_profile(), edge_profile(), edge_mask()
|
||||
// Description:
|
||||
// Takes a 3D mask shape, and attaches it to the specified corners, with the appropriate orientation to
|
||||
// be differenced away. The 3D corner mask shape should be designed to mask away the X+Y+Z+ octant. If no tag is set
|
||||
@ -1439,10 +1482,12 @@ module corner_mask(corners=CORNERS_ALL, except=[]) {
|
||||
|
||||
|
||||
// Module: face_profile()
|
||||
// Synopses: Extrudes a 2D edge profile into a mask for all edges and corners of the given faces on the parent.
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), edge_profile(), corner_profile(), face_mask(), edge_mask(), corner_mask()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() face_profile(faces, r|d=, [convexity=]) CHILDREN;
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), edge_profile(), corner_profile()
|
||||
// Description:
|
||||
// Given a 2D edge profile, extrudes it into a mask for all edges and corners bounding each given face. If no tag is set
|
||||
// then `face_profile` sets the tag for children to "remove" so that it will work with the default {{diff()}} tag.
|
||||
@ -1476,10 +1521,12 @@ module face_profile(faces=[], r, d, convexity=10) {
|
||||
|
||||
|
||||
// Module: edge_profile()
|
||||
// Synopsis: Extrudes a 2d edge profile into a mask on the given edges of the parent.
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_profile(), corner_profile(), edge_mask(), face_mask(), corner_mask
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() edge_profile([edges], [except], [convexity]) CHILDREN;
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_profile(), corner_profile()
|
||||
// Description:
|
||||
// Takes a 2D mask shape and attaches it to the selected edges, with the appropriate orientation and
|
||||
// extruded length to be `diff()`ed away, to give the edge a matching profile. If no tag is set
|
||||
@ -1538,10 +1585,12 @@ module edge_profile(edges=EDGES_ALL, except=[], convexity=10) {
|
||||
}
|
||||
|
||||
// Module: corner_profile()
|
||||
// Synopsis: Rotationally extrudes a 2d edge profile into corner mask on the given corners of the parent.
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_profile(), edge_profile(), corner_mask(), face_mask(), edge_mask()
|
||||
//
|
||||
// Usage:
|
||||
// PARENT() corner_profile([corners], [except], [r=|d=], [convexity=]) CHILDREN;
|
||||
// Topics: Attachments, Masking
|
||||
// See Also: attachable(), position(), attach(), face_profile(), edge_profile()
|
||||
// Description:
|
||||
// Takes a 2D mask shape, rotationally extrudes and converts it into a corner mask, and attaches it
|
||||
// to the selected corners with the appropriate orientation. If no tag is set
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user