@metamesh/modeling 0.12.0 → 0.14.0

package/dist/docs/reference/model/loft.md

@@ -0,0 +1,137 @@
+# loft
+
+Lofts primitive Sections at z heights or frames; arbitrary Sections and loops require an explicit correspondence method.
+
+## Call Signature
+
+
+
+**loft**(`stations`: readonly [`LoftStation`](LoftStation.md)[], `options?`: [`LoftOptions`](LoftOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Loft
+
+
+
+```ts
+loft([
+  { profile: circle({ diameter: 16 }), z: 0 },
+  { profile: rectangle({ size: [30, 20], treatment: { kind: "round", radius: 3 } }), z: 30 },
+]);
+```
+
+
+
+Lofts primitive Sections at z heights or frames; arbitrary Sections and loops require an explicit correspondence method.
+
+### Parameters
+
+<a id="stations"></a>
+
+**`stations`** · readonly [`LoftStation`](LoftStation.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`LoftOptions`](LoftOptions.md) · Optional
+
+- [`correspondence`](LoftOptions.md#correspondence) · [`LoftCorrespondence`](LoftCorrespondence.md) \| readonly [`LoftCorrespondence`](LoftCorrespondence.md)[] · Optional
+
+  One method or one per consecutive station gap. Omitted preserves known landmarks, including circle/ellipse-to-rectangle corners, or maps other unlike primitive seams directly.
+
+- [`distribution`](LoftOptions.md#distribution) · `"perimeter"` \| `"segments"` · Optional
+
+  Extra points follow edge length or distribute equally across existing segments. Defaults to perimeter for direct/reindex, or segments when any distance method is selected; distance methods require segments.
+
+- [`refine`](LoftOptions.md#refine) · `number` \| readonly `number`[] · Optional
+
+  Positive integer point-density multiplier, uniformly or per input profile. Original vertices are retained. Defaults to one.
+
+- [`slices`](LoftOptions.md#slices) · `number` \| readonly `number`[] · Optional
+
+  Nonnegative count of world-linearly interpolated profiles, uniformly or per gap. Defaults to zero.
+
+- [`resolution`](LoftOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Physical curve policy for retained primitives, and maximum edge length for point data. Exact primitive curve counts take precedence.
+
+- [`limits`](LoftOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling budgets; native operations may only lower host ceilings.
+
+
+
+### Returns
+
+[`Solid`](Solid.md)
+
+## Call Signature
+
+
+
+**loft**(`stations`: readonly [`CorrespondingProfileStation`](CorrespondingProfileStation.md)[], `options?`: [`LoftOptions`](LoftOptions.md)): [`Solid`](Solid.md)
+
+
+
+Lofts explicit corresponding contours, including holes and collapsed logical slots.
+
+### Parameters
+
+<a id="stations-1"></a>
+
+**`stations`** · readonly [`CorrespondingProfileStation`](CorrespondingProfileStation.md)[] · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`LoftOptions`](LoftOptions.md) · Optional
+
+- [`correspondence`](LoftOptions.md#correspondence) · [`LoftCorrespondence`](LoftCorrespondence.md) \| readonly [`LoftCorrespondence`](LoftCorrespondence.md)[] · Optional
+
+  One method or one per consecutive station gap. Omitted preserves known landmarks, including circle/ellipse-to-rectangle corners, or maps other unlike primitive seams directly.
+
+- [`distribution`](LoftOptions.md#distribution) · `"perimeter"` \| `"segments"` · Optional
+
+  Extra points follow edge length or distribute equally across existing segments. Defaults to perimeter for direct/reindex, or segments when any distance method is selected; distance methods require segments.
+
+- [`refine`](LoftOptions.md#refine) · `number` \| readonly `number`[] · Optional
+
+  Positive integer point-density multiplier, uniformly or per input profile. Original vertices are retained. Defaults to one.
+
+- [`slices`](LoftOptions.md#slices) · `number` \| readonly `number`[] · Optional
+
+  Nonnegative count of world-linearly interpolated profiles, uniformly or per gap. Defaults to zero.
+
+- [`resolution`](LoftOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Physical curve policy for retained primitives, and maximum edge length for point data. Exact primitive curve counts take precedence.
+
+- [`limits`](LoftOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling budgets; native operations may only lower host ceilings.
+
+
+
+### Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [CorrespondingProfileStation](CorrespondingProfileStation.md)
+- [LoftOptions](LoftOptions.md)
+- [LoftStation](LoftStation.md)
+- [Solid](Solid.md)
+
+## Guides
+
+- [Revolve a radial profile](../../guides/recipes.md#revolve-a-radial-profile)
+- [Rotation-minimizing path sweep](../../guides/recipes.md#rotation-minimizing-path-sweep)
+- [Matched-section loft](../../guides/recipes.md#matched-section-loft)
+- [Choose a modeling path](../../guides/concepts.md#choose-a-modeling-path)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/matchProfiles.md

@@ -0,0 +1,42 @@
+# matchProfiles
+
+Explicit family matching on a shared physical span grid using session or operation resolution.
+
+**matchProfiles**(`profiles`: readonly [`Profile`](Profile.md)[], `options?`: [`MatchProfilesOptions`](MatchProfilesOptions.md)): readonly [`CorrespondingProfile`](CorrespondingProfile.md)[]
+
+
+
+## Parameters
+
+<a id="profiles"></a>
+
+**`profiles`** · readonly [`Profile`](Profile.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`MatchProfilesOptions`](MatchProfilesOptions.md) · Optional
+
+- [`resolution`](MatchProfilesOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+- [`limits`](MatchProfilesOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit per-profile and circular ceilings; the family also has a one-million-slot work bound.
+
+
+
+## Returns
+
+readonly [`CorrespondingProfile`](CorrespondingProfile.md)[]
+
+
+## Related APIs
+
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [MatchProfilesOptions](MatchProfilesOptions.md)
+- [Profile](Profile.md)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/minkowskiSum.md

@@ -0,0 +1,37 @@
+# minkowskiSum
+
+Three-dimensional Minkowski sum.
+
+**minkowskiSum**(`a`: [`Solid`](Solid.md), `b`: [`Solid`](Solid.md)): [`Solid`](Solid.md)
+
+
+
+## Parameters
+
+<a id="a"></a>
+
+**`a`** · [`Solid`](Solid.md) · Required
+
+
+
+<a id="b"></a>
+
+**`b`** · [`Solid`](Solid.md) · Required
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+
+## Guides
+
+- [Choose the Boolean by the material you want](../../guides/fundamentals.md#choose-the-boolean-by-the-material-you-want)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/pathPattern.md

@@ -0,0 +1,118 @@
+# pathPattern
+
+Physical arc-length copies along a sampled path, with optional tangent orientation.
+
+## Call Signature
+
+
+
+**pathPattern**(`source`: [`PatternSource`](PatternSource.md), `path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `options`: [`PathPatternOptions`](PathPatternOptions.md)): readonly [`Solid`](Solid.md)[]
+
+
+
+## Example: Copies along a bent path
+
+```ts
+pathPattern(box({ size: 4 }), [[0, 0, 0], [20, 0, 0], [20, 20, 0]], { count: 5 });
+```
+
+Physical arc-length copies along a sampled path, with optional tangent orientation.
+
+### Parameters
+
+<a id="source"></a>
+
+**`source`** · [`PatternSource`](PatternSource.md) · Required
+
+
+
+<a id="path"></a>
+
+**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`PathPatternOptions`](PathPatternOptions.md) · Required
+
+- [`count`](PathPatternOptions.md#count) · `number` · Required
+
+  Positive number of copies; open paths include both endpoints when greater than one.
+
+- [`closed`](PathPatternOptions.md#closed) · `boolean` · Optional
+
+  Include the closing edge without duplicating the seam; defaults to false.
+
+- [`orientation`](PathPatternOptions.md#orientation) · `"fixed"` \| `"tangent"` · Optional
+
+  Preserve the source orientation, or align its +Z to the path tangent; defaults to fixed.
+
+
+
+### Returns
+
+readonly [`Solid`](Solid.md)[]
+
+## Call Signature
+
+
+
+**pathPattern**(`source`: [`PatternSource`](PatternSource.md)\<[`Section`](Section.md)\>, `path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `options`: [`PathPatternOptions`](PathPatternOptions.md)): readonly [`Section`](Section.md)[]
+
+
+
+Repeats a filled Section along a sampled XY path at Z=0. Fixed orientation preserves XY;
+tangent orientation maps +Z to the tangent and rejects when that leaves the plane.
+
+### Parameters
+
+<a id="source-1"></a>
+
+**`source`** · [`PatternSource`](PatternSource.md)\<[`Section`](Section.md)\> · Required
+
+
+
+<a id="path-1"></a>
+
+**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`PathPatternOptions`](PathPatternOptions.md) · Required
+
+- [`count`](PathPatternOptions.md#count) · `number` · Required
+
+  Positive number of copies; open paths include both endpoints when greater than one.
+
+- [`closed`](PathPatternOptions.md#closed) · `boolean` · Optional
+
+  Include the closing edge without duplicating the seam; defaults to false.
+
+- [`orientation`](PathPatternOptions.md#orientation) · `"fixed"` \| `"tangent"` · Optional
+
+  Preserve the source orientation, or align its +Z to the path tangent; defaults to fixed.
+
+
+
+### Returns
+
+readonly [`Section`](Section.md)[]
+
+
+## Related APIs
+
+- [PathPatternOptions](PathPatternOptions.md)
+- [PatternSource](PatternSource.md)
+- [Section](Section.md)
+- [Solid](Solid.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/polygon.md

@@ -0,0 +1,40 @@
+# polygon
+
+Fills one closed millimetre XY outline, explicit outer/hole topology, or compound contours. Closing edges are implicit. Compound contours use nonzero fill unless selected otherwise. Explicit topology must be simple and disjoint; compound winding may resolve overlaps.
+
+**polygon**(`input`: [`Contour`](Contour.md) \| [`PolygonOptions`](PolygonOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Extrude a triangular plate
+
+```ts
+polygon([[0, 0], [20, 0], [10, 12]]).extrude({ height: 3 });
+```
+
+## Parameters
+
+<a id="input"></a>
+
+**`input`** · [`Contour`](Contour.md) \| [`PolygonOptions`](PolygonOptions.md) · Required
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+- [PolygonOptions](PolygonOptions.md)
+- [Section](Section.md)
+
+## Guides
+
+- [Section, hole, offset, and extrusion](../../guides/recipes.md#section-hole-offset-and-extrusion)
+- [SVG sections: fills and strokes are different inputs](../../guides/concepts.md#svg-sections-fills-and-strokes-are-different-inputs)
+- [Text and font variability](../../guides/concepts.md#text-and-font-variability)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/preflightInternalThreadCutter.md

@@ -0,0 +1,89 @@
+# preflightInternalThreadCutter
+
+Allocation-free internal-thread facts.
+
+**preflightInternalThreadCutter**(`options`: [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md)): [`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md) · Required
+
+- [`length`](InternalThreadCutterOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`profile`](InternalThreadCutterOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`nominalMajorDiameter`](InternalThreadCutterOptions.md#nominalmajordiameter) · `number` · Required
+
+  Nominal major diameter before female compensation and faceting correction.
+
+- [`ends`](InternalThreadCutterOptions.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`](InternalThreadCutterOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](InternalThreadCutterOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](InternalThreadCutterOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](InternalThreadCutterOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](InternalThreadCutterOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](InternalThreadCutterOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`fit`](InternalThreadCutterOptions.md#fit) · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
+
+  Printable fit or caller-calibrated allowances. Default: `normal`.
+
+- [`bevelBottom`](InternalThreadCutterOptions.md#bevelbottom) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=0.
+
+- [`bevelSize`](InternalThreadCutterOptions.md#bevelsize) · `number` · Optional
+
+  Axial bevel extent in millimetres. Active blunt ends default to one sixth of the compensated
+  male minor radius or female major radius; other ends default to the profile depth.
+
+- [`bevelTop`](InternalThreadCutterOptions.md#beveltop) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=length.
+
+
+
+## Returns
+
+[`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+## Related APIs
+
+- [HelicalThreadSolidMeshPreflight](HelicalThreadSolidMeshPreflight.md)
+- [InternalThreadCutterOptions](InternalThreadCutterOptions.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/preflightThreadedNut.md

@@ -0,0 +1,100 @@
+# preflightThreadedNut
+
+Allocation-free nut/cutter facts.
+
+**preflightThreadedNut**(`options`: [`ThreadedNutOptions`](ThreadedNutOptions.md)): [`ThreadedNutPreflight`](ThreadedNutPreflight.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`ThreadedNutOptions`](ThreadedNutOptions.md) · Required
+
+- [`profile`](ThreadedNutOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`nominalMajorDiameter`](ThreadedNutOptions.md#nominalmajordiameter) · `number` · Required
+
+  Nominal major diameter before female compensation and faceting correction.
+
+- [`shape`](ThreadedNutOptions.md#shape) · [`ThreadedNutShape`](ThreadedNutShape.md) · Required
+
+  Nut body shape.
+
+- [`thickness`](ThreadedNutOptions.md#thickness) · `number` · Required
+
+  Nut thickness along +Z in millimetres.
+
+- [`width`](ThreadedNutOptions.md#width) · `number` · Required
+
+  Across-flats width for hex/square or diameter for round, in millimetres.
+
+- [`ends`](ThreadedNutOptions.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`](ThreadedNutOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](ThreadedNutOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](ThreadedNutOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](ThreadedNutOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](ThreadedNutOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](ThreadedNutOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`fit`](ThreadedNutOptions.md#fit) · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
+
+  Printable fit or caller-calibrated allowances. Default: `normal`.
+
+- [`bevel`](ThreadedNutOptions.md#bevel) · [`ThreadedNutBevel`](ThreadedNutBevel.md) · Optional
+
+  Nut body bevel selection. Default: `automatic`.
+
+- [`bodyResolution`](ThreadedNutOptions.md#bodyresolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional physical policy for a round body, independent of the thread's matched facet grid.
+
+- [`chamferSize`](ThreadedNutOptions.md#chamfersize) · `number` · Optional
+
+  45-degree body chamfer extent. Default: `min(profile.depth, thickness/4)`.
+
+- [`flushBuildPlateBottom`](ThreadedNutOptions.md#flushbuildplatebottom) · `boolean` · Optional
+
+  Leave the bottom outside edge flat for build-plate adhesion. Default: `false`.
+
+
+
+## Returns
+
+[`ThreadedNutPreflight`](ThreadedNutPreflight.md)
+
+
+## Related APIs
+
+- [ThreadedNutOptions](ThreadedNutOptions.md)
+- [ThreadedNutPreflight](ThreadedNutPreflight.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/preflightThreadedRod.md

@@ -0,0 +1,89 @@
+# preflightThreadedRod
+
+Allocation-free external-thread facts.
+
+**preflightThreadedRod**(`options`: [`ThreadedRodOptions`](ThreadedRodOptions.md)): [`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`ThreadedRodOptions`](ThreadedRodOptions.md) · Required
+
+- [`length`](ThreadedRodOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`profile`](ThreadedRodOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`nominalMajorDiameter`](ThreadedRodOptions.md#nominalmajordiameter) · `number` · Required
+
+  Nominal major diameter before male compensation.
+
+- [`ends`](ThreadedRodOptions.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`](ThreadedRodOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](ThreadedRodOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](ThreadedRodOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](ThreadedRodOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](ThreadedRodOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](ThreadedRodOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`bevelBottom`](ThreadedRodOptions.md#bevelbottom) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=0.
+
+- [`bevelSize`](ThreadedRodOptions.md#bevelsize) · `number` · Optional
+
+  Axial bevel extent in millimetres. Active blunt ends default to one sixth of the compensated
+  male minor radius or female major radius; other ends default to the profile depth.
+
+- [`bevelTop`](ThreadedRodOptions.md#beveltop) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=length.
+
+- [`fit`](ThreadedRodOptions.md#fit) · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
+
+  Printable fit or caller-calibrated allowances. Default: `normal`.
+
+
+
+## Returns
+
+[`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+## Related APIs
+
+- [HelicalThreadSolidMeshPreflight](HelicalThreadSolidMeshPreflight.md)
+- [ThreadedRodOptions](ThreadedRodOptions.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.14.0`.