@metamesh/modeling 0.18.0 → 0.20.0

package/dist/docs/reference/{geometry → mechanical}/compensateThreadProfileForFaceting.md

@@ -18,30 +18,40 @@ it exactly.
 
 **`profile`** · [`ThreadProfile`](ThreadProfile-type.md) · Required
 
+Uncompensated `[axial, radial]` profile in millimetres.
+
 
 
 <a id="axialbacklash"></a>
 
 **`axialBacklash`** · `number` · Required
 
+Nonnegative total pair allowance in millimetres, below half the pitch.
+
 
 
 <a id="role"></a>
 
 **`role`** · `"female"` \| `"male"` · Required
 
+Male ridge or female cutter receiving its share of the allowances.
+
 
 
 <a id="starts"></a>
 
 **`starts`** · `number` · Required
 
+Integer start count from 1 through 32.
+
 
 
 <a id="circularsegments"></a>
 
 **`circularSegments`** · `number` · Required
 
+Full-circle facet count, at least 3 and divisible by starts.
+
 
 
 ## Returns
@@ -55,6 +65,12 @@ it exactly.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { compensateThreadProfileForFaceting } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/getMetricClearanceHoleDiameter.md

@@ -32,6 +32,12 @@ Returns one recommended metric clearance-hole diameter in millimetres.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { getMetricClearanceHoleDiameter } from "@metamesh/modeling/geometry/mechanical";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/getMetricFastenerStandard.md

@@ -26,6 +26,12 @@ Returns the immutable standards record for one supported metric size.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { getMetricFastenerStandard } from "@metamesh/modeling/geometry/mechanical";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/measureInternalCylindricalGearPairMotion.md

@@ -7,10 +7,10 @@ Measures sampled kinematic interference over one tooth cycle of an internal gear
 
 
 The driver and ring start with half-tooth offsets for odd tooth counts, then rotate in the
-same direction at their resolved tooth-count ratio. Each
-sampled pinion outline is subtracted from the ring's center-and-space opening; remaining area is
-solid overlap. This catches involute, tip, and trimming interference that a single assembled pose
-misses. It is a deterministic model check, not a certified gear-rating calculation.
+same direction at their resolved tooth-count ratio. Subtracting the ring's center-and-space
+opening from each sampled pinion outline leaves the area overlapping ring material. This detects
+involute, tip, and trimming interference that a single assembled pose misses.
+It is a deterministic model check, not a certified gear-rating calculation.
 
 ## Parameters
 
@@ -18,6 +18,8 @@ misses. It is a deterministic model check, not a certified gear-rating calculati
 
 **`spec`** · [`CylindricalGearPairSpec`](CylindricalGearPairSpec.md) · Required
 
+Internal pair: external driver pinion and internal driven ring.
+
 
 
 <a id="options"></a>
@@ -47,6 +49,12 @@ misses. It is a deterministic model check, not a certified gear-rating calculati
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { measureInternalCylindricalGearPairMotion } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/minimumCylindricalGearToothCountWithoutUndercut.md

@@ -15,6 +15,8 @@ count `z_v = z / cos³(beta)`, so increasing helix angle can reduce the physical
 
 **`spec`** · `Readonly`\<`Pick`\<[`CylindricalGearSpec`](CylindricalGearSpec.md), `"helixAngle"` \| `"pressureAngle"`\>\> · Optional
 
+Pressure and signed helix angles in degrees; defaults are 20 and zero.
+
 
 
 ## Returns
@@ -28,6 +30,12 @@ count `z_v = z / cos³(beta)`, so increasing helix angle can reduce the physical
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { minimumCylindricalGearToothCountWithoutUndercut } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/preflightInternalThreadCutter.md

@@ -20,6 +20,8 @@ See `mesh.threadSolid` for standalone mesh construction.
 
 **`options`** · [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md) · Required
 
+Nominal cavity dimensions in millimetres, before fit and face extension.
+
 - [`nominalMajorDiameter`](InternalThreadCutterOptions.md#nominalmajordiameter) · `number` · Required
 
   Nominal major diameter before female compensation and faceting correction.
@@ -50,7 +52,7 @@ See `mesh.threadSolid` for standalone mesh construction.
 
   Helix direction. Default: `right`.
 
-- [`limits`](InternalThreadCutterOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+- [`limits`](InternalThreadCutterOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
 
   Explicit output and circular allocation ceilings.
 
@@ -58,7 +60,7 @@ See `mesh.threadSolid` for standalone mesh construction.
 
   Angular offset of the first start in degrees. Default: `0`.
 
-- [`resolution`](InternalThreadCutterOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](InternalThreadCutterOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Optional circular-resolution policy.
 
@@ -66,7 +68,7 @@ See `mesh.threadSolid` for standalone mesh construction.
 
   Number of evenly phased starts. Default: `1`.
 
-- [`tolerance`](InternalThreadCutterOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+- [`tolerance`](InternalThreadCutterOptions.md#tolerance) · [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md) · Optional
 
   Optional numerical tolerance overrides.
 
@@ -84,6 +86,12 @@ See `mesh.threadSolid` for standalone mesh construction.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { preflightInternalThreadCutter } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/preflightThreadedNut.md

@@ -19,6 +19,8 @@ See `mesh.preflightThreadSolid` for standalone mesh estimates.
 
 **`options`** · [`ThreadedNutOptions`](ThreadedNutOptions.md) · Required
 
+Nominal nut dimensions in millimetres, fit, and sampling controls.
+
 - [`nominalMajorDiameter`](ThreadedNutOptions.md#nominalmajordiameter) · `number` · Required
 
   Nominal major diameter before female compensation and faceting correction.
@@ -52,7 +54,7 @@ See `mesh.preflightThreadSolid` for standalone mesh estimates.
   Body bevels in [bottom, top] order. Omitted or auto uses min(profile.depth, thickness/4).
   Use [0, "auto"] to keep the outside bottom flat without disabling its inner opening bevel.
 
-- [`bodyResolution`](ThreadedNutOptions.md#bodyresolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`bodyResolution`](ThreadedNutOptions.md#bodyresolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Optional physical policy for a round body, independent of the thread's matched facet grid.
 
@@ -65,7 +67,7 @@ See `mesh.preflightThreadSolid` for standalone mesh estimates.
 
   Helix direction. Default: `right`.
 
-- [`limits`](ThreadedNutOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+- [`limits`](ThreadedNutOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
 
   Explicit output and circular allocation ceilings.
 
@@ -73,7 +75,7 @@ See `mesh.preflightThreadSolid` for standalone mesh estimates.
 
   Angular offset of the first start in degrees. Default: `0`.
 
-- [`resolution`](ThreadedNutOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](ThreadedNutOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Optional circular-resolution policy.
 
@@ -81,7 +83,7 @@ See `mesh.preflightThreadSolid` for standalone mesh estimates.
 
   Number of evenly phased starts. Default: `1`.
 
-- [`tolerance`](ThreadedNutOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+- [`tolerance`](ThreadedNutOptions.md#tolerance) · [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md) · Optional
 
   Optional numerical tolerance overrides.
 
@@ -99,6 +101,12 @@ See `mesh.preflightThreadSolid` for standalone mesh estimates.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { preflightThreadedNut } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/preflightThreadedRod.md

@@ -19,6 +19,8 @@ See `mesh.threadSolid` for standalone mesh construction.
 
 **`options`** · [`ThreadedRodOptions`](ThreadedRodOptions.md) · Required
 
+Nominal rod dimensions in millimetres, fit, and sampling controls.
+
 - [`nominalMajorDiameter`](ThreadedRodOptions.md#nominalmajordiameter) · `number` · Required
 
   Nominal major diameter before male compensation.
@@ -49,7 +51,7 @@ See `mesh.threadSolid` for standalone mesh construction.
 
   Helix direction. Default: `right`.
 
-- [`limits`](ThreadedRodOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+- [`limits`](ThreadedRodOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
 
   Explicit output and circular allocation ceilings.
 
@@ -57,7 +59,7 @@ See `mesh.threadSolid` for standalone mesh construction.
 
   Angular offset of the first start in degrees. Default: `0`.
 
-- [`resolution`](ThreadedRodOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](ThreadedRodOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Optional circular-resolution policy.
 
@@ -65,7 +67,7 @@ See `mesh.threadSolid` for standalone mesh construction.
 
   Number of evenly phased starts. Default: `1`.
 
-- [`tolerance`](ThreadedRodOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+- [`tolerance`](ThreadedRodOptions.md#tolerance) · [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md) · Optional
 
   Optional numerical tolerance overrides.
 
@@ -83,6 +85,12 @@ See `mesh.threadSolid` for standalone mesh construction.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { preflightThreadedRod } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/resolveCylindricalGear.md

@@ -16,6 +16,8 @@ currently supported.
 
 **`spec`** · [`CylindricalGearSpec`](CylindricalGearSpec.md) · Required
 
+Nominal gear dimensions in millimetres and degrees.
+
 
 
 ## Returns
@@ -30,6 +32,12 @@ currently supported.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { resolveCylindricalGear } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/resolveCylindricalGearPair.md

@@ -16,6 +16,8 @@ the same hand. The function validates those conjugate pitch invariants.
 
 **`spec`** · [`CylindricalGearPairSpec`](CylindricalGearPairSpec.md) · Required
 
+Driver and driven gears using the same normal pitch system.
+
 
 
 ## Returns
@@ -30,6 +32,12 @@ the same hand. The function validates those conjugate pitch invariants.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { resolveCylindricalGearPair } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/resolveKnuckleHinge.md

@@ -11,8 +11,8 @@ shaft's complete rotational envelope. Adaptive sampling satisfies both face and
 bounds; an insufficient ceiling rejects instead of reducing quality. Exact counts are intentional
 facets. Zero allowances describe ideal contact, not a printable running fit.
 
-Rejects nonfinite or nonpositive dimensions, invalid mode/count combinations, exhausted axial
-length, missing/excessive lift-off engagement, and nonpositive conservative faceted barrel walls.
+Rejects non-finite or non-positive dimensions, invalid mode/count combinations, exhausted axial
+length, missing/excessive lift-off engagement, and non-positive conservative faceted barrel walls.
 Manufacturing minima, strength, mounting, retention, handedness, and motion remain caller policy.
 
 ## Parameters
@@ -21,6 +21,8 @@ Manufacturing minima, strength, mounting, retention, handedness, and motion rema
 
 **`spec`** · [`KnuckleHingeSpec`](KnuckleHingeSpec.md) · Required
 
+Joint dimensions in millimetres, mode, and knuckle count.
+
 
 
 <a id="options"></a>
@@ -31,11 +33,11 @@ Manufacturing minima, strength, mounting, retention, handedness, and motion rema
 
   Exact full-circle count, divisible by four and at least four; overrides adaptive sampling.
 
-- [`resolution`](KnuckleHingeSamplingOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](KnuckleHingeSamplingOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Physical tessellation policy. Exact circular counts must also be divisible by four.
 
-- [`limits`](KnuckleHingeSamplingOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+- [`limits`](KnuckleHingeSamplingOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\> · Optional
 
   Explicit allocation ceilings; defaults to the pure geometry sampling limits.
 
@@ -54,6 +56,12 @@ Manufacturing minima, strength, mounting, retention, handedness, and motion rema
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { resolveKnuckleHinge } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/resolvePrintableThreadFitPolicy.md

@@ -12,6 +12,8 @@ Resolves and validates a named or caller-defined print-fit policy.
 
 **`fit`** · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
 
+Named fit or non-negative per-side radial and total axial allowances, in millimetres.
+
 
 
 ## Returns
@@ -26,6 +28,12 @@ Resolves and validates a named or caller-defined print-fit policy.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { resolvePrintableThreadFitPolicy } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/resolveRackPitch.md

@@ -12,6 +12,8 @@ Resolves a rack segment that is conjugate with the same normal cylindrical pitch
 
 **`spec`** · [`RackPitchSpec`](RackPitchSpec.md) · Required
 
+Rack dimensions in millimetres and degrees.
+
 
 
 ## Returns
@@ -26,6 +28,12 @@ Resolves a rack segment that is conjugate with the same normal cylindrical pitch
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { resolveRackPitch } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/resolveThreadCircularSegments.md

@@ -15,6 +15,8 @@ raised. Adaptive policies align upward and fail if that would exceed `maxSegment
 
 **`options`** · [`ThreadCircularSegmentsOptions`](ThreadCircularSegmentsOptions.md) · Required
 
+Nominal diameter, uncompensated profile, and shared mating resolution.
+
 - [`nominalMajorDiameter`](ThreadCircularSegmentsOptions.md#nominalmajordiameter) · `number` · Required
 
   Nominal major diameter before role-specific compensation.
@@ -23,7 +25,7 @@ raised. Adaptive policies align upward and fail if that would exceed `maxSegment
 
   Validated mating profile whose pitch and flank capacities govern tessellation.
 
-- [`limits`](ThreadCircularSegmentsOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+- [`limits`](ThreadCircularSegmentsOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\> · Optional
 
   Explicit circular allocation ceiling for the shared mating grid.
 
@@ -37,7 +39,7 @@ raised. Adaptive policies align upward and fail if that would exceed `maxSegment
   This keeps a compensated male/female pair on one role-independent grid when an internal
   cutter has an enlarged entrance bevel. Default: `0`.
 
-- [`resolution`](ThreadCircularSegmentsOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](ThreadCircularSegmentsOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Physical or exact circular resolution policy.
 
@@ -58,6 +60,12 @@ raised. Adaptive policies align upward and fail if that would exceed `maxSegment
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { resolveThreadCircularSegments } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/sampleCylindricalGearOutline.md

@@ -2,7 +2,7 @@
 
 Samples a complete external involute gear boundary in the XY plane.
 
-**sampleCylindricalGearOutline**(`spec`: [`CylindricalGearSpec`](CylindricalGearSpec.md), `options?`: [`CylindricalGearOutlineOptions`](CylindricalGearOutlineOptions.md)): [`Contour`](Contour.md)
+**sampleCylindricalGearOutline**(`spec`: [`CylindricalGearSpec`](CylindricalGearSpec.md), `options?`: [`CylindricalGearOutlineOptions`](CylindricalGearOutlineOptions.md)): [`Contour`](../geometry/Contour.md)
 
 
 
@@ -16,6 +16,8 @@ seam point, and contains no holes. Its center is the origin and its axis is
 
 **`spec`** · [`CylindricalGearSpec`](CylindricalGearSpec.md) · Required
 
+External gear dimensions in millimetres and degrees; undercut profiles reject.
+
 
 
 <a id="options"></a>
@@ -30,11 +32,11 @@ seam point, and contains no holes. Its center is the origin and its axis is
 
   Exact samples along each bottom land, at least one, within selected circular/profile ceilings.
 
-- [`limits`](CylindricalGearOutlineOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+- [`limits`](CylindricalGearOutlineOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\> · Optional
 
   Explicit profile and circular allocation ceilings.
 
-- [`resolution`](CylindricalGearOutlineOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](CylindricalGearOutlineOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Explicit physical sampling policy for adaptive defaults.
 
@@ -46,17 +48,22 @@ seam point, and contains no holes. Its center is the origin and its axis is
 
 ## Returns
 
-[`Contour`](Contour.md)
+[`Contour`](../geometry/Contour.md)
 
 
 ## Related APIs
 
-- [Contour](Contour.md)
 - [CylindricalGearOutlineOptions](CylindricalGearOutlineOptions.md)
 - [CylindricalGearSpec](CylindricalGearSpec.md)
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { sampleCylindricalGearOutline } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/sampleInternalCylindricalGearSpaceOutline.md

@@ -2,7 +2,7 @@
 
 Samples the center opening and tooth spaces used to subtract an internal ring gear.
 
-**sampleInternalCylindricalGearSpaceOutline**(`spec`: [`CylindricalGearSpec`](CylindricalGearSpec.md), `options?`: [`CylindricalGearOutlineOptions`](CylindricalGearOutlineOptions.md)): [`Contour`](Contour.md)
+**sampleInternalCylindricalGearSpaceOutline**(`spec`: [`CylindricalGearSpec`](CylindricalGearSpec.md), `options?`: [`CylindricalGearOutlineOptions`](CylindricalGearOutlineOptions.md)): [`Contour`](../geometry/Contour.md)
 
 
 
@@ -17,6 +17,8 @@ when used as a region hole.
 
 **`spec`** · [`CylindricalGearSpec`](CylindricalGearSpec.md) · Required
 
+Internal ring dimensions in millimetres and degrees; backlash widens tooth spaces.
+
 
 
 <a id="options"></a>
@@ -31,11 +33,11 @@ when used as a region hole.
 
   Exact samples along each bottom land, at least one, within selected circular/profile ceilings.
 
-- [`limits`](CylindricalGearOutlineOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+- [`limits`](CylindricalGearOutlineOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\> · Optional
 
   Explicit profile and circular allocation ceilings.
 
-- [`resolution`](CylindricalGearOutlineOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](CylindricalGearOutlineOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Explicit physical sampling policy for adaptive defaults.
 
@@ -47,17 +49,22 @@ when used as a region hole.
 
 ## Returns
 
-[`Contour`](Contour.md)
+[`Contour`](../geometry/Contour.md)
 
 
 ## Related APIs
 
-- [Contour](Contour.md)
 - [CylindricalGearOutlineOptions](CylindricalGearOutlineOptions.md)
 - [CylindricalGearSpec](CylindricalGearSpec.md)
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { sampleInternalCylindricalGearSpaceOutline } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/sampleRackToothPath.md

@@ -2,7 +2,7 @@
 
 Samples the open top boundary of a finite rack in its XY pitch plane.
 
-**sampleRackToothPath**(`spec`: [`RackPitchSpec`](RackPitchSpec.md), `limits?`: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>): readonly [`Vector2Data`](Vector2Data.md)[]
+**sampleRackToothPath**(`spec`: [`RackPitchSpec`](RackPitchSpec.md), `limits?`: `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\>): readonly [`Vector2Data`](../geometry/Vector2Data.md)[]
 
 
 
@@ -17,27 +17,35 @@ the owning generator.
 
 **`spec`** · [`RackPitchSpec`](RackPitchSpec.md) · Required
 
+Rack dimensions in millimetres and degrees, along +X.
+
 
 
 <a id="limits"></a>
 
-**`limits`** · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+**`limits`** · `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\> · Optional
+
+Sampling limits; exceeding them throws without coarsening.
 
 
 
 ## Returns
 
-readonly [`Vector2Data`](Vector2Data.md)[]
+readonly [`Vector2Data`](../geometry/Vector2Data.md)[]
 
 
 ## Related APIs
 
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
 - [RackPitchSpec](RackPitchSpec.md)
-- [Vector2Data](Vector2Data.md)
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { sampleRackToothPath } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.