Syntags for affine.scad, attachments.scad, ball_bearings.scad, beziers.scad, bottlecaps.scad.

This commit is contained in:
Revar Desmera 2023-05-09 18:04:29 -07:00
parent 0c63875f72
commit 131c0ea99d
5 changed files with 51 additions and 5 deletions

View file

@ -11,6 +11,7 @@
// Function: affine2d_identity()
// Synopsis: Returns a 2D (3x3) identity transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms
// See Also: affine3d_identity(), ident(), IDENT
// Usage:
@ -30,6 +31,7 @@ function affine2d_identity() = ident(3);
// Function: affine2d_translate()
// Synopsis: Returns a 2D (3x3) translation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Translation
// See Also: affine3d_translate(), move(), translate(), left(), right(), fwd(), back(), down(), up()
// Usage:
@ -57,6 +59,7 @@ function affine2d_translate(v=[0,0]) =
// Function: affine2d_scale()
// Synopsis: Returns a 2D (3x3) scaling transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Scaling
// See Also: affine3d_scale(), scale(), xscale(), yscale(), zscale(), affine3d_scale()
// Usage:
@ -84,6 +87,7 @@ function affine2d_scale(v=[1,1]) =
// Function: affine2d_zrot()
// Synopsis: Returns a 2D (3x3) rotation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Rotation
// See Also: rot(), xrot(), yrot(), zrot(), affine3d_zrot()
// Usage:
@ -111,6 +115,7 @@ function affine2d_zrot(ang=0) =
// Function: affine2d_mirror()
// Synopsis: Returns a 2D (3x3) reflection transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Reflection, Mirroring
// See Also: mirror(), xflip(), yflip(), zflip(), affine3d_mirror()
// Usage:
@ -155,6 +160,7 @@ function affine2d_mirror(v) =
// Function: affine2d_skew()
// Synopsis: Returns a 2D (3x3) skewing transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Skewing
// See Also: skew(), affine3d_skew()
// Usage:
@ -190,6 +196,7 @@ function affine2d_skew(xa=0, ya=0) =
// Function: affine3d_identity()
// Synopsis: Returns a 3D (4x4) identity transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms
// See Also: affine2d_identity(), ident(), IDENT
// Usage:
@ -210,6 +217,7 @@ function affine3d_identity() = ident(4);
// Function: affine3d_translate()
// Synopsis: Returns a 3D (4x4) translation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Translation
// See Also: move(), translate(), left(), right(), fwd(), back(), down(), up(), affine2d_translate()
// Usage:
@ -240,6 +248,7 @@ function affine3d_translate(v=[0,0,0]) =
// Function: affine3d_scale()
// Synopsis: Returns a 3D (4x4) scaling transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Scaling
// See Also: scale(), affine2d_scale()
// Usage:
@ -270,6 +279,7 @@ function affine3d_scale(v=[1,1,1]) =
// Function: affine3d_xrot()
// Synopsis: Returns a 3D (4x4) X-axis rotation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Rotation
// See Also: rot(), xrot(), yrot(), zrot(), affine2d_zrot()
// Usage:
@ -299,6 +309,7 @@ function affine3d_xrot(ang=0) =
// Function: affine3d_yrot()
// Synopsis: Returns a 3D (4x4) Y-axis rotation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Rotation
// See Also: rot(), xrot(), yrot(), zrot(), affine2d_zrot()
// Usage:
@ -328,6 +339,7 @@ function affine3d_yrot(ang=0) =
// Function: affine3d_zrot()
// Synopsis: Returns a 3D (4x4) Z-axis rotation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Rotation
// See Also: rot(), xrot(), yrot(), zrot(), affine2d_zrot()
// Usage:
@ -357,6 +369,7 @@ function affine3d_zrot(ang=0) =
// Function: affine3d_rot_by_axis()
// Synopsis: Returns a 3D (4x4) arbitrary-axis rotation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Rotation
// See Also: rot(), xrot(), yrot(), zrot(), affine2d_zrot()
// Usage:
@ -394,6 +407,7 @@ function affine3d_rot_by_axis(u=UP, ang=0) =
// Function: affine3d_rot_from_to()
// Synopsis: Returns a 3D (4x4) tilt rotation transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Rotation
// See Also: rot(), xrot(), yrot(), zrot(), affine2d_zrot()
// Usage:
@ -441,6 +455,7 @@ function affine3d_rot_from_to(from, to) =
// Function: affine3d_mirror()
// Synopsis: Returns a 3D (4x4) reflection transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Reflection, Mirroring
// See Also: mirror(), xflip(), yflip(), zflip(), affine2d_mirror()
// Usage:
@ -482,6 +497,7 @@ function affine3d_mirror(v) =
// Function: affine3d_skew()
// Synopsis: Returns a 3D (4x4) skewing transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Skewing
// See Also: skew(), affine3d_skew_xy(), affine3d_skew_xz(), affine3d_skew_yz(), affine2d_skew()
// Usage:
@ -514,6 +530,7 @@ function affine3d_skew(sxy=0, sxz=0, syx=0, syz=0, szx=0, szy=0) = [
// Function: affine3d_skew_xy()
// Synopsis: Returns a 3D (4x4) XY-plane skewing transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Skewing
// See Also: skew(), affine3d_skew(), affine3d_skew_xz(), affine3d_skew_yz(), affine2d_skew()
// Usage:
@ -547,6 +564,7 @@ function affine3d_skew_xy(xa=0, ya=0) =
// Function: affine3d_skew_xz()
// Synopsis: Returns a 3D (4x4) XZ-plane skewing transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Skewing
// See Also: skew(), affine3d_skew(), affine3d_skew_xy(), affine3d_skew_yz(), affine2d_skew()
// Usage:
@ -580,6 +598,7 @@ function affine3d_skew_xz(xa=0, za=0) =
// Function: affine3d_skew_yz()
// Synopsis: Returns a 3D (4x4) YZ-plane skewing transformation matrix.
// SynTags: Mat
// Topics: Affine, Matrices, Transforms, Skewing
// See Also: skew(), affine3d_skew(), affine3d_skew_xy(), affine3d_skew_xz(), affine2d_skew()
// Usage:

View file

@ -2904,6 +2904,7 @@ function _standard_anchors(two_d=false) = [
// Module: show_anchors()
// Synopsis: Shows anchors for the parent object.
// SynTags: Geom
// Topics: Attachments
// See Also: expose_anchors(), anchor_arrow(), anchor_arrow2d(), frame_ref()
// Usage:
@ -2967,6 +2968,7 @@ module show_anchors(s=10, std=true, custom=true) {
// Module: anchor_arrow()
// Synopsis: Shows a 3d anchor orientation arrow.
// SynTags: Geom
// Topics: Attachments
// See Also: anchor_arrow2d(), show_anchors(), expose_anchors(), frame_ref()
// Usage:
@ -3005,6 +3007,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.
// SynTags: Geom
// Topics: Attachments
// See Also: anchor_arrow(), show_anchors(), expose_anchors(), frame_ref()
// Usage:
@ -3050,6 +3053,7 @@ module expose_anchors(opacity=0.2) {
// Module: frame_ref()
// Synopsis: Shows axis orientation arrows.
// SynTags: Geom
// Topics: Attachments
// See Also: anchor_arrow(), anchor_arrow2d(), show_anchors(), expose_anchors()
// Usage:

View file

@ -14,6 +14,7 @@
// Module: ball_bearing()
// Synopsis: Creates a standardized ball bearing assembly.
// SynTags: Geom
// Topics: Parts, Bearings
// See Also: linear_bearing(), lmXuu_bearing(), lmXuu_housing()
// Description:
@ -27,13 +28,13 @@
// spin = Rotate this many degrees around the Z axis after anchor. See [spin](attachments.scad#subsection-spin). Default: `0`
// orient = Vector to rotate top towards, after spin. See [orient](attachments.scad#subsection-orient). Default: `UP`
// Example:
// ball_bearing("608");
// ball_bearing("608", $fn=72);
// Example:
// ball_bearing("608ZZ");
// ball_bearing("608ZZ", $fn=72);
// Example:
// ball_bearing("R8");
// ball_bearing("R8", $fn=72);
// Example:
// ball_bearing(id=12,od=32,width=10,shield=false);
// ball_bearing(id=12,od=32,width=10,shield=false, $fn=72);
module ball_bearing(trade_size, id, od, width, shield=true, anchor=CTR, spin=0, orient=UP) {
info = is_undef(trade_size)? [id, od, width, shield] :
ball_bearing_info(trade_size);
@ -73,7 +74,7 @@ module ball_bearing(trade_size, id, od, width, shield=true, anchor=CTR, spin=0,
// Function: ball_bearing_info()
// Synopsis: Creates a standardized ball bearing assembly.
// Synopsis: Returns size info for a standardized ball bearing assembly.
// Topics: Parts, Bearings
// See Also: ball_bearing(), linear_bearing(), lmXuu_info()
// Description:

View file

@ -29,6 +29,7 @@
// Function: bezier_points()
// Synopsis: Computes one or more specified points along a bezier curve.
// SynTags: Path
// Topics: Bezier Curves
// See Also: bezier_curve(), bezier_curvature(), bezier_tangent(), bezier_derivative(), bezier_points()
// Usage:
@ -179,6 +180,7 @@ function _bezier_matrix(N) =
// Function: bezier_curve()
// Synopsis: Computes a number of uniformly distributed points along a bezier curve.
// SynTags: Path
// Topics: Bezier Curves
// See Also: bezier_curve(), bezier_curvature(), bezier_tangent(), bezier_derivative(), bezier_points()
// Usage:
@ -414,6 +416,7 @@ function bezier_line_intersection(bezier, line) =
// Function: bezpath_points()
// Synopsis: Computes one or more specified points along a bezier path.
// SynTags: Path
// Topics: Bezier Paths
// See Also: bezier_points(), bezier_curve()
// Usage:
@ -435,6 +438,7 @@ function bezpath_points(bezpath, curveind, u, N=3) =
// Function: bezpath_curve()
// Synopsis: Takes a bezier path and converts it into a path of points.
// SynTags: Path
// Topics: Bezier Paths
// See Also: bezier_points(), bezier_curve(), bezpath_points()
// Usage:
@ -544,6 +548,7 @@ function bezpath_length(bezpath, N=3, max_deflect=0.001) =
// Function: path_to_bezpath()
// Synopsis: Generates a bezier path that passes through all points in a given linear path.
// SynTags: Path
// Topics: Bezier Paths, Rounding
// See Also: path_tangents()
// Usage:
@ -631,6 +636,7 @@ function path_to_bezpath(path, closed, tangents, uniform=false, size, relsize) =
// Function: bezpath_close_to_axis()
// Synopsis: Closes a 2D bezier path to the specified axis.
// SynTags: Path
// Topics: Bezier Paths
// See Also: bezpath_offset()
// Usage:
@ -675,6 +681,7 @@ function bezpath_close_to_axis(bezpath, axis="X", N=3) =
// Function: bezpath_offset()
// Synopsis: Forms a closed bezier path loop with a translated and reversed copy of itself.
// SynTags: Path
// Topics: Bezier Paths
// See Also: bezpath_close_to_axis()
// Usage:
@ -1012,6 +1019,7 @@ function _bezier_rectangle(patch, splinesteps=16, style="default") =
// Function: bezier_vnf()
// Synopsis: Generates a (probably non-manifold) VNF for one or more bezier surface patches.
// SynTags: VNF
// Topics: Bezier Patches
// See Also: bezier_patch_points(), bezier_patch_flat()
// Usage:
@ -1139,6 +1147,7 @@ function bezier_vnf(patches=[], splinesteps=16, style="default") =
// Function: bezier_vnf_degenerate_patch()
// Synopsis: Generates a VNF for a degenerate bezier surface patch.
// SynTags: VNF
// Topics: Bezier Patches
// See Also: bezier_patch_points(), bezier_patch_flat(), bezier_vnf()
// Usage:
@ -1439,6 +1448,7 @@ function bezier_patch_normals(patch, u, v) =
// Module: debug_bezier()
// Synopsis: Shows a bezier path and it's associated control points.
// SynTags: Geom
// Topics: Bezier Paths, Debugging
// See Also: bezpath_curve()
// Usage:
@ -1493,6 +1503,7 @@ module debug_bezier(bezpath, width=1, N=3) {
// Module: debug_bezier_patches()
// Synopsis: Shows a bezier surface patch and its associated control points.
// SynTags: Geom
// Topics: Bezier Patches, Debugging
// See Also: bezier_patch_points(), bezier_patch_flat(), bezier_vnf()
// Usage:

View file

@ -18,6 +18,7 @@ include <rounding.scad>
// Module: pco1810_neck()
// Synopsis: Creates a neck for a PCO1810 standard bottle.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: pco1810_cap()
// Usage:
@ -142,6 +143,7 @@ function pco1810_neck(wall=2, anchor="support-ring", spin=0, orient=UP) =
// Module: pco1810_cap()
// Synopsis: Creates a cap for a PCO1810 standard bottle.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: pco1810_neck()
// Usage:
@ -212,6 +214,7 @@ function pco1810_cap(wall=2, texture="none", anchor=BOTTOM, spin=0, orient=UP) =
// Module: pco1881_neck()
// Synopsis: Creates a neck for a PCO1881 standard bottle.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: pco1881_cap()
// Usage:
@ -336,6 +339,7 @@ function pco1881_neck(wall=2, anchor="support-ring", spin=0, orient=UP) =
// Module: pco1881_cap()
// Synopsis: Creates a cap for a PCO1881 standard bottle.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: pco1881_neck()
// Usage:
@ -398,6 +402,7 @@ function pco1881_cap(wall=2, texture="none", anchor=BOTTOM, spin=0, orient=UP) =
// Module: generic_bottle_neck()
// Synopsis: Creates a generic neck for a bottle.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: generic_bottle_cap()
// Usage:
@ -528,6 +533,7 @@ function generic_bottle_neck(
// Module: generic_bottle_cap()
// Synopsis: Creates a generic cap for a bottle.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: generic_bottle_neck()
// Usage:
@ -616,6 +622,7 @@ function generic_bottle_cap(
// Module: bottle_adapter_neck_to_cap()
// Synopsis: Creates a generic adaptor between a neck and a cap.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: bottle_adapter_neck_to_neck()
// Usage:
@ -745,6 +752,7 @@ function bottle_adapter_neck_to_cap(
// Module: bottle_adapter_cap_to_cap()
// Synopsis: Creates a generic adaptor between a cap and a cap.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: bottle_adapter_neck_to_cap(), bottle_adapter_neck_to_neck()
// Usage:
@ -869,6 +877,7 @@ function bottle_adapter_cap_to_cap(
// Module: bottle_adapter_neck_to_neck()
// Synopsis: Creates a generic adaptor between a neck and a neck.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: bottle_adapter_neck_to_cap(), bottle_adapter_cap_to_cap()
// Usage:
@ -1005,6 +1014,7 @@ function bottle_adapter_neck_to_neck(
// Module: sp_neck()
// Synopsis: Creates an SPI threaded bottle neck.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: sp_cap()
// Usage:
@ -1208,6 +1218,7 @@ module sp_neck(diam,type,wall,id,style="L",bead=false, anchor, spin, orient)
// Module: sp_cap()
// Synopsis: Creates an SPI threaded bottle cap.
// SynTags: Geom
// Topics: Bottles, Threading
// See Also: sp_neck()
// Usage: