@metamesh/modeling 0.18.0 → 0.20.0

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

@@ -46,7 +46,15 @@ cylinder({ height: 20, radius: [10, 0] });
 
 ## Guides
 
-- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
-- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Choose a primitive](../../guides/profiles-and-extrusion.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/profiles-and-extrusion.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Shape openings and local edges](../../guides/profiles-and-extrusion.md#shape-openings-and-local-edges)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { cylinder } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -0,0 +1,91 @@
+# edgeCutter
+
+Creates a cutter for one straight convex edge along +Z, with its sharp reference at XY=0. Position it explicitly before subtraction; the included material angle defaults to 90 degrees.
+
+**edgeCutter**(`options`: [`EdgeCutterOptions`](EdgeCutterOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Amber cutter · Blue rounded edge
+
+
+
+```ts
+import { box, edgeCutter, generate } from "@metamesh/modeling";
+import { transform3 } from "@metamesh/modeling/geometry";
+
+const cutter = edgeCutter({ length: 18, treatment: { kind: "round", radius: 6 }, excess: 0 });
+const result = box({ size: 18, center: false }).subtract(cutter);
+// Turn the concave mask and convex result toward the viewer independently.
+export default generate(({ part }) => [
+  part("cutter", { geometry: cutter.translate([-3, -3, 0]).rotate([0, 0, -90]), color: "#f6ad55", transform: transform3().translate([-11, -11, 0]) }),
+  part("result", { geometry: result.translate([-9, -9, 0]).rotate([0, 0, 90]), color: "#4f83a6", transform: transform3().translate([11, 11, 0]) }),
+]);
+```
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`EdgeCutterOptions`](EdgeCutterOptions.md) · Required
+
+- [`length`](EdgeCutterOptions.md#length) · `number` · Required
+
+  Positive nominal edge length along +Z from Z=0, in millimetres.
+
+- [`treatment`](EdgeCutterOptions.md#treatment) · [`EdgeTreatment`](../geometry/EdgeTreatment.md) · Required
+
+  Profile from the first material face to the second; uses the shared surface-setback vocabulary.
+
+- [`angle`](EdgeCutterOptions.md#angle) · `number` · Optional
+
+  Material angle counterclockwise from +X toward +Y, strictly between 0° and 180°; defaults to 90°.
+
+- [`excess`](EdgeCutterOptions.md#excess) · `number` · Optional
+
+  Numerical extension outside the two material faces, in millimetres; defaults to 0.05. Does not change the treatment.
+
+- [`overrun`](EdgeCutterOptions.md#overrun) · [`CutterOverrun`](CutterOverrun.md) · Optional
+
+  Numerical longitudinal extension; both ends default to zero.
+
+- [`resolution`](EdgeCutterOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
+
+  Physical curve sampling; explicit treatment sampling overrides these defaults.
+
+- [`limits`](EdgeCutterOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the evaluating host's limits.
+
+- [`attachment`](EdgeCutterOptions.md#attachment) · [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md) · Optional
+
+  Applied after local construction; Section attachment must preserve the XY plane.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [EdgeCutterOptions](EdgeCutterOptions.md)
+- [Solid](Solid.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/profiles-and-extrusion.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/profiles-and-extrusion.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Shape openings and local edges](../../guides/profiles-and-extrusion.md#shape-openings-and-local-edges)
+
+## Import
+
+```ts
+import { edgeCutter } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -8,10 +8,14 @@ Centered elliptical section.
 
 ## Example: Ellipse by full dimensions
 
+
+
 ```ts
-ellipse({ size: [30, 20] });
+ellipse({ size: [30, 20] }).extrude({ height: 3 });
 ```
 
+
+
 ## Parameters
 
 <a id="options"></a>
@@ -32,8 +36,14 @@ ellipse({ size: [30, 20] });
 
 ## 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)
+- [Section, hole, offset, and extrusion](../../guides/profiles-and-extrusion.md#section-hole-offset-and-extrusion)
+- [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
+- [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
+
+## Import
+
+```ts
+import { ellipse } from "@metamesh/modeling";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -2,25 +2,31 @@
 
 Extrudes a filled Section or explicit corresponding contours along +Z with degree twist and top scaling. Use `section.extrude(options)` in fluent sequences, or this function for generic profile inputs.
 
-**extrude**(`shape`: [`Section`](Section.md) \| [`CorrespondingProfile`](CorrespondingProfile.md), `options`: [`ExtrudeOptions`](ExtrudeOptions.md)): [`Solid`](Solid.md)
+**extrude**(`shape`: [`Section`](Section.md) \| [`CorrespondingProfile`](../geometry/CorrespondingProfile.md), `options`: [`ExtrudeOptions`](ExtrudeOptions.md)): [`Solid`](Solid.md)
 
 
 
 ## Example: Extrude
 
+
+
 ```ts
-import { extrude, matchProfiles } from "@metamesh/modeling";
-import { rectangleProfile } from "@metamesh/modeling/geometry";
+import { extrude } from "@metamesh/modeling";
+import { matchProfiles, rectangleProfile } from "@metamesh/modeling/geometry";
 
 const [profile] = matchProfiles([rectangleProfile({ size: [30, 20] })]);
 extrude(profile!, { height: 8 });
 ```
 
+
+
 ## Parameters
 
 <a id="shape"></a>
 
-**`shape`** · [`Section`](Section.md) \| [`CorrespondingProfile`](CorrespondingProfile.md) · Required
+**`shape`** · [`Section`](Section.md) \| [`CorrespondingProfile`](../geometry/CorrespondingProfile.md) · Required
+
+Filled XY profile in millimetres.
 
 
 
@@ -32,34 +38,34 @@ extrude(profile!, { height: 8 });
 
   Positive extrusion height in millimetres.
 
-- [`center`](ExtrudeOptions.md#center) · `boolean` · Optional
-
-  Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
-
-- [`ends`](ExtrudeOptions.md#ends) · [`EndTreatments`](EndTreatments.md) · Optional
-
-  Independent inward end treatments on straight convex single-contour extrusions.
-
-- [`divisions`](ExtrudeOptions.md#divisions) · `number` · Optional
+- [`slices`](ExtrudeOptions.md#slices) · `number` · Optional
 
-  Exact number of intermediate profiles, nonnegative; overrides physical sampling.
+  Positive longitudinal interval count; n slices create n + 1 profile layers. Overrides ordinary extrusion's physical sampling.
 
-- [`limits`](ExtrudeOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+- [`limits`](ExtrudeOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
 
   Explicit output and sampling allocation ceilings.
 
-- [`resolution`](ExtrudeOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](ExtrudeOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Operation-level physical policy over the nearest model scope.
 
-- [`scaleTop`](ExtrudeOptions.md#scaletop) · `number` \| [`Vector2Input`](Vector2Input.md) · Optional
+- [`scale`](ExtrudeOptions.md#scale) · `number` \| [`Vector2Input`](../geometry/Vector2Input.md) · Optional
 
-  Finite uniform or XY scale of the top profile; defaults to one.
+  Final profile-local uniform or XY scale, interpolated from one before twisting. Both components must be positive or both zero for an apex of one simple boundary. Defaults to one.
 
 - [`twist`](ExtrudeOptions.md#twist) · `number` · Optional
 
   Finite rotation of the top profile about +Z, in degrees; defaults to zero.
 
+- [`ends`](ExtrudeOptions.md#ends) · [`EndTreatments`](EndTreatments.md) · Optional
+
+  Independent inward treatments on every material rim. Twisted extrusions admit chamfers with cap and normal-section wall setbacks; other treatments require zero twist. Enabled treatments require unit scale and preserve boundary topology. The base slices grid is retained, with additional treatment/refinement rings where necessary.
+
+- [`center`](ExtrudeOptions.md#center) · `boolean` · Optional
+
+  Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
+
 
 
 ## Returns
@@ -69,16 +75,23 @@ extrude(profile!, { height: 8 });
 
 ## Related APIs
 
-- [CorrespondingProfile](CorrespondingProfile.md)
 - [ExtrudeOptions](ExtrudeOptions.md)
 - [Section](Section.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)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Chamfer a twisted extrusion](../../guides/profiles-and-extrusion.md#chamfer-a-twisted-extrusion)
+- [Revolve a radial profile](../../guides/profiles-and-extrusion.md#revolve-a-radial-profile)
+- [Rotation-minimizing path sweep](../../guides/sweeps-and-lofts.md#rotation-minimizing-path-sweep)
+- [Matched-section loft](../../guides/sweeps-and-lofts.md#matched-section-loft)
+- [Choose a modeling path](../../guides/recipes.md#choose-a-technique)
+
+## Import
+
+```ts
+import { extrude } from "@metamesh/modeling";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -1,6 +1,6 @@
 # generate
 
-Defines a typed model without executing it. Parameters are an object map of capturable data; runtime capture rejects arrays at the root, ordinary class instances, mutable buffers, and functions. Supply live capabilities through services. Use `computed` only for work worth reusing.
+Defines a typed model without executing it. Parameters are an object map of capturable data; runtime capture rejects arrays at the root, ordinary class instances, mutable buffers, and functions. Supply live capabilities through services. Use `memo` only for work worth reusing.
 
 **generate**\<`P` *extends* `object`, `S` = `Record`\<`never`, `never`\>\>(`callback`: [`GenerateCallback`](GenerateCallback.md)\<`P`, `S`\>): [`ModelProgram`](ModelProgram.md)\<`P`, `S`\>
 
@@ -31,6 +31,8 @@ const model = generate<{ height: number }>(({ params, part, assert }) => {
 
 **`callback`** · [`GenerateCallback`](GenerateCallback.md)\<`P`, `S`\> · Required
 
+Synchronous callback returning one part or a readonly part array.
+
 
 
 ## Returns
@@ -47,4 +49,10 @@ const model = generate<{ height: number }>(({ params, part, assert }) => {
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { generate } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -6,16 +6,20 @@ XY or XYZ copies, optionally centered or placed in an explicit frame.
 
 
 
-**gridPattern**(`source`: [`PatternSource`](PatternSource.md), `options`: [`GridPatternOptions`](GridPatternOptions.md)): readonly [`Solid`](Solid.md)[]
+**gridPattern**(`source`: [`PatternSource`](PatternSource.md), `options`: [`GridPatternOptions`](../geometry/GridPatternOptions.md)): readonly [`Solid`](Solid.md)[]
 
 
 
 ## Example: Centered XY grid
 
+
+
 ```ts
 gridPattern(box({ size: 4 }), { count: [3, 2], spacing: [10, 10], center: true });
 ```
 
+
+
 XY or XYZ copies, optionally centered or placed in an explicit frame.
 
 ### Parameters
@@ -24,11 +28,13 @@ XY or XYZ copies, optionally centered or placed in an explicit frame.
 
 **`source`** · [`PatternSource`](PatternSource.md) · Required
 
+Recipe or factory called once per copy, in zero-based order.
+
 
 
 <a id="options"></a>
 
-**`options`** · [`GridPatternOptions`](GridPatternOptions.md) · Required
+**`options`** · [`GridPatternOptions`](../geometry/GridPatternOptions.md) · Required
 
 
 
@@ -40,7 +46,7 @@ readonly [`Solid`](Solid.md)[]
 
 
 
-**gridPattern**(`source`: [`PatternSource`](PatternSource.md)\<[`Section`](Section.md)\>, `options`: [`GridPatternOptions`](GridPatternOptions.md)\<`2`\>): readonly [`Section`](Section.md)[]
+**gridPattern**(`source`: [`PatternSource`](PatternSource.md)\<[`Section`](Section.md)\>, `options`: [`GridPatternOptions`](../geometry/GridPatternOptions.md)\<`2`\>): readonly [`Section`](Section.md)[]
 
 
 
@@ -52,11 +58,13 @@ Repeats a filled Section on an XY grid; any explicit frame must preserve the XY
 
 **`source`** · [`PatternSource`](PatternSource.md)\<[`Section`](Section.md)\> · Required
 
+Recipe or factory called once per copy, in zero-based order.
+
 
 
 <a id="options-1"></a>
 
-**`options`** · [`GridPatternOptions`](GridPatternOptions.md)\<`2`\> · Required
+**`options`** · [`GridPatternOptions`](../geometry/GridPatternOptions.md)\<`2`\> · Required
 
 
 
@@ -67,15 +75,20 @@ readonly [`Section`](Section.md)[]
 
 ## Related APIs
 
-- [GridPatternOptions](GridPatternOptions.md)
 - [PatternSource](PatternSource.md)
 - [Section](Section.md)
 - [Solid](Solid.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)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
+- [Named anchors and custom frames](../../guides/transforms-and-placement.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/geometry-values.md#fluent-values-plain-data-and-descriptors)
+
+## Import
+
+```ts
+import { gridPattern } from "@metamesh/modeling";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -40,4 +40,10 @@ The retained callback must capture independent immutable inputs, not live sessio
 - [HeightfieldOptions](HeightfieldOptions.md)
 - [Solid](Solid.md)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { heightfield } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -1,20 +1,32 @@
 # holeCutter
 
-Declares a +Z hole or blind-pocket cutter with explicit end overrun in millimetres.
+Declares a +Z hole or blind-pocket cutter with independent opening treatments.
 
 **holeCutter**(`options`: [`HoleCutterOptions`](HoleCutterOptions.md)): [`Solid`](Solid.md)
 
 
 
-## Example: A blind hex pocket with an open top
+## Example: Amber cutter · Blue blind hex pocket
 
 
 
 ```ts
-holeCutter({
-  profile: regularPolygon({ sides: 6, radius: 3.5, sizing: "face", rotation: 30 }),
-  height: 12, entryChamfer: 0.5, overrun: { top: 0.05 },
+import { box, generate, holeCutter, regularPolygon } from "@metamesh/modeling";
+import { transform3 } from "@metamesh/modeling/geometry";
+
+const cutter = holeCutter({
+  profile: regularPolygon({ sides: 6, radius: 5, sizing: "face", rotation: 30 }),
+  height: 5,
+  openings: { top: { kind: "chamfer", distance: 1.5 } },
+  overrun: { top: 0.05 },
 });
+// A 3 mm floor remains beneath the pocket. Display the cutter separately on the left.
+const stock = box({ size: [22, 20, 8] }).translate([0, 0, 4]);
+const result = stock.subtract(cutter.translate([0, 0, 3]));
+export default generate(({ part }) => [
+  part("cutter", { geometry: cutter, color: "#f6ad55", transform: transform3().translate([-12, -12, 0]) }),
+  part("result", { geometry: result, color: "#4f83a6", transform: transform3().translate([12, 12, 0]) }),
+]);
 ```
 
 
@@ -33,11 +45,12 @@ holeCutter({
 
 ## Remarks
 
-Choose exactly one circular diameter or existing Section. A 45-degree entry chamfer
-supports one strictly convex contour without holes; plain profiles may have any topology.
-Circular entries retain nominal frustum radii; profile entries offset the supplied polygon edges.
-Circular head recesses are mutually exclusive with entryChamfer. Both overrun ends default
-to zero, so the nominal bottom remains at Z=0 and blind pocket floors are preserved.
+Choose exactly one circular diameter or existing Section. Finished profiles require one
+strictly convex contour without holes; plain profiles may have any topology. Opening treatments
+widen the mouth while retaining a positive nominal throat. Circular openings also admit
+counterbores and countersinks. An omitted opening leaves that end unchanged.
+Overrun extends each terminal cross section outside Z=0..height; both ends default to zero,
+preserving blind-pocket floors. It is independent of manufacturing clearance.
 Existing Section samples are authoritative; limits and unspecified circular sampling belong
 to the evaluating host.
 
@@ -49,7 +62,15 @@ to the evaluating host.
 
 ## Guides
 
-- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
-- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Choose a primitive](../../guides/profiles-and-extrusion.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/profiles-and-extrusion.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Shape openings and local edges](../../guides/profiles-and-extrusion.md#shape-openings-and-local-edges)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { holeCutter } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -69,6 +69,13 @@ Convex filled XY hull of finite points or filled section recipes.
 ## 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)
+- [Primitive booleans and repeated placement](../../guides/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
+- [Join an independently modeled feature](../../guides/solid-joins.md#join-an-independently-modeled-feature)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { hull } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -12,11 +12,11 @@ Bounded positive-inside implicit field constructor. The retained callback must c
 
 **`options`** · [`ImplicitOptions`](ImplicitOptions.md) · Required
 
-- [`field`](ImplicitOptions.md#field) · (`point`: [`Vector3Data`](Vector3Data.md)) => `number` · Required
+- [`field`](ImplicitOptions.md#field) · (`point`: [`Vector3Data`](../geometry/Vector3Data.md)) => `number` · Required
 
-  Positive-inside scalar field evaluated at finite XYZ points.
+  Positive-inside scalar field evaluated at finite XYZ points in millimetres.
 
-- [`bounds`](ImplicitOptions.md#bounds) · [`Bounds3Data`](Bounds3Data.md) · Required
+- [`bounds`](ImplicitOptions.md#bounds) · [`Bounds3Data`](../geometry/Bounds3Data.md) · Required
 
   Axis-aligned XYZ bounds in millimetres.
 
@@ -44,4 +44,10 @@ Bounded positive-inside implicit field constructor. The retained callback must c
 - [ImplicitOptions](ImplicitOptions.md)
 - [Solid](Solid.md)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import { implicit } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -2,74 +2,86 @@
 
 Compensated internal threaded cutter.
 
-**internalThreadCutter**(`options`: [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md)): [`Solid`](Solid.md)
+**internalThreadCutter**(`options`: [`InternalThreadCutterOptions`](../mechanical/InternalThreadCutterOptions.md)): [`Solid`](Solid.md)
 
 
 
-## Example: Internal thread
+## Example: Amber thread cutter · Blue cutaway result
+
+
 
 ```ts
-import { cylinder, internalThreadCutter } from "@metamesh/modeling";
-import { threadProfile } from "@metamesh/modeling/geometry";
+import { box, cylinder, generate, internalThreadCutter } from "@metamesh/modeling";
+import { transform3 } from "@metamesh/modeling/geometry";
+import { threadProfile } from "@metamesh/modeling/geometry/mechanical";
+
 const profile = threadProfile({ kind: "triangular", pitch: 1.75 });
 const body = cylinder({ diameter: 20, height: 12, center: false });
 const cutter = internalThreadCutter({ nominalMajorDiameter: 12, length: 12, profile });
-body.subtract([cutter]);
+// Remove the front quarter of the stock to expose the actual internal thread.
+const cutaway = box({ size: [11, 11, 14], center: false }).translate([0, -11, -1]);
+const result = body.subtract([cutter, cutaway]);
+export default generate(({ part }) => [
+  part("cutter", { geometry: cutter, color: "#f6ad55", transform: transform3().translate([-12, -12, 0]) }),
+  part("result", { geometry: result, color: "#4f83a6", transform: transform3().translate([12, 12, 0]) }),
+]);
 ```
 
+
+
 ## Parameters
 
 <a id="options"></a>
 
-**`options`** · [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md) · Required
+**`options`** · [`InternalThreadCutterOptions`](../mechanical/InternalThreadCutterOptions.md) · Required
 
-- [`nominalMajorDiameter`](InternalThreadCutterOptions.md#nominalmajordiameter) · `number` · Required
+- [`nominalMajorDiameter`](../mechanical/InternalThreadCutterOptions.md#nominalmajordiameter) · `number` · Required
 
   Nominal major diameter before female compensation and faceting correction.
 
-- [`length`](InternalThreadCutterOptions.md#length) · `number` · Required
+- [`length`](../mechanical/InternalThreadCutterOptions.md#length) · `number` · Required
 
   Total threaded axial length in millimetres.
 
-- [`profile`](InternalThreadCutterOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+- [`profile`](../mechanical/InternalThreadCutterOptions.md#profile) · [`ThreadProfile`](../mechanical/ThreadProfile-type.md) · Required
 
   Validated periodic profile repeated around the shaft.
 
-- [`fit`](InternalThreadCutterOptions.md#fit) · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
+- [`fit`](../mechanical/InternalThreadCutterOptions.md#fit) · [`PrintableThreadFit`](../mechanical/PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](../mechanical/PrintableThreadFitPolicy.md) · Optional
 
   Printable fit or caller-calibrated allowances. Default: `normal`.
 
-- [`bevel`](InternalThreadCutterOptions.md#bevel) · [`Bevel`](Bevel.md) · Optional
+- [`bevel`](../mechanical/InternalThreadCutterOptions.md#bevel) · [`Bevel`](../mechanical/Bevel.md) · Optional
 
   Bottom/top sizes in millimetres. Omitted disables both. Auto uses profile depth for standard/tapered ends,
   or one sixth of the compensated male minor/female major radius for blunt ends.
 
-- [`ends`](InternalThreadCutterOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+- [`ends`](../mechanical/InternalThreadCutterOptions.md#ends) · [`ThreadEndTreatmentOptions`](../mechanical/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
+- [`handedness`](../mechanical/InternalThreadCutterOptions.md#handedness) · [`ThreadHandedness`](../mechanical/ThreadHandedness.md) · Optional
 
   Helix direction. Default: `right`.
 
-- [`limits`](InternalThreadCutterOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+- [`limits`](../mechanical/InternalThreadCutterOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
 
   Explicit output and circular allocation ceilings.
 
-- [`phase`](InternalThreadCutterOptions.md#phase) · `number` · Optional
+- [`phase`](../mechanical/InternalThreadCutterOptions.md#phase) · `number` · Optional
 
   Angular offset of the first start in degrees. Default: `0`.
 
-- [`resolution`](InternalThreadCutterOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+- [`resolution`](../mechanical/InternalThreadCutterOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
 
   Optional circular-resolution policy.
 
-- [`starts`](InternalThreadCutterOptions.md#starts) · `number` · Optional
+- [`starts`](../mechanical/InternalThreadCutterOptions.md#starts) · `number` · Optional
 
   Number of evenly phased starts. Default: `1`.
 
-- [`tolerance`](InternalThreadCutterOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+- [`tolerance`](../mechanical/InternalThreadCutterOptions.md#tolerance) · [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md) · Optional
 
   Optional numerical tolerance overrides.
 
@@ -82,12 +94,17 @@ body.subtract([cutter]);
 
 ## Related APIs
 
-- [InternalThreadCutterOptions](InternalThreadCutterOptions.md)
 - [Solid](Solid.md)
 
 ## Guides
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
-- [Preflight guarantees and host settings](../../guides/concepts.md#check-preflight-guarantees)
+- [Preflight guarantees and host settings](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { internalThreadCutter } from "@metamesh/modeling";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.