@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,110 @@
+# threadedNut
+
+Compensated threaded nut.
+
+**threadedNut**(`options`: [`ThreadedNutOptions`](ThreadedNutOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Threaded nut
+
+```ts
+import { threadedNut } from "@metamesh/modeling";
+import { createThreadProfile } from "@metamesh/modeling/geometry";
+
+const profile = createThreadProfile({ kind: "triangular", pitch: 1.75 });
+threadedNut({ nominalMajorDiameter: 12, thickness: 8, width: 20, shape: "hex", profile, fit: "normal" });
+```
+
+## 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
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [ThreadedNutOptions](ThreadedNutOptions.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,99 @@
+# threadedRod
+
+Compensated external threaded rod.
+
+**threadedRod**(`options`: [`ThreadedRodOptions`](ThreadedRodOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Threaded rod
+
+```ts
+import { threadedRod } from "@metamesh/modeling";
+import { createThreadProfile } from "@metamesh/modeling/geometry";
+
+const profile = createThreadProfile({ kind: "triangular", pitch: 1.75 });
+threadedRod({ nominalMajorDiameter: 12, length: 24, profile, fit: "normal" });
+```
+
+## 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
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [ThreadedRodOptions](ThreadedRodOptions.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,33 @@
+# toRegion
+
+Explicit copied topology inspection; not needed for section operations.
+
+**toRegion**(`section`: [`Section`](Section.md)): [`Region`](Region.md)
+
+
+
+## Parameters
+
+<a id="section"></a>
+
+**`section`** · [`Section`](Section.md) · Required
+
+
+
+## Returns
+
+[`Region`](Region.md)
+
+
+## Related APIs
+
+- [Region](Region.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.13.0`.

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

@@ -0,0 +1,27 @@
+# toTriangleMesh
+
+Copies a handle to manufacturing mesh buffers.
+
+**toTriangleMesh**(`solid`: [`Solid`](Solid.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+## Parameters
+
+<a id="solid"></a>
+
+**`solid`** · [`Solid`](Solid.md) · Required
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,70 @@
+# torus
+
+Torus around +Z.
+
+**torus**(`options`: [`TorusOptions`](TorusOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Torus
+
+
+
+```ts
+torus({ majorRadius: 12, minorRadius: 3 });
+```
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`TorusOptions`](TorusOptions.md) · Required
+
+- [`majorRadius`](TorusOptions.md#majorradius) · `number` · Required
+
+  Radius from the Z axis to the profile center, in millimetres; greater than `minorRadius`.
+
+- [`minorRadius`](TorusOptions.md#minorradius) · `number` · Required
+
+  Radius of the swept circular profile in millimetres.
+
+- [`placement`](TorusOptions.md#placement) · [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md) · Optional
+
+  Applied after local construction; Section placement must preserve the XY plane.
+
+- [`limits`](TorusOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings, bounded by the host policy.
+
+- [`majorSegments`](TorusOptions.md#majorsegments) · `number` · Optional
+
+  Exact segment count around the Z axis; omitted uses adaptive resolution.
+
+- [`minorSegments`](TorusOptions.md#minorsegments) · `number` · Optional
+
+  Exact segment count around the swept profile; omitted uses adaptive resolution.
+
+- [`resolution`](TorusOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [TorusOptions](TorusOptions.md)
+
+## 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)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,77 @@
+# tube
+
+Hollow +Z tube.
+
+**tube**(`options`: [`TubeOptions`](TubeOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Tube
+
+
+
+```ts
+tube({ height: 20, outerRadius: 10, innerRadius: 6 });
+```
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`TubeOptions`](TubeOptions.md) · Required
+
+- [`height`](TubeOptions.md#height) · `number` · Required
+
+  Total height along Z in millimetres.
+
+- [`innerRadius`](TubeOptions.md#innerradius) · `number` · Required
+
+  Positive inner radius in millimetres.
+
+- [`outerRadius`](TubeOptions.md#outerradius) · `number` · Required
+
+  Outer radius in millimetres; greater than [TubeOptions.innerRadius](TubeOptions.md#innerradius).
+
+- [`limits`](TubeOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings; bound modeling operations may only lower the host policy.
+
+- [`segments`](TubeOptions.md#segments) · `number` · Optional
+
+  Exact circumferential segment count from three through the configured safety limit.
+
+  This local topology override takes precedence over [CircularPrimitiveOptions.resolution](CircularPrimitiveOptions.md#resolution)
+  and any active model-wide resolution policy.
+
+- [`resolution`](TubeOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+- [`placement`](TubeOptions.md#placement) · [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md) · Optional
+
+  Applied after local construction; Section placement must preserve the XY plane.
+
+- [`center`](TubeOptions.md#center) · `boolean` · Optional · Default: `true`
+
+  Centers the tube on the Z origin when `true`; otherwise its bottom is at `Z = 0`.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [TubeOptions](TubeOptions.md)
+
+## 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)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,72 @@
+# union
+
+Robust union.
+
+## Call Signature
+
+
+
+**union**(`solids`: readonly [`Solid`](Solid.md)[]): [`Solid`](Solid.md)
+
+
+
+## Example: Union
+
+
+
+```ts
+const block = box({ size: 20 });
+const cap = sphere({ radius: 10 }).translate([0, 0, 10]);
+union([block, cap]);
+```
+
+
+
+Robust union.
+
+### Parameters
+
+<a id="solids"></a>
+
+**`solids`** · readonly [`Solid`](Solid.md)[] · Required
+
+
+
+### Returns
+
+[`Solid`](Solid.md)
+
+## Call Signature
+
+
+
+**union**(`sections`: readonly [`Section`](Section.md)[]): [`Section`](Section.md)
+
+
+
+Native filled section union; dimensions cannot be mixed.
+
+### Parameters
+
+<a id="sections"></a>
+
+**`sections`** · readonly [`Section`](Section.md)[] · Required
+
+
+
+### Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [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.13.0`.

package/dist/docs/reference/model.md

@@ -0,0 +1,39 @@
+# Model API
+
+Immutable solids and sections with fluent shape operations, collection functions, and host-owned execution.
+
+Import `generate` and shape constructors and collection functions from `@metamesh/modeling`. Chain shape methods to transform, subtract, and finish immutable recipes; a host session owns execution and optional computed caches.
+
+```ts
+import { box, cylinder, generate } from "@metamesh/modeling";
+import { createModelEngine } from "@metamesh/modeling/engine";
+const model = generate<Record<never, never>>(({ part }) => [part("plate", box({ size: [30, 20, 6] }).subtract([cylinder({ radius: 3, height: 8 })]))]);
+const engine = await createModelEngine();
+const session = engine.createSession(model);
+const snapshot = session.run({});
+snapshot.dispose();
+session.dispose();
+```
+
+Computed data and recipes reuse unchanged work. Part placement and color are separate from local geometry. Native Sections preserve holes through Boolean and offset chains. Opaque recipes belong to a session. Temporary native allocations belong to the current transaction; sessions may retain bounded evaluated geometry privately. Copied snapshots remain valid after session disposal until they are disposed.
+
+See [host lifecycle](engine.md) and [pure foundations](geometry.md).
+
+## Categories
+
+- [Primitives](model/categories/primitives.md) — Create foundational solid geometry and configure its dimensions and tessellation.
+- [Local resolution](model/categories/resolution.md) — Choose physical curve sampling and explicit native tolerance.
+- [2D Sections](model/categories/sections.md) — Create native filled XY sections, including prepared text and bounded painted SVG.
+- [Boolean Operations](model/categories/boolean-operations.md) — Combine, intersect and subtract same-dimensional shapes; construct solid envelopes and sums.
+- [Transforms & Placement](model/categories/transforms-placement.md) — Transform 2D sections and 3D solids; arrange and attach solids with explicit placement contracts.
+- [Extrude, Revolve & Sweep](model/categories/extrude-revolve-sweep.md) — Turn sections and paths into extruded, lofted, revolved, or swept solids.
+- [Printable threads](model/categories/threads.md) — Construct compensated thread forms and inspect allocation-free preflight facts.
+- [Mesh & Inspection](model/categories/mesh-inspection.md) — Convert validated meshes and inspect stable section or solid measurements.
+- [Core Values & Errors](model/categories/core-values-errors.md) — Use the small shared vocabulary for authored geometry, coordinates, paths, and stable failures.
+- [Explicit matching profiles](model/categories/explicit-profiles.md) — Build hollow or multicomponent lofts and sweeps using stable landmarks.
+- [Sampled surfaces](model/categories/bounded-surfaces.md) — Construct bounded heightfields and positive-inside implicit fields.
+- [Solid inspection](model/categories/inspection.md) — Inspect and convert session-owned recipes while retaining host ownership.
+- [Model generation](model/categories/generation.md) — Declare typed programs, optional computations, semantic parts and structured diagnostics.
+- [Model contracts](model/categories/contracts.md) — Describe opaque handles, dimensions, manufacturing parts, and completed snapshots.
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/text/Bounds2.md

@@ -0,0 +1,34 @@
+# Bounds2
+
+Axis-aligned bounds in two-dimensional model space.
+
+## Properties
+
+### max
+
+
+
+`readonly` **max**: [`Vector2`](Vector2.md)
+
+
+
+Inclusive maximum X/Y coordinates.
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector2`](Vector2.md)
+
+
+
+Inclusive minimum X/Y coordinates.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/text/MAX_VECTOR_FONT_BYTES.md

@@ -0,0 +1,7 @@
+# MAX_VECTOR_FONT_BYTES
+
+Limits apply before parsing or shaping untrusted font data.
+
+`const` **MAX\_VECTOR\_FONT\_BYTES**: `number`
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/text/Vector2.md

@@ -0,0 +1,7 @@
+# Vector2
+
+A two-dimensional Cartesian vector or point.
+
+**Vector2** = readonly \[`x`: `number`, `y`: `number`\]
+
+Package: `@metamesh/modeling@0.13.0`.