Color Synopses

This commit is contained in:
Richard Milewski 2023-03-25 17:49:32 -07:00
parent c92d18bbda
commit 9912f94d8c
2 changed files with 20 additions and 6 deletions

View File

@ -2350,7 +2350,7 @@ function attach_geom(
/// Topics: Attachments
/// See Also: reorient(), attachable()
//
f// Usage:
// Usage:
// bool = _attach_geom_2d(geom);
// Description:
// Returns true if the given attachment geometry description is for a 2D shape.
@ -2952,7 +2952,7 @@ module anchor_arrow(s=10, color=[0.333,0.333,1], flag=true, $tag="anchor-arrow",
// Module: anchor_arrow2d()
// Synopsis: Shows a 2d anchor orientation arrow.
// Topics: Attachments
// See Also: anchor_arrow3d(), show_anchors(), expose_anchors(), frame_ref()
// See Also: anchor_arrow(), show_anchors(), expose_anchors(), frame_ref()
//
// Usage:
// anchor_arrow2d([s], [color], [flag]);

View File

@ -16,10 +16,12 @@ use <builtins.scad>
// Section: Coloring Objects
// Module: recolor()
// Synopsis: Sets the color for attachable children and all their descendants.
// Topics: Attachments
// See Also: color_this(), hsl(), hsv()
//
// Usage:
// recolor([c]) CHILDREN;
// Topics: Attachments
// See Also: color_this()
// Description:
// Sets the color for attachable children and all their descendants. This only works with attachables and you cannot
// have any color() modules above it in any parents, only other recolor() or color_this() modules.
@ -43,10 +45,12 @@ module recolor(c="default")
// Module: color_this()
// Synopsis: Sets the color for children at the current level only.
// Topics: Attachments
// See Also: recolor(), hsl(), hsv()
//
// Usage:
// color_this([c]) CHILDREN;
// Topics: Attachments
// See Also: recolor()
// Description:
// Sets the color for children at one level, reverting to the previous color for further descendants.
// This works only with attachables and you cannot have any color() modules above it in any parents,
@ -72,6 +76,10 @@ module color_this(c="default")
// Module: rainbow()
// Synopsis: Iterates through a list, displaying children in different colors.
// Topics: List Handling
// See Also: hsl(), hsv()
//
// Usage:
// rainbow(list,[stride],[maxhues],[shuffle],[seed]) CHILDREN;
// Description:
@ -111,6 +119,9 @@ module rainbow(list, stride=1, maxhues, shuffle=false, seed)
// Section: Colorspace Conversion
// Function&Module: hsl()
// Synopsis: Sets the color of children to a specified hue, saturation, lightness and optional alpha channel value.
// See Also: hsv(), recolor(), color_this()
//
// Usage:
// hsl(h,[s],[l],[a]) CHILDREN;
// rgb = hsl(h,[s],[l],[a]);
@ -146,6 +157,9 @@ module hsl(h,s=1,l=0.5,a=1)
// Function&Module: hsv()
// Synopsis: Sets the color of children to a hue, saturation, value and optional alpha channel value.
// See Also: hsl(), recolor(), color_this()
//
// Usage:
// hsv(h,[s],[v],[a]) CHILDREN;
// rgb = hsv(h,[s],[v],[a]);