@metamesh/modeling 0.12.0 → 0.14.0

package/dist/docs/reference/geometry/boundsCenter.md

@@ -0,0 +1,62 @@
+# boundsCenter
+
+Midpoint of finite XY bounds in millimetres.
+
+## Call Signature
+
+
+
+**boundsCenter**(`bounds`: [`Bounds2`](Bounds2.md)): [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Midpoint of finite XY bounds in millimetres.
+
+### Parameters
+
+<a id="bounds"></a>
+
+**`bounds`** · [`Bounds2`](Bounds2.md) · Required
+
+
+
+### Returns
+
+[`Vector2Tuple`](Vector2Tuple.md)
+
+## Call Signature
+
+
+
+**boundsCenter**(`bounds`: [`Bounds3`](Bounds3.md)): [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+Midpoint of finite XYZ bounds in millimetres.
+
+### Parameters
+
+<a id="bounds-1"></a>
+
+**`bounds`** · [`Bounds3`](Bounds3.md) · Required
+
+
+
+### Returns
+
+[`Vector3Tuple`](Vector3Tuple.md)
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [Bounds3](Bounds3.md)
+- [Vector2Tuple](Vector2Tuple.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/boundsFromSize.md

@@ -0,0 +1,83 @@
+# boundsFromSize
+
+Creates immutable centered XY bounds from nonnegative dimensions in millimetres.
+
+## Call Signature
+
+
+
+**boundsFromSize**(`size`: [`Vector2Tuple`](Vector2Tuple.md), `options?`: [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md)): [`Bounds2`](Bounds2.md)
+
+
+
+Creates immutable centered XY bounds from nonnegative dimensions in millimetres.
+
+### Parameters
+
+<a id="size"></a>
+
+**`size`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md) · Optional
+
+- [`center`](BoundsFromSizeOptions.md#center) · `boolean` · Optional
+
+  Center on the origin; false starts at the origin. Defaults to true.
+
+
+
+### Returns
+
+[`Bounds2`](Bounds2.md)
+
+## Call Signature
+
+
+
+**boundsFromSize**(`size`: [`Vector3Tuple`](Vector3Tuple.md), `options?`: [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md)): [`Bounds3`](Bounds3.md)
+
+
+
+Creates immutable centered XYZ bounds from nonnegative dimensions in millimetres.
+
+### Parameters
+
+<a id="size-1"></a>
+
+**`size`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md) · Optional
+
+- [`center`](BoundsFromSizeOptions.md#center) · `boolean` · Optional
+
+  Center on the origin; false starts at the origin. Defaults to true.
+
+
+
+### Returns
+
+[`Bounds3`](Bounds3.md)
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [Bounds3](Bounds3.md)
+- [BoundsFromSizeOptions](BoundsFromSizeOptions.md)
+- [Vector2Tuple](Vector2Tuple.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/boundsSize.md

@@ -0,0 +1,62 @@
+# boundsSize
+
+Inclusive XY dimensions in millimetres; zero extents are retained.
+
+## Call Signature
+
+
+
+**boundsSize**(`bounds`: [`Bounds2`](Bounds2.md)): [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Inclusive XY dimensions in millimetres; zero extents are retained.
+
+### Parameters
+
+<a id="bounds"></a>
+
+**`bounds`** · [`Bounds2`](Bounds2.md) · Required
+
+
+
+### Returns
+
+[`Vector2Tuple`](Vector2Tuple.md)
+
+## Call Signature
+
+
+
+**boundsSize**(`bounds`: [`Bounds3`](Bounds3.md)): [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+Inclusive XYZ dimensions in millimetres; zero extents are retained.
+
+### Parameters
+
+<a id="bounds-1"></a>
+
+**`bounds`** · [`Bounds3`](Bounds3.md) · Required
+
+
+
+### Returns
+
+[`Vector3Tuple`](Vector3Tuple.md)
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [Bounds3](Bounds3.md)
+- [Vector2Tuple](Vector2Tuple.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/boxAnchor3.md

@@ -0,0 +1,52 @@
+# boxAnchor3
+
+Creates an outward face-center anchor using the same local origin convention as box().
+
+**boxAnchor3**(`options`: [`BoxAnchorOptions`](BoxAnchorOptions.md)): [`Anchor3`](Anchor3.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`BoxAnchorOptions`](BoxAnchorOptions.md) · Required
+
+- [`size`](BoxAnchorOptions.md#size) · `number` \| [`Vector3Tuple`](Vector3Tuple.md) · Required
+
+  XYZ dimensions, or one uniform dimension, in millimetres.
+
+- [`face`](BoxAnchorOptions.md#face) · [`BoxAnchorFace`](BoxAnchorFace.md) · Required
+
+  Named outward face whose center is the attachment point.
+
+- [`center`](BoxAnchorOptions.md#center) · `boolean` · Optional
+
+  Centers the box around its construction origin; defaults to true, matching box().
+
+- [`origin`](BoxAnchorOptions.md#origin) · [`Vector3Tuple`](Vector3Tuple.md) · Optional
+
+  Construction origin; centered-box center or noncentered minimum corner. Defaults to zero.
+
+
+
+## Returns
+
+[`Anchor3`](Anchor3.md)
+
+## Remarks
+
+origin applies an explicit translation. For rotated components, transform the
+resulting anchor frame explicitly; no anchor is inherited from a Boolean result.
+
+
+## Related APIs
+
+- [Anchor3](Anchor3.md)
+- [BoxAnchorOptions](BoxAnchorOptions.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/buildHelicalThreadRidgeMesh.md

@@ -0,0 +1,68 @@
+# buildHelicalThreadRidgeMesh
+
+Builds closed thread-ridge components with every profile locked to the shaft's radial/axial frame. The mesh is intended for union with its minor-envelope cylinder and never owns WASM objects.
+
+**buildHelicalThreadRidgeMesh**(`options`: [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md) · Required
+
+- [`length`](HelicalThreadRidgeMeshOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`majorDiameter`](HelicalThreadRidgeMeshOptions.md#majordiameter) · `number` · Required
+
+  Nominal major diameter before any caller-owned fit compensation.
+
+- [`profile`](HelicalThreadRidgeMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`ends`](HelicalThreadRidgeMeshOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](HelicalThreadRidgeMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](HelicalThreadRidgeMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](HelicalThreadRidgeMeshOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](HelicalThreadRidgeMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](HelicalThreadRidgeMeshOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](HelicalThreadRidgeMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+
+## Related APIs
+
+- [HelicalThreadRidgeMeshOptions](HelicalThreadRidgeMeshOptions.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/buildHelicalThreadSolidMesh.md

@@ -0,0 +1,102 @@
+# buildHelicalThreadSolidMesh
+
+Builds one closed threaded cylinder without a ridge/core Boolean seam.
+
+**buildHelicalThreadSolidMesh**(`options`: [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+Each circular facet includes its exact phase-shifted profile breakpoints, including duplicate-Z
+samples for vertical flanks and blunt transitions. Adjacent variable grids are stitched as a
+monotone strip, with optional intermediate rows bounded by physical `maxSegmentLength`. A
+conservative pre-allocation estimate rejects excessive meshes before constructing position
+arrays.
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md) · Required
+
+- [`length`](HelicalThreadSolidMeshOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`majorDiameter`](HelicalThreadSolidMeshOptions.md#majordiameter) · `number` · Required
+
+  Nominal major diameter before any caller-owned fit compensation.
+
+- [`profile`](HelicalThreadSolidMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`ends`](HelicalThreadSolidMeshOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](HelicalThreadSolidMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](HelicalThreadSolidMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](HelicalThreadSolidMeshOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](HelicalThreadSolidMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](HelicalThreadSolidMeshOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](HelicalThreadSolidMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`bevelBottom`](HelicalThreadSolidMeshOptions.md#bevelbottom) · `boolean` · Optional
+
+  Apply a 45-degree radial bevel at the lower target face.
+
+- [`bevelBottomSize`](HelicalThreadSolidMeshOptions.md#bevelbottomsize) · `number` · Optional
+
+  Lower bevel size override. Takes precedence over `bevelSize`.
+
+- [`bevelOffset`](HelicalThreadSolidMeshOptions.md#beveloffset) · `number` · Optional
+
+  Distance of each bevel target face inward from the corresponding mesh end.
+
+- [`bevelMode`](HelicalThreadSolidMeshOptions.md#bevelmode) · `"inset"` \| `"outset"` · Optional
+
+  `inset` trims an external rod; `outset` expands an internal cutter.
+
+- [`bevelSize`](HelicalThreadSolidMeshOptions.md#bevelsize) · `number` · Optional
+
+  Axial and radial bevel size. Defaults to the profile depth.
+
+- [`bevelTop`](HelicalThreadSolidMeshOptions.md#beveltop) · `boolean` · Optional
+
+  Apply a 45-degree radial bevel at the upper target face.
+
+- [`bevelTopSize`](HelicalThreadSolidMeshOptions.md#beveltopsize) · `number` · Optional
+
+  Upper bevel size override. Takes precedence over `bevelSize`.
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+
+## Related APIs
+
+- [HelicalThreadSolidMeshOptions](HelicalThreadSolidMeshOptions.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/categories/bounds-layout.md

@@ -0,0 +1,35 @@
+# Bounds & Layout
+
+Measure finite bounds, test positioned containment, and fit or arrange geometry.
+
+Bounds2 and Bounds3 are shared min/max data for text, mesh measurements, and placement. boundsFromSize creates centered bounds unless center is false. containsBounds tests actual positioned containment, including boundary contact. fitBounds uniformly scales and centers into a target, returning scale, position and resulting bounds; maxScale limits enlargement. layoutRow returns translations for a +X row with minimum Y/Z grounded at zero; supply bounds after intended rotations and apply positions through part options.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [boundsFromSize](../boundsFromSize.md) | Creates immutable centered XY bounds from nonnegative dimensions in millimetres. |
+| [boundsSize](../boundsSize.md) | Inclusive XY dimensions in millimetres; zero extents are retained. |
+| [boundsCenter](../boundsCenter.md) | Midpoint of finite XY bounds in millimetres. |
+| [containsBounds](../containsBounds.md) | Tests actual XY containment, including touching boundaries; dimensions must match. |
+| [fitBounds](../fitBounds.md) | Fits XY bounds uniformly and centers them in the target; zero source axes do not constrain scale. |
+| [layoutRow](../layoutRow.md) | Returns immutable translations for a +X row of finite XYZ bounds with a nonnegative gap. Each minimum Y/Z becomes zero, and the first minimum X becomes zero. Supply bounds after any intended part rotation; translations apply to those bounds. An empty input returns []. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [Bounds2](../Bounds2.md) | Axis-aligned bounds in two-dimensional model space. |
+| [Bounds3](../Bounds3.md) | Axis-aligned bounds in three-dimensional model space. |
+| [BoundsFromSizeOptions](../BoundsFromSizeOptions.md) | Placement of bounds constructed from nonnegative millimetre dimensions. |
+| [BoundsFitOptions](../BoundsFitOptions.md) | Uniform fitting controls; fitting centers the source inside the target. |
+| [BoundsFit2](../BoundsFit2.md) | A uniform XY scale followed by translation, and the resulting bounds. |
+| [BoundsFit3](../BoundsFit3.md) | A uniform XYZ scale followed by translation, and the resulting bounds. |
+| [RowLayoutOptions](../RowLayoutOptions.md) | Simple +X row placement with every minimum Y and Z grounded at zero. |
+
+## Guides
+
+- [Text from a Font parameter](../../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/categories/curves-paths.md

@@ -0,0 +1,66 @@
+# Curves and paths
+
+Sample reusable lines, arcs, cubic curves, and path frames with explicit physical policies.
+
+sampleCurve2/3 retain directed endpoints and tangents. Exact curve intervals are uniform in the curve parameter; resamplePolyline2/3 use equal arc length. Both resampling dimensions accept the same closed option and return points plus tangents; closed outputs include the closing edge without repeating the first point. Adaptive policies use millimetre deviation and edge length, with checked vertex ceilings. transformPath2 accepts Transform2 placements or Transform2Matrix data; transformPath3 accepts Transform3 placements or Transform3Matrix data. Paths retain point order after reflection. closestPointOnPath returns a point, distance, edge index and interpolation fraction on an open path or explicitly closed boundary. Sweep frames require explicit seam and orientation choices.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [anchorFrame3](../anchorFrame3.md) | Converts an anchor into a right-handed frame with direction as local +Z. |
+| [closestPointOnPath](../closestPointOnPath.md) | Finds the closest position anywhere on an open XY path or closed contour. |
+| [sampleCurve2](../sampleCurve2.md) | Samples a planar curve with the same guarantees and policy as spatial sampling. |
+| [sampleCurve3](../sampleCurve3.md) | Samples a spatial curve, preserving endpoints and directed unit tangents. |
+| [transformPath2](../transformPath2.md) | Applies a canonical affine XY transform to a 2D path without changing point order. |
+| [transformPath3](../transformPath3.md) | Applies an affine transform to a 3D path without mutating its points. |
+| [resolveGeometrySamplingLimits](../resolveGeometrySamplingLimits.md) | Resolves finite positive safe-integer allocation ceilings without ambient state. |
+| [resamplePolyline2](../resamplePolyline2.md) | Resamples a planar polyline with the same point, tangent, seam and budget guarantees as 3D. |
+| [resamplePolyline3](../resamplePolyline3.md) | Resamples a spatial polyline at equal arc lengths with directed outgoing tangents. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [ArcCurve2](../ArcCurve2.md) | Planar circular arc with counterclockwise degree angles. |
+| [ArcCurve3](../ArcCurve3.md) | Spatial circular arc in the plane of two orthogonal unit directions. |
+| [CubicBezierCurve2](../CubicBezierCurve2.md) | Planar cubic Bézier with explicit endpoint and control coordinates. |
+| [CubicBezierCurve3](../CubicBezierCurve3.md) | Spatial cubic Bézier with explicit endpoint and control coordinates. |
+| [ClosestPointOnPathOptions](../ClosestPointOnPathOptions.md) | Topology and work ceiling for a closest-point query on a sampled path. |
+| [ClosestPointOnPathResult](../ClosestPointOnPathResult.md) | Closest position on a sampled path, measured in millimetres. |
+| [CurveSamplingOptions](../CurveSamplingOptions.md) | Explicit physical sampling and allocation policy for reusable curves. |
+| [Frame3](../Frame3.md) | A right-handed orthonormal coordinate frame expressed in world coordinates. |
+| [GeometrySamplingLimits](../GeometrySamplingLimits.md) | Explicit allocation ceilings for pure sampling and host-owned modeling operations. |
+| [LineCurve2](../LineCurve2.md) | Straight planar curve in millimetres. |
+| [LineCurve3](../LineCurve3.md) | Straight spatial curve in millimetres. |
+| [PathFrame](../PathFrame.md) | Orthonormal right-handed frame sampled along a path. |
+| [PathPlacement](../PathPlacement.md) | Position and unit tangent for one path-distributed item. |
+| [SampledCurve2](../SampledCurve2.md) | Immutable planar points and corresponding directed unit tangents. |
+| [SampledCurve3](../SampledCurve3.md) | Immutable spatial points and corresponding directed unit tangents. |
+| [SampleHelixOptions](../SampleHelixOptions.md) | Options for a sampled +Z helix with millimetre dimensions. |
+| [PolylineResamplingOptions](../PolylineResamplingOptions.md) | Equal arc-length sampling of an open path or an implicitly closed loop. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [Curve2](../Curve2.md) | Reusable planar curve definition. |
+| [Curve3](../Curve3.md) | Reusable spatial curve definition. |
+| [Path2](../Path2.md) | An ordered, open sequence of two-dimensional points. |
+| [Path3](../Path3.md) | An ordered, open sequence of three-dimensional points. |
+| [PathNormalGuide](../PathNormalGuide.md) | Supplies a profile-X orientation guide for each original normalized sweep station. |
+
+## Values
+
+| API | Summary |
+| --- | --- |
+| [computeClosedParallelTransportFrames](../computeClosedParallelTransportFrames.md) | Builds rotation-minimizing frames for a non-duplicated closed path. |
+| [computeParallelTransportFrames](../computeParallelTransportFrames.md) | Builds rotation-minimizing frames by parallel-transporting the previous normal. This avoids the sudden profile flips produced by picking a fresh up-vector per ring. Paths exceeding maxPathPoints (default 100000) reject before frame allocation or guide evaluation. |
+| [cumulativePathLengths](../cumulativePathLengths.md) | Returns cumulative arc length for finite points under maxPathPoints (default 100000); rejects overflowing length. |
+| [defaultGeometrySamplingLimits](../defaultGeometrySamplingLimits.md) | Conservative defaults; trusted callers can supply larger explicit ceilings. |
+| [distributeAlongPath](../distributeAlongPath.md) | Places an exact item count at equal arc-length intervals along a sampled path. |
+| [pathLength](../pathLength.md) | Returns total sampled 3D path length, or zero for an empty path. |
+| [roundClosedPolylinePath](../roundClosedPolylinePath.md) | Replaces each vertex of a non-duplicated closed polyline with a sampled quadratic corner in the same coordinate system as the input. |
+| [sampleHelix](../sampleHelix.md) | Creates `segments + 1` points including exact helix endpoints from finite positive dimensions. Integrated weights must remain finite. The maxPathPoints ceiling defaults to 100000; excessive exact counts reject before evaluating axial weights or allocating sample arrays. |
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/categories/mechanical.md

@@ -0,0 +1,101 @@
+# Mechanical foundations
+
+Resolve gears, fastener standards, thread profiles, fit, and predictable allocations.
+
+Pure kernels resolve dimensions and emit outlines or meshes without native state. Keep physical clearance separate from Boolean overtravel. Thread and gear results are modeling aids rather than certified manufacturing or strength specifications.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [buildHelicalThreadRidgeMesh](../buildHelicalThreadRidgeMesh.md) | Builds closed thread-ridge components with every profile locked to the shaft's radial/axial frame. The mesh is intended for union with its minor-envelope cylinder and never owns WASM objects. |
+| [buildHelicalThreadSolidMesh](../buildHelicalThreadSolidMesh.md) | Builds one closed threaded cylinder without a ridge/core Boolean seam. |
+| [compensateThreadDiameters](../compensateThreadDiameters.md) | Applies role-specific radial compensation while preserving thread depth. |
+| [compensateThreadProfileAxially](../compensateThreadProfileAxially.md) | Applies axial fit allowance to a validated periodic profile. |
+| [compensateThreadProfileForFaceting](../compensateThreadProfileForFaceting.md) | Applies printable axial fit plus the conservative phase allowance required by circular facets. |
+| [createThreadProfile](../createThreadProfile.md) | Creates a periodic thread profile for the shaft-locked helical mesher. |
+| [getMetricClearanceHole](../getMetricClearanceHole.md) | Returns one recommended metric clearance-hole diameter in millimetres. |
+| [getMetricFastenerStandard](../getMetricFastenerStandard.md) | Returns the immutable standards record for one supported metric size. |
+| [measureInternalCylindricalGearPairMotion](../measureInternalCylindricalGearPairMotion.md) | Measures sampled kinematic interference over one tooth cycle of an internal gear pair. |
+| [minimumCylindricalGearToothCountWithoutUndercut](../minimumCylindricalGearToothCountWithoutUndercut.md) | Returns the smallest unshifted full-depth external tooth count that avoids rack-cutter undercut. |
+| [preflightHelicalThreadSolidMesh](../preflightHelicalThreadSolidMesh.md) | Validates a direct thread solid and returns its conservative allocation estimate without constructing vertex or index buffers. |
+| [preflightInternalThreadCutter](../preflightInternalThreadCutter.md) | Preflights the exact extended mesh used by the internal thread cutter constructor. |
+| [preflightThreadedNut](../preflightThreadedNut.md) | Resolves a nut's exact body/cutter chamfer and preflights its extended thread mesh without allocating Manifold WASM objects. |
+| [preflightThreadedRod](../preflightThreadedRod.md) | Preflights the exact compensated direct mesh used by the threaded rod constructor. |
+| [resolveCylindricalGear](../resolveCylindricalGear.md) | Resolves a validated unshifted full-depth external cylindrical gear. |
+| [resolveCylindricalGearPair](../resolveCylindricalGearPair.md) | Resolves ratio, center distance, and helix relationship for a gear pair. |
+| [resolvePrintableThreadFitPolicy](../resolvePrintableThreadFitPolicy.md) | Resolves and validates a named or caller-defined print-fit policy. |
+| [resolveRackPitch](../resolveRackPitch.md) | Resolves a rack segment that is conjugate with the same normal cylindrical pitch system. |
+| [resolveThreadCircularSegments](../resolveThreadCircularSegments.md) | Resolves a role-independent, start-aligned facet count from the larger female mating envelope. |
+| [sampleCylindricalGearOutline](../sampleCylindricalGearOutline.md) | Samples a complete external involute gear boundary in the XY plane. |
+| [sampleInternalCylindricalGearSpaceOutline](../sampleInternalCylindricalGearSpaceOutline.md) | Samples the center opening and tooth spaces used to subtract an internal ring gear. |
+| [sampleRackToothPath](../sampleRackToothPath.md) | Samples the open top boundary of a finite rack in its XY pitch plane. |
+| [sampleThreadHelices](../sampleThreadHelices.md) | Samples evenly phased thread helices with finite `lead = pitch * starts`. All starts together respect maxPathPoints (default 100000); excessive counts fail before allocation. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [AcmeThreadProfileSpec](../AcmeThreadProfileSpec.md) | ACME 29-degree included-angle profile. |
+| [ButtressThreadProfileSpec](../ButtressThreadProfileSpec.md) | Asymmetric printable buttress profile with 7/45-degree flanks. |
+| [ClearanceHoleDimensions](../ClearanceHoleDimensions.md) | Close, normal, and loose metric clearance-hole diameters in millimetres. |
+| [CompensatedThreadDiameters](../CompensatedThreadDiameters.md) | Compensated major/minor envelopes and the policy values used. |
+| [CustomThreadProfileSpec](../CustomThreadProfileSpec.md) | Caller-defined periodic axial/radial profile in millimetres. |
+| [CylindricalGearDimensions](../CylindricalGearDimensions.md) | Resolved transverse pitch-plane dimensions for one cylindrical gear. |
+| [CylindricalGearOutlineOptions](../CylindricalGearOutlineOptions.md) | Sampling controls for a complete non-duplicated gear outline. |
+| [CylindricalGearPairDimensions](../CylindricalGearPairDimensions.md) | Pitch solution for a coordinated cylindrical gear pair. |
+| [CylindricalGearPairMotionOptions](../CylindricalGearPairMotionOptions.md) | Sampling controls for one coupled internal-gear tooth cycle. |
+| [CylindricalGearPairMotionReport](../CylindricalGearPairMotionReport.md) | Maximum sampled planar overlap for an external pinion inside an internal ring. |
+| [CylindricalGearPairSpec](../CylindricalGearPairSpec.md) | Inputs for resolving a coordinated cylindrical gear pair. |
+| [CylindricalGearSpec](../CylindricalGearSpec.md) | Nominal dimensions for a standard full-depth cylindrical involute gear. |
+| [HelicalThreadRidgeMeshOptions](../HelicalThreadRidgeMeshOptions.md) | Runtime-neutral options for the dedicated helical ridge mesher. |
+| [HelicalThreadSolidMeshOptions](../HelicalThreadSolidMeshOptions.md) | Options for a complete threaded-cylinder mesh; base semantics match the ridge builder. |
+| [HelicalThreadSolidMeshPreflight](../HelicalThreadSolidMeshPreflight.md) | Conservative allocation facts resolved before constructing a direct thread solid mesh. |
+| [InternalThreadCutterOptions](../InternalThreadCutterOptions.md) | Options for a compensated internal-thread subtraction tool along +Z. |
+| [MetricFastenerStandard](../MetricFastenerStandard.md) | Small immutable metric fastener record for modeling common mating features. |
+| [MetricHexNutDimensions](../MetricHexNutDimensions.md) | Regular hex-nut envelope dimensions in millimetres. |
+| [MetricSocketCapHeadDimensions](../MetricSocketCapHeadDimensions.md) | Socket-head cap screw head and drive dimensions in millimetres. |
+| [PrintableThreadFitPolicy](../PrintableThreadFitPolicy.md) | Explicit radial and axial allowances for a mating printed thread pair. |
+| [RackPitchDimensions](../RackPitchDimensions.md) | Resolved pitch-line dimensions for a finite rack segment. |
+| [RackPitchSpec](../RackPitchSpec.md) | Normal-plane inputs for a finite rack pitch segment. |
+| [SampledThreadHelices](../SampledThreadHelices.md) | Sampled paths plus conventional pitch and lead measurements. |
+| [SquareThreadProfileSpec](../SquareThreadProfileSpec.md) | Square profile with equal crest and root widths. |
+| [ThreadBevelOptions](../ThreadBevelOptions.md) | End bevel controls shared by threaded rods and cutters. |
+| [ThreadCircularSegmentsOptions](../ThreadCircularSegmentsOptions.md) | Inputs for resolving one shared circular facet count for a mating thread pair. |
+| [ThreadCompensationOptions](../ThreadCompensationOptions.md) | Options for compensating nominal male or female thread diameters. |
+| [ThreadedNutOptions](../ThreadedNutOptions.md) | Options for a compensated nut with an internal thread. |
+| [ThreadedNutPreflight](../ThreadedNutPreflight.md) | Allocation-free body, cutter, and end-face facts resolved for a threaded nut. |
+| [ThreadedRodOptions](../ThreadedRodOptions.md) | Options for a compensated external threaded rod along +Z. |
+| [ThreadEndTreatmentOptions](../ThreadEndTreatmentOptions.md) | Axial end controls for a generated ridge. |
+| [ThreadHelixOptions](../ThreadHelixOptions.md) | Conventional helix options: `pitch` is adjacent spacing and lead is `pitch * starts`. |
+| [ThreadProfile](../ThreadProfile.md) | A validated immutable periodic thread profile in `[axial, radial]` millimetres. |
+| [ThreadProfileBaseSpec](../ThreadProfileBaseSpec.md) | Fields shared by all thread profile specifications. |
+| [TrapezoidalThreadProfileSpec](../TrapezoidalThreadProfileSpec.md) | Trapezoidal thread profile with a configurable included angle. |
+| [TriangularThreadProfileSpec](../TriangularThreadProfileSpec.md) | ISO/UTS-like 60-degree truncated triangular profile. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [ButtressPressureFlankSide](../ButtressPressureFlankSide.md) | Axial side carrying the near-normal pressure flank of a buttress thread. |
+| [ClearanceHoleFit](../ClearanceHoleFit.md) | Common clearance-hole fit categories, ordered from smallest to largest. |
+| [CylindricalGearMeshKind](../CylindricalGearMeshKind.md) | Whether two cylindrical gears mesh on their outside teeth or as a pinion inside a ring. |
+| [MetricFastenerSize](../MetricFastenerSize.md) | Metric fastener sizes included in the first mechanical standards table. |
+| [PrintableThreadFit](../PrintableThreadFit.md) | Named baseline fit policies for calibrated FDM-style printed threads. |
+| [ThreadedNutBevel](../ThreadedNutBevel.md) | Nut-edge bevel selection. |
+| [ThreadedNutShape](../ThreadedNutShape.md) | Supported printable nut body shapes. |
+| [ThreadEndStyle](../ThreadEndStyle.md) | End shape of a generated helical ridge. |
+| [ThreadHandedness](../ThreadHandedness.md) | Direction in which a conventional helical thread advances around +Z. |
+| [ThreadLeadInEnvelope](../ThreadLeadInEnvelope.md) | Radial envelope toward which a blunt lead-in collapses. |
+| [ThreadLeadInShape](../ThreadLeadInShape.md) | BOSL2-compatible cross-section scaling curve for a blunt thread lead-in. |
+| [ThreadProfileSpec](../ThreadProfileSpec.md) | Supported built-in and caller-defined thread profiles. |
+| [ThreadRole](../ThreadRole.md) | Whether compensation is being applied to an external or internal thread. |
+
+## Values
+
+| API | Summary |
+| --- | --- |
+| [METRIC_FASTENER_STANDARDS](../METRIC_FASTENER_STANDARDS.md) | Curated metric modeling dimensions for clearance holes, regular hex nuts, and socket-head cap screws. |
+| [PRINTABLE_THREAD_FIT_POLICIES](../PRINTABLE_THREAD_FIT_POLICIES.md) | Conservative baseline print-fit policies in millimetres. |
+
+Package: `@metamesh/modeling@0.14.0`.