grey/BOSL2
1
0
Fork 0
mirror of https://github.com/BelfrySCAD/BOSL2.git synced 2025-01-01 09:49:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Corrected text() and text3d() docs.

Browse source
This commit is contained in:
Garth Minette 2022-01-18 22:16:23 -08:00
parent 7ca44e81c4
commit 6bea067678
2 changed files with 18 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
shapes2d.scad
View file

@ -1486,7 +1486,7 @@ function reuleaux_polygon(N=3, r, d, anchor=CENTER, spin=0) =
// Module: text() // Module: text()
// Topics: Attachments, Text // Topics: Attachments, Text
// Usage: // Usage:
// text(text, [size], [font]); // text(text, [size], [font], ...);
// Description: // Description:
// Creates a 3D text block that can be attached to other attachable objects. // Creates a 3D text block that can be attached to other attachable objects.
// NOTE: This cannot have children attached to it. // NOTE: This cannot have children attached to it.
@ -1495,6 +1495,12 @@ function reuleaux_polygon(N=3, r, d, anchor=CENTER, spin=0) =
// size = The font size used to create the text block. Default: 10 // size = The font size used to create the text block. Default: 10
// font = The name of the font used to create the text block. Default: "Helvetica" // font = The name of the font used to create the text block. Default: "Helvetica"
// --- // ---
// halign = If given, specifies the horizontal alignment of the text. `"left"`, `"center"`, or `"right"`. Overrides `anchor=`.
// valign = If given, specifies the vertical alignment of the text. `"top"`, `"center"`, `"baseline"` or `"bottom"`. Overrides `anchor=`.
// spacing = The relative spacing multiplier between characters. Default: `1.0`
// direction = The text direction. `"ltr"` for left to right. `"rtl"` for right to left. `"ttb"` for top to bottom. `"btt"` for bottom to top. Default: `"ltr"`
// language = The language the text is in. Default: `"en"`
// script = The script the text is in. Default: `"latin"`
// anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `"baseline"` // anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `"baseline"`
// spin = Rotate this many degrees around the Z axis. See [spin](attachments.scad#subsection-spin). Default: `0` // spin = Rotate this many degrees around the Z axis. See [spin](attachments.scad#subsection-spin). Default: `0`
// See Also: attachable() // See Also: attachable()

17
shapes3d.scad
View file

@ -1835,7 +1835,6 @@ function spheroid(r, style="aligned", d, circum=false, anchor=CENTER, spin=0, or
// Creates a torus shape. // Creates a torus shape.
// //
// Figure(2D,Med): // Figure(2D,Med):
// module text3d(t,size=8) text(text=t,size=size,font="Helvetica", halign="center",valign="center");
// module dashcirc(r,start=0,angle=359.9,dashlen=5) let(step=360*dashlen/(2*r*PI)) for(a=[start:step:start+angle]) stroke(arc(r=r,start=a,angle=step/2)); // module dashcirc(r,start=0,angle=359.9,dashlen=5) let(step=360*dashlen/(2*r*PI)) for(a=[start:step:start+angle]) stroke(arc(r=r,start=a,angle=step/2));
// r = 75; r2 = 30; // r = 75; r2 = 30;
// down(r2+0.1) #torus(r_maj=r, r_min=r2, $fn=72); // down(r2+0.1) #torus(r_maj=r, r_min=r2, $fn=72);
@ -1847,19 +1846,19 @@ function spheroid(r, style="aligned", d, circum=false, anchor=CENTER, spin=0, or
// } // }
// rot(240) color("blue") linear_extrude(height=0.01) { // rot(240) color("blue") linear_extrude(height=0.01) {
// stroke([[0,0],[r+r2,0]], endcaps="arrow2",width=2); // stroke([[0,0],[r+r2,0]], endcaps="arrow2",width=2);
// right(r) fwd(9) rot(-240) text3d("or",size=10); // right(r) fwd(9) rot(-240) text("or",size=10,anchor=CENTER);
// } // }
// rot(135) color("blue") linear_extrude(height=0.01) { // rot(135) color("blue") linear_extrude(height=0.01) {
// stroke([[0,0],[r-r2,0]], endcaps="arrow2",width=2); // stroke([[0,0],[r-r2,0]], endcaps="arrow2",width=2);
// right((r-r2)/2) back(8) rot(-135) text3d("ir",size=10); // right((r-r2)/2) back(8) rot(-135) text("ir",size=10,anchor=CENTER);
// } // }
// rot(45) color("blue") linear_extrude(height=0.01) { // rot(45) color("blue") linear_extrude(height=0.01) {
// stroke([[0,0],[r,0]], endcaps="arrow2",width=2); // stroke([[0,0],[r,0]], endcaps="arrow2",width=2);
// right(r/2) back(8) text3d("r_maj",size=9); // right(r/2) back(8) text("r_maj",size=9,anchor=CENTER);
// } // }
// rot(30) color("blue") linear_extrude(height=0.01) { // rot(30) color("blue") linear_extrude(height=0.01) {
// stroke([[r,0],[r+r2,0]], endcaps="arrow2",width=2); // stroke([[r,0],[r+r2,0]], endcaps="arrow2",width=2);
// right(r+r2/2) fwd(8) text3d("r_min",size=7); // right(r+r2/2) fwd(8) text("r_min",size=7,anchor=CENTER);
// } // }
// //
// Arguments: // Arguments:
@ -2074,7 +2073,7 @@ module onion(r, ang=45, cap_h, d, anchor=CENTER, spin=0, orient=UP)
// Module: text3d() // Module: text3d()
// Topics: Attachments, Text // Topics: Attachments, Text
// Usage: // Usage:
// text3d(text, [h], [size], [font]); // text3d(text, [h], [size], [font], ...);
// Description: // Description:
// Creates a 3D text block that can be attached to other attachable objects. // Creates a 3D text block that can be attached to other attachable objects.
// NOTE: This cannot have children attached to it. // NOTE: This cannot have children attached to it.
@ -2084,6 +2083,12 @@ module onion(r, ang=45, cap_h, d, anchor=CENTER, spin=0, orient=UP)
// size = The font size used to create the text block. Default: 10 // size = The font size used to create the text block. Default: 10
// font = The name of the font used to create the text block. Default: "Helvetica" // font = The name of the font used to create the text block. Default: "Helvetica"
// --- // ---
// halign = If given, specifies the horizontal alignment of the text. `"left"`, `"center"`, or `"right"`. Overrides `anchor=`.
// valign = If given, specifies the vertical alignment of the text. `"top"`, `"center"`, `"baseline"` or `"bottom"`. Overrides `anchor=`.
// spacing = The relative spacing multiplier between characters. Default: `1.0`
// direction = The text direction. `"ltr"` for left to right. `"rtl"` for right to left. `"ttb"` for top to bottom. `"btt"` for bottom to top. Default: `"ltr"`
// language = The language the text is in. Default: `"en"`
// script = The script the text is in. Default: `"latin"`
// anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `"baseline"` // anchor = Translate so anchor point is at origin (0,0,0). See [anchor](attachments.scad#subsection-anchor). Default: `"baseline"`
// spin = Rotate this many degrees around the Z axis. See [spin](attachments.scad#subsection-spin). Default: `0` // spin = Rotate this many degrees around the Z axis. See [spin](attachments.scad#subsection-spin). Default: `0`
// orient = Vector to rotate top towards. See [orient](attachments.scad#subsection-orient). Default: `UP` // orient = Vector to rotate top towards. See [orient](attachments.scad#subsection-orient). Default: `UP`