@metamesh/modeling 0.16.0 → 0.18.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.16.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.16.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.16.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.16.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.16.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.16.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.16.0`.

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

@@ -1,44 +0,0 @@
-# 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)
-
-## Guides
-
-- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
-
-Package: `@metamesh/modeling@0.16.0`.

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

@@ -1,38 +0,0 @@
-# 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.16.0`.

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

@@ -1,38 +0,0 @@
-# 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.16.0`.

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

@@ -1,39 +0,0 @@
-# isEmpty
-
-Checks whether a solid or filled section contains no geometry during host execution.
-
-**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.16.0`.

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

@@ -1,54 +0,0 @@
-# split
-
-Splits a solid into [inside the cutter, outside the cutter].
-
-**split**(`solid`: [`Solid`](Solid.md), `cutter`: [`Solid`](Solid.md)): readonly \[[`Solid`](Solid.md), [`Solid`](Solid.md)\]
-
-
-
-## Example: Keep the plug and the surrounding body
-
-
-
-```ts
-const body = box({ size: [30, 20, 8] });
-const cutter = cylinder({ height: 10, diameter: 8 });
-const [plug, remainder] = split(body, cutter);
-// Move the plug beside the body to show both results.
-union([plug.translate([0, -20, 0]), remainder]);
-```
-
-
-
-The first result is the intersection; the second is the subtraction. The cutter itself
-is not returned. Either result may be empty or contain multiple disconnected components.
-
-## Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-<a id="cutter"></a>
-
-**`cutter`** · [`Solid`](Solid.md) · Required
-
-
-
-## Returns
-
-readonly \[[`Solid`](Solid.md), [`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.16.0`.

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

@@ -1,66 +0,0 @@
-# splitByPlane
-
-Splits a solid into [positive-normal side, negative side] at a world-space plane.
-
-**splitByPlane**(`solid`: [`Solid`](Solid.md), `plane`: [`PlaneOptions`](PlaneOptions.md)): readonly \[[`Solid`](Solid.md), [`Solid`](Solid.md)\]
-
-
-
-## Example: Separate two halves at X = 0
-
-
-
-```ts
-const body = box({ size: [30, 20, 8] });
-const [right, left] = splitByPlane(body, { normal: [1, 0, 0] });
-// The gap is only for display; the cut itself removes no material.
-union([right.translate([4, 0, 0]), left.translate([-4, 0, 0])]);
-```
-
-
-
-## Example: Keep only the positive half
-
-
-
-```ts
-const [right] = splitByPlane(box({ size: [30, 20, 8] }), { normal: [1, 0, 0] });
-right;
-```
-
-
-
-The nonzero normal is normalized; offset is the signed distance from the origin in
-millimetres, defaulting to zero. Both cut faces are closed. Select either tuple result
-to retain one side; either result may be empty.
-
-## Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-<a id="plane"></a>
-
-**`plane`** · [`PlaneOptions`](PlaneOptions.md) · Required
-
-
-
-## Returns
-
-readonly \[[`Solid`](Solid.md), [`Solid`](Solid.md)\]
-
-
-## Related APIs
-
-- [PlaneOptions](PlaneOptions.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.16.0`.