@metamesh/modeling 0.17.0 → 0.18.0

package/dist/docs/reference/geometry/preflightHelicalThreadSolidMesh.md

@@ -1,105 +0,0 @@
-# preflightHelicalThreadSolidMesh
-
-Checks thread dimensions, profile, end treatments, sampling, and conservative estimates against output limits.
-
-**preflightHelicalThreadSolidMesh**(`options`: [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md)): [`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
-
-
-
-This pure operation needs no engine and constructs planning data without vertex or index buffers.
-`circularSegments` is the selected count; row and triangle counts are conservative estimates.
-Successful preflight leaves generated coordinate and topology checks to mesh construction.
-
-## Parameters
-
-<a id="options"></a>
-
-**`options`** · [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md) · Required
-
-- [`length`](HelicalThreadSolidMeshOptions.md#length) · `number` · Required
-
-  Total threaded axial length in millimetres.
-
-- [`majorDiameter`](HelicalThreadSolidMeshOptions.md#majordiameter) · `number` · Required
-
-  Nominal major diameter before any caller-owned fit compensation.
-
-- [`profile`](HelicalThreadSolidMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile-type.md) · Required
-
-  Validated periodic profile repeated around the shaft.
-
-- [`ends`](HelicalThreadSolidMeshOptions.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`](HelicalThreadSolidMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
-
-  Helix direction. Default: `right`.
-
-- [`limits`](HelicalThreadSolidMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
-
-  Explicit output and circular allocation ceilings.
-
-- [`phase`](HelicalThreadSolidMeshOptions.md#phase) · `number` · Optional
-
-  Angular offset of the first start in degrees. Default: `0`.
-
-- [`resolution`](HelicalThreadSolidMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
-
-  Optional circular-resolution policy.
-
-- [`starts`](HelicalThreadSolidMeshOptions.md#starts) · `number` · Optional
-
-  Number of evenly phased starts. Default: `1`.
-
-- [`tolerance`](HelicalThreadSolidMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-  Optional numerical tolerance overrides.
-
-- [`bevelBottom`](HelicalThreadSolidMeshOptions.md#bevelbottom) · `boolean` · Optional
-
-  Apply a 45-degree radial bevel at the lower target face.
-
-- [`bevelBottomSize`](HelicalThreadSolidMeshOptions.md#bevelbottomsize) · `number` · Optional
-
-  Lower bevel size override. Takes precedence over `bevelSize`.
-
-- [`bevelOffset`](HelicalThreadSolidMeshOptions.md#beveloffset) · `number` · Optional
-
-  Distance of each bevel target face inward from the corresponding mesh end.
-
-- [`bevelMode`](HelicalThreadSolidMeshOptions.md#bevelmode) · `"inset"` \| `"outset"` · Optional
-
-  `inset` trims an external rod; `outset` expands an internal cutter.
-
-- [`bevelSize`](HelicalThreadSolidMeshOptions.md#bevelsize) · `number` · Optional
-
-  Axial and radial bevel size. Defaults to the profile depth.
-
-- [`bevelTop`](HelicalThreadSolidMeshOptions.md#beveltop) · `boolean` · Optional
-
-  Apply a 45-degree radial bevel at the upper target face.
-
-- [`bevelTopSize`](HelicalThreadSolidMeshOptions.md#beveltopsize) · `number` · Optional
-
-  Upper bevel size override. Takes precedence over `bevelSize`.
-
-
-
-## Returns
-
-[`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
-
-
-## Related APIs
-
-- [HelicalThreadSolidMeshOptions](HelicalThreadSolidMeshOptions.md)
-- [HelicalThreadSolidMeshPreflight](HelicalThreadSolidMeshPreflight.md)
-- [helicalThreadSolidMesh](helicalThreadSolidMesh.md)
-
-## Guides
-
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/geometry/sweepMesh.md

@@ -1,86 +0,0 @@
-# sweepMesh
-
-Sweeps one explicitly ordered point loop, with caps or a geometrically matching closed seam.
-
-**sweepMesh**(`profile`: [`Path2Input`](Path2Input.md), `path`: [`Path3Input`](Path3Input.md), `options?`: [`SweepOptions`](SweepOptions.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-## Example: Sweep point data along a bent path
-
-```ts
-const profile = rectangleContour({ size: [6, 3] });
-sweepMesh(profile, [[0, 0, 0], [0, 0, 15], [10, 0, 25]], {
-  orientation: { kind: "transport", initialNormal: [0, 1, 0] },
-});
-```
-
-## Parameters
-
-<a id="profile"></a>
-
-**`profile`** · [`Path2Input`](Path2Input.md) · Required
-
-
-
-<a id="path"></a>
-
-**`path`** · [`Path3Input`](Path3Input.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`SweepOptions`](SweepOptions.md) · Optional
-
-- [`closed`](SweepOptions.md#closed) · `boolean` · Optional
-
-  Raw point closure defaults to false; a Path3 supplies its closure and rejects conflicts.
-
-- [`limits`](SweepOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
-
-  Explicit output and sampling allocation ceilings.
-
-- [`orientation`](SweepOptions.md#orientation) · [`SweepOrientation`](SweepOrientation.md) · Optional
-
-  Explicit frame policy; default transport minimizes rotations, initially projecting +X then +Y then +Z.
-
-- [`resolution`](SweepOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
-
-  Physical sampling of nonzero twist; inserted stations retain authored station controls.
-
-- [`twist`](SweepOptions.md#twist) · `number` · Optional
-
-  Total additional profile rotation in degrees, with progression selected by twistBy.
-
-- [`twistBy`](SweepOptions.md#twistby) · `"length"` \| `"stations"` · Optional
-
-  Twist advances by physical path length (default), or normalized authored station position, including a closed seam gap.
-
-- [`scale`](SweepOptions.md#scale) · `number` \| [`Vector2Input`](Vector2Input.md) \| readonly [`Vector2Input`](Vector2Input.md)[] · Optional
-
-  Positive uniform/XY scale, or one XY pair per path station. Defaults to one.
-
-- [`seamProfileOffset`](SweepOptions.md#seamprofileoffset) · `number` · Optional
-
-  Corresponding point-index advance at a rotationally equivalent closed seam.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-
-## Related APIs
-
-- [Path2Input](Path2Input.md)
-- [Path3Input](Path3Input.md)
-- [SweepOptions](SweepOptions.md)
-- [TriangleMesh](TriangleMesh.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,131 +0,0 @@
-# FinalizedModel
-
-Finalized manufacturing snapshot. Its arrays are independent of all native values.
-
-## Extended by
-
-- [`ModelSnapshot`](../engine/ModelSnapshot.md)
-
-## Properties
-
-### parts
-
-
-
-`readonly` **parts**: readonly [`FinalizedPart`](FinalizedPart.md)[]
-
-
-
-Ordered finalized manufacturing parts with copied transferable arrays.
-
-***
-
-### bounds
-
-
-
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
-
-
-
-Axis-aligned XYZ bounds in millimetres.
-
-***
-
-### stats
-
-
-
-`readonly` **stats**: `object`
-
-
-
-Aggregate counts, unique backing storage, volume, and execution timings.
-
-#### partCount
-
-
-
-`readonly` **partCount**: `number`
-
-
-
-Number of declared output parts, including repeated geometry instances.
-
-#### vertexCount
-
-
-
-`readonly` **vertexCount**: `number`
-
-
-
-Aggregate position-buffer vertex count.
-
-#### triangleCount
-
-
-
-`readonly` **triangleCount**: `number`
-
-
-
-Aggregate indexed triangle count.
-
-#### volumeMm3
-
-
-
-`readonly` **volumeMm3**: `number`
-
-
-
-Signed enclosed volume of all selected parts in cubic millimetres.
-
-#### byteCount
-
-
-
-`readonly` **byteCount**: `number`
-
-
-
-Unique transferable backing-buffer bytes, counted once across all parts.
-
-#### buildMs
-
-
-
-`readonly` **buildMs**: `number`
-
-
-
-Synchronous callback duration in milliseconds.
-
-#### finalizationMs
-
-
-
-`readonly` **finalizationMs**: `number`
-
-
-
-Manufacturing validation and buffer finalization duration in milliseconds.
-
-#### generationMs
-
-
-
-`readonly` **generationMs**: `number`
-
-
-
-Total generation duration, including cache retention and native cleanup, in milliseconds.
-
-
-## Related APIs
-
-- [Bounds3Data](Bounds3Data.md)
-- [FinalizedPart](FinalizedPart.md)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,87 +0,0 @@
-# FinalizedPart
-
-Copied manufacturing part with facts computed from the finalized mesh.
-
-## Extends
-
-- [`TriangleMesh`](TriangleMesh.md)
-
-## Extended by
-
-- [`SnapshotPart`](../engine/SnapshotPart.md)
-
-## Properties
-
-### id
-
-
-
-`readonly` **id**: `string`
-
-
-
-Stable canonical lowercase identity; unique within the containing topology or output.
-
-***
-
-### color?
-
-
-
-`readonly` `optional` **color?**: `string`
-
-
-
-Optional six-digit hex RGB display color.
-
-***
-
-### measurements
-
-
-
-`readonly` **measurements**: [`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
-
-
-
-Fresh validated facts for these exact finalized buffers.
-
-***
-
-### indices
-
-
-
-`readonly` **indices**: `Uint32Array`
-
-
-
-Three unsigned vertex indices per triangle.
-
-#### Inherited from
-
-[`TriangleMesh`](TriangleMesh.md).[`indices`](TriangleMesh.md#indices)
-
-***
-
-### positions
-
-
-
-`readonly` **positions**: `Float32Array`
-
-
-
-Flat XYZ coordinates, three finite values per vertex.
-
-#### Inherited from
-
-[`TriangleMesh`](TriangleMesh.md).[`positions`](TriangleMesh.md#positions)
-
-
-## Related APIs
-
-- [TriangleMesh](TriangleMesh.md)
-- [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,47 +0,0 @@
-# anchor
-
-Reads a copied, immutable named anchor from this exact active generation.
-
-**anchor**(`shape`: [`Solid`](Solid.md) \| [`Section`](Section.md), `name`: `string`): [`Anchor3`](Anchor3.md)
-
-
-
-## Example: Read the top datum
-
-```ts
-const plate = box({ size: [30, 20, 6] });
-anchor(plate, "top"); // position [0, 0, 3], direction [0, 0, 1]
-```
-
-## Parameters
-
-<a id="shape"></a>
-
-**`shape`** · [`Solid`](Solid.md) \| [`Section`](Section.md) · Required
-
-
-
-<a id="name"></a>
-
-**`name`** · `string` · Required
-
-
-
-## Returns
-
-[`Anchor3`](Anchor3.md)
-
-
-## Related APIs
-
-- [Anchor3](Anchor3.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)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,40 +0,0 @@
-# castSegment
-
-Copies intersections along the finite directed origin-to-endpoint segment.
-
-**castSegment**(`solid`: [`Solid`](Solid.md), `origin`: [`Vector3Input`](Vector3Input.md), `endpoint`: [`Vector3Input`](Vector3Input.md)): readonly [`SolidSegmentHit`](SolidSegmentHit.md)[]
-
-
-
-## Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-<a id="origin"></a>
-
-**`origin`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="endpoint"></a>
-
-**`endpoint`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-## Returns
-
-readonly [`SolidSegmentHit`](SolidSegmentHit.md)[]
-
-
-## Related APIs
-
-- [Solid](Solid.md)
-- [SolidSegmentHit](SolidSegmentHit.md)
-- [Vector3Input](Vector3Input.md)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/categories/inspection.md

@@ -1,29 +0,0 @@
-# Solid inspection
-
-Evaluate recipes and copy observations while the host owns native resources.
-
-Inspection returns copied scalar facts and finite bounds. Mesh extraction is explicit; finalized engine output is already copied and validated.
-
-- `components` accepts either dimension. Observed selections and recipes using them can only be evaluated in their originating session; ordinary recipes remain reusable after session disposal.
-- `simplify()` returns a new shape. `Solid.projectSection()` and `Solid.sliceSection()` return Sections.
-- `isEmpty` distinguishes empty Boolean or split results.
-- `distance` measures minimum separation between nonempty solids, returning zero for contact or overlapping material.
-
-Recipe handles cannot cross a Worker boundary.
-
-## Functions
-
-| API | Summary |
-| --- | --- |
-| [components](../components.md) | Observes disconnected material pieces as session-restricted solid selections. |
-| [castSegment](../castSegment.md) | Copies intersections along the finite directed origin-to-endpoint segment. |
-| [isEmpty](../isEmpty.md) | Checks whether a solid or filled section contains no geometry during host execution. |
-| [distance](../distance.md) | Measures the minimum separation between two nonempty solids in millimetres. |
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [SolidSegmentHit](../SolidSegmentHit.md) | Copied surface intersection from a finite directed segment. Distance is in millimetres. |
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,71 +0,0 @@
-# components
-
-Observes disconnected material pieces as session-restricted solid selections.
-
-## Call Signature
-
-
-
-**components**(`solid`: [`Solid`](Solid.md)): readonly [`Solid`](Solid.md)[]
-
-
-
-## Example: Move disconnected pieces independently
-
-```ts
-const islands = union([box({ size: 8 }), box({ size: 8 }).translate([12, 0, 0])]);
-const pieces = components(islands);
-// Component order is unspecified; the index only sets a display height here.
-union(pieces.map((piece, index) => piece.translate([0, 0, index * 6])));
-```
-
-Observes disconnected material pieces as session-restricted solid selections.
-
-Each piece retains its enclosed cavities. A sealed hollow box is one component; adding a loose
-ball inside its cavity produces two. Recombining the pieces preserves the original material.
-This does not cut connected geometry. Containment is bounded to 2,000,000 comparisons.
-Selection order and cardinality depend on evaluated topology. Results and recipes using them
-can only be evaluated in this session; composition itself requires no engine.
-
-### Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-### Returns
-
-readonly [`Solid`](Solid.md)[]
-
-## Call Signature
-
-
-
-**components**(`section`: [`Section`](Section.md)): readonly [`Section`](Section.md)[]
-
-
-
-Observes filled 2D islands, retaining each island's holes; empty gives [].
-Selections and recipes using them can only be evaluated in this session.
-
-### Parameters
-
-<a id="section"></a>
-
-**`section`** · [`Section`](Section.md) · Required
-
-
-
-### Returns
-
-readonly [`Section`](Section.md)[]
-
-
-## Related APIs
-
-- [Section](Section.md)
-- [Solid](Solid.md)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,31 +0,0 @@
-# compose
-
-Combines disjoint components without resolving overlap.
-
-**compose**(`solids`: readonly [`Solid`](Solid.md)[]): [`Solid`](Solid.md)
-
-
-
-## Parameters
-
-<a id="solids"></a>
-
-**`solids`** · readonly [`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.17.0`.

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

@@ -1,45 +0,0 @@
-# distance
-
-Measures the minimum separation between two nonempty solids in millimetres.
-
-**distance**(`solid`: [`Solid`](Solid.md), `other`: [`Solid`](Solid.md)): `number`
-
-
-
-## Example: Measure the gap between two blocks
-
-```ts
-const left = box({ size: 10 });
-const right = box({ size: 10 }).translate([13, 0, 0]);
-const gap = distance(left, right); // 3 mm
-```
-
-Uses actual geometry, not bounding-box separation or distance between object origins.
-Contact or overlapping material returns zero, including one solid inside another.
-The kernel's search range is managed internally; the result is not capped at a caller limit.
-Empty geometry and component selections from another session reject. Results follow native numeric precision.
-
-## Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-<a id="other"></a>
-
-**`other`** · [`Solid`](Solid.md) · Required
-
-
-
-## Returns
-
-`number`
-
-
-## Related APIs
-
-- [Solid](Solid.md)
-
-Package: `@metamesh/modeling@0.17.0`.