@metamesh/modeling 0.12.0 → 0.13.0

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

@@ -0,0 +1,40 @@
+# immutableMesh
+
+Copies mesh buffers into immutable data; geometric validation still occurs when modeling or finalizing.
+
+**immutableMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md)): [`ImmutableTriangleMesh`](ImmutableTriangleMesh.md)
+
+
+
+## Example
+
+```ts
+import { generate, immutableMesh } from "@metamesh/modeling";
+import { heightfieldMesh } from "@metamesh/modeling/geometry";
+const model = generate(({ computed, part }) => {
+  const surface = computed("surface", () => immutableMesh(heightfieldMesh({
+    size: [10, 10], segments: [8, 8], height: () => 2,
+  })));
+  return [part("surface", surface)];
+});
+```
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+
+
+## Returns
+
+[`ImmutableTriangleMesh`](ImmutableTriangleMesh.md)
+
+
+## Related APIs
+
+- [ImmutableTriangleMesh](ImmutableTriangleMesh.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,47 @@
+# implicit
+
+Bounded positive-inside implicit field constructor.
+
+**implicit**(`options`: [`ImplicitOptions`](ImplicitOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`ImplicitOptions`](ImplicitOptions.md) · Required
+
+- [`field`](ImplicitOptions.md#field) · (`point`: [`Vector3`](Vector3.md)) => `number` · Required
+
+  Positive-inside scalar field evaluated at finite XYZ points.
+
+- [`bounds`](ImplicitOptions.md#bounds) · [`Bounds3`](Bounds3.md) · Required
+
+  Axis-aligned XYZ bounds in millimetres.
+
+- [`edgeLength`](ImplicitOptions.md#edgelength) · `number` · Required
+
+  Positive sampling edge length in millimetres.
+
+- [`level`](ImplicitOptions.md#level) · `number` · Optional
+
+  Field isosurface value; defaults to zero.
+
+- [`tolerance`](ImplicitOptions.md#tolerance) · `number` · Optional
+
+  Positive native geometric tolerance in millimetres; omitted uses interpolated grid crossings.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [ImplicitOptions](ImplicitOptions.md)
+- [Solid](Solid.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,38 @@
+# inspectSection
+
+Copies lightweight section measurements.
+
+**inspectSection**(`section`: [`Section`](Section.md)): [`SectionInspection`](SectionInspection.md)
+
+
+
+## Example: Check filled area
+
+```ts
+const facts = inspectSection(rectangle({ size: [20, 10] }));
+facts.area; // 200 mm²
+```
+
+## Parameters
+
+<a id="section"></a>
+
+**`section`** · [`Section`](Section.md) · Required
+
+
+
+## Returns
+
+[`SectionInspection`](SectionInspection.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [SectionInspection](SectionInspection.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,38 @@
+# inspectSolid
+
+Reads immutable native facts once per solid; temporary components are owned by the build.
+
+**inspectSolid**(`solid`: [`Solid`](Solid.md)): [`SolidInspection`](SolidInspection.md)
+
+
+
+## Example: Check dimensions and volume
+
+```ts
+const facts = inspectSolid(box({ size: [30, 20, 6] }));
+facts.volume; // 3600 mm³
+```
+
+## Parameters
+
+<a id="solid"></a>
+
+**`solid`** · [`Solid`](Solid.md) · Required
+
+
+
+## Returns
+
+[`SolidInspection`](SolidInspection.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [SolidInspection](SolidInspection.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,100 @@
+# internalThreadCutter
+
+Compensated internal threaded cutter.
+
+**internalThreadCutter**(`options`: [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Internal thread
+
+```ts
+import { cylinder, internalThreadCutter } from "@metamesh/modeling";
+import { createThreadProfile } from "@metamesh/modeling/geometry";
+const profile = createThreadProfile({ 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]);
+```
+
+## 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
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [InternalThreadCutterOptions](InternalThreadCutterOptions.md)
+- [Solid](Solid.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/intersect.md

@@ -0,0 +1,70 @@
+# intersect
+
+Robust intersection.
+
+## Call Signature
+
+
+
+**intersect**(`solids`: readonly [`Solid`](Solid.md)[]): [`Solid`](Solid.md)
+
+
+
+## Example: Intersect
+
+
+
+```ts
+intersect([box({ size: 20 }), sphere({ radius: 12 })]);
+```
+
+
+
+Robust intersection.
+
+### Parameters
+
+<a id="solids"></a>
+
+**`solids`** · readonly [`Solid`](Solid.md)[] · Required
+
+
+
+### Returns
+
+[`Solid`](Solid.md)
+
+## Call Signature
+
+
+
+**intersect**(`sections`: readonly [`Section`](Section.md)[]): [`Section`](Section.md)
+
+
+
+Native filled section intersection; 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/isEmpty.md

@@ -0,0 +1,39 @@
+# isEmpty
+
+Checks whether a same-session solid or filled section contains no geometry.
+
+**isEmpty**(`shape`: [`Solid`](Solid.md) \| [`Section`](Section.md)): `boolean`
+
+
+
+## Example: Check a missed intersection
+
+```ts
+const body = box({ size: 10 });
+const distant = box({ size: 10 }).translate([30, 0, 0]);
+const empty = intersect([body, distant]);
+const missed = isEmpty(empty); // true
+```
+
+Accepts a 3D Solid or 2D Section handle, not a finalized model or raw triangle mesh.
+Useful after a Boolean operation whose inputs may not overlap; no mesh is extracted.
+
+## Parameters
+
+<a id="shape"></a>
+
+**`shape`** · [`Solid`](Solid.md) \| [`Section`](Section.md) · Required
+
+
+
+## Returns
+
+`boolean`
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [Solid](Solid.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,80 @@
+# linearPattern
+
+Repeats one solid along a normalized direction.
+
+## Call Signature
+
+
+
+**linearPattern**(`source`: [`PatternSource`](PatternSource.md), `options`: [`LinearPatternOptions`](LinearPatternOptions.md)): readonly [`Solid`](Solid.md)[]
+
+
+
+## Example: Three copies along X
+
+```ts
+linearPattern(box({ size: 4 }), { count: 3, spacing: 10 });
+```
+
+Repeats one solid along a normalized direction.
+
+### Parameters
+
+<a id="source"></a>
+
+**`source`** · [`PatternSource`](PatternSource.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`LinearPatternOptions`](LinearPatternOptions.md) · Required
+
+
+
+### Returns
+
+readonly [`Solid`](Solid.md)[]
+
+## Call Signature
+
+
+
+**linearPattern**(`source`: [`PatternSource`](PatternSource.md)\<[`Section`](Section.md)\>, `options`: [`LinearPatternOptions`](LinearPatternOptions.md)): readonly [`Section`](Section.md)[]
+
+
+
+Repeats a filled Section; every placement must preserve its XY plane.
+
+### Parameters
+
+<a id="source-1"></a>
+
+**`source`** · [`PatternSource`](PatternSource.md)\<[`Section`](Section.md)\> · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`LinearPatternOptions`](LinearPatternOptions.md) · Required
+
+
+
+### Returns
+
+readonly [`Section`](Section.md)[]
+
+
+## Related APIs
+
+- [LinearPatternOptions](LinearPatternOptions.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)
+
+Package: `@metamesh/modeling@0.13.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.13.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.13.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.13.0`.