@metamesh/modeling 0.17.0 → 0.19.0

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

@@ -1,100 +0,0 @@
-# VectorTextMetrics
-
-Text measurements from the same immutable layout that supplies geometry and SVG outlines.
-
-## Properties
-
-### bounds
-
-
-
-`readonly` **bounds**: [`Bounds2Data`](Bounds2Data.md) \| `null`
-
-
-
-Visible curve bounds after alignment, or null when the text has no ink.
-
-***
-
-### advance
-
-
-
-`readonly` **advance**: readonly \[`number`, `number`\]
-
-
-
-Unaligned logical advance and negative baseline displacement in mm; arcs retain [arc length, 0].
-
-***
-
-### logicalWidth
-
-
-
-`readonly` **logicalWidth**: `number`
-
-
-
-Maximum logical line advance in millimetres, including spaces; arc length on circular baselines.
-
-***
-
-### ascent
-
-
-
-`readonly` **ascent**: `number`
-
-
-
-Selected font's ascender distance above a baseline in millimetres, independent of the text.
-
-***
-
-### descent
-
-
-
-`readonly` **descent**: `number`
-
-
-
-Selected font's descender distance below a baseline in millimetres, a non-negative value.
-
-***
-
-### lineHeight
-
-
-
-`readonly` **lineHeight**: `number`
-
-
-
-Actual distance between baselines in millimetres.
-
-***
-
-### lineCount
-
-
-
-`readonly` **lineCount**: `number`
-
-
-
-Number of lines, including empty and trailing lines; empty text occupies one line.
-
-
-## Related APIs
-
-- [Bounds2Data](Bounds2Data.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.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/bounds2.md

@@ -1,37 +0,0 @@
-# bounds2
-
-Constructs immutable finite XY bounds from ordered extrema or nonnegative size in millimetres.
-
-**bounds2**(`input`: [`Bounds2Options`](Bounds2Options.md)): [`Bounds2`](Bounds2-type.md)
-
-
-
-Zero extents are valid. Invalid dimensions, nonfinite coordinates, reversed bounds and
-overflowing extents throw `INVALID_ARGUMENT` GeometryError. Use `toData()` for plain records.
-Size construction centers on the origin unless `center` is false. Size and extrema are exclusive.
-Compiled Generator packages passing these values to host recipes or computed data require
-runtime 9.0.0 or newer in major 9.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Bounds2Options`](Bounds2Options.md) · Required
-
-
-
-## Returns
-
-[`Bounds2`](Bounds2-type.md)
-
-
-## Related APIs
-
-- [Bounds2](Bounds2-type.md)
-- [Bounds2Options](Bounds2Options.md)
-
-## Guides
-
-- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,37 +0,0 @@
-# bounds3
-
-Constructs immutable finite XYZ bounds from ordered extrema or nonnegative size in millimetres.
-
-**bounds3**(`input`: [`Bounds3Options`](Bounds3Options.md)): [`Bounds3`](Bounds3-type.md)
-
-
-
-Zero extents are valid. Invalid dimensions, nonfinite coordinates, reversed bounds and
-overflowing extents throw `INVALID_ARGUMENT` GeometryError. Use `toData()` for plain records.
-Size construction centers on the origin unless `center` is false. Size and extrema are exclusive.
-Compiled Generator packages passing these values to host recipes or computed data require
-runtime 9.0.0 or newer in major 9.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Bounds3Options`](Bounds3Options.md) · Required
-
-
-
-## Returns
-
-[`Bounds3`](Bounds3-type.md)
-
-
-## Related APIs
-
-- [Bounds3](Bounds3-type.md)
-- [Bounds3Options](Bounds3Options.md)
-
-## Guides
-
-- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
-
-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/bounds.md

@@ -1,38 +0,0 @@
-# Bounds
-
-Measure immutable axis-aligned extents and test positioned containment.
-
-Use `bounds2` and `bounds3` for immutable axis-aligned bounds. `size()` and `center()` return fluent vectors. `containsBounds()` includes boundary contact in the same coordinate frame; zero extents are valid.
-
-Path bounds queries return values or `undefined` for empty paths. Measurements and snapshots retain `Bounds2Data`/`Bounds3Data` records: wrap them once for fluent queries, or use `toData()` for stable frozen interchange.
-
-Containment alone does not establish a manufacturing fit.
-
-## Functions
-
-| API | Summary |
-| --- | --- |
-| [bounds2](../bounds2.md) | Constructs immutable finite XY bounds from ordered extrema or nonnegative size in millimetres. |
-| [bounds3](../bounds3.md) | Constructs immutable finite XYZ bounds from ordered extrema or nonnegative size in millimetres. |
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [Bounds2](../Bounds2-type.md) | Immutable finite XY bounds in millimetres, with tuple coordinates for data interoperability. |
-| [Bounds3](../Bounds3-type.md) | Immutable finite XYZ bounds in millimetres, with tuple coordinates for data interoperability. |
-
-## Type aliases
-
-| API | Summary |
-| --- | --- |
-| [Bounds2Input](../Bounds2Input.md) | An immutable XY bounds value or its plain min/max representation. |
-| [Bounds3Input](../Bounds3Input.md) | An immutable XYZ bounds value or its plain min/max representation. |
-| [Bounds2Options](../Bounds2Options.md) | XY bounds construction from existing extrema or nonnegative dimensions, never both. |
-| [Bounds3Options](../Bounds3Options.md) | XYZ bounds construction from existing extrema or nonnegative dimensions, never both. |
-
-## Guides
-
-- [Measure and compare bounds](../../../guides/concepts.md#measure-and-compare-bounds)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,18 +0,0 @@
-# Model contracts
-
-Describe opaque handles, dimensions, manufacturing parts, and completed snapshots.
-
-Generation returns semantic parts through `part(id, geometry)` with optional placement and color. Ordinary immutable recipes are portable across sessions; observed component selections retain their originating session.
-
-Finalized snapshots contain copied manufacturing arrays and exact facts. Resource ceilings bound sampling and aggregate output.
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [FinalizedModel](../FinalizedModel.md) | Finalized manufacturing snapshot. Its arrays are independent of all native values. |
-| [FinalizedPart](../FinalizedPart.md) | Copied manufacturing part with facts computed from the finalized mesh. |
-| [GeometrySamplingLimits](../GeometrySamplingLimits.md) | Explicit allocation ceilings for pure sampling and host-owned modeling operations. |
-| [ModelingLimits](../ModelingLimits.md) | Aggregate manufacturing output ceilings selected by a trusted host. |
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/categories/core-values-errors.md

@@ -1,30 +0,0 @@
-# Core values
-
-Use shared coordinate, path, polygon, and bounds data.
-
-Use coordinate tuples, frames, contours, polygons, regions, and bounds records for plain-data interchange. `Contour` omits the duplicated closing point; `PolygonData` associates an exterior with its holes.
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [Frame3](../Frame3.md) | A right-handed orthonormal coordinate frame expressed in world coordinates. |
-| [PolygonData](../PolygonData.md) | One filled two-dimensional polygon with an exterior and optional holes. |
-| [Bounds2Data](../Bounds2Data.md) | Plain axis-aligned XY bounds for interchange; use bounds2 for immutable measurement methods. |
-| [Bounds3Data](../Bounds3Data.md) | Plain axis-aligned XYZ bounds for interchange; use bounds3 for immutable measurement methods. |
-
-## Type aliases
-
-| API | Summary |
-| --- | --- |
-| [Contour](../Contour.md) | A sampled closed two-dimensional boundary whose first point is not repeated at the end. |
-| [RegionData](../RegionData.md) | A two-dimensional region represented by disjoint filled polygons. Each PolygonData owns one exterior and its holes; an empty region contains no material. |
-| [Vector2Data](../Vector2Data.md) | A two-dimensional Cartesian vector or point. |
-| [Vector3Data](../Vector3Data.md) | A three-dimensional Cartesian vector or point. |
-
-## Guides
-
-- [Geometry vocabulary](../../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../../guides/concepts.md#lifecycle-and-inspection)
-
-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/categories/paths.md

@@ -1,41 +0,0 @@
-# Sampled paths
-
-Reusable immutable planar and spatial trajectories.
-
-Use `path2` and `path3` for immutable sampled trajectories. `transform()`, `reverse()`, and `resample()` return new values; Geometry accepts the path values directly.
-
-`closestPoint()` reports a boundary position and fraction within an edge, rather than a filled interior or analytic-curve solution. `bounds()` returns fluent bounds, or `undefined` for an empty path. `toData()` returns points with dimension and closure metadata.
-
-Closed paths omit the duplicated endpoint. `polygon` fills a closed planar path and establishes winding.
-
-## Functions
-
-| API | Summary |
-| --- | --- |
-| [path2](../path2.md) | Snapshots finite XY coordinates as an immutable sampled path, independent of engine initialization. |
-| [path3](../path3.md) | Snapshots finite XYZ coordinates as an immutable sampled path with the same closure, seam, allocation and error rules as path2. Analytic curves must be sampled explicitly first. |
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [Path2](../Path2-type.md) | Immutable directed XY polyline. Closure is explicit and does not imply a filled Section. |
-| [Path3](../Path3-type.md) | Immutable directed XYZ polyline; it represents sampled edges, not an analytic curve. |
-| [PathOptions](../PathOptions.md) | Topology and allocation ceiling for an immutable sampled path. |
-| [PathLocation](../PathLocation.md) | Nearest location on a sampled boundary, rather than inside a filled shape or on an analytic curve. |
-| [PathResamplingOptions](../PathResamplingOptions.md) | Equal arc-length sampling; the path itself owns whether its closing edge is included. |
-| [Path2Data](../Path2Data.md) | Complete plain XY path representation, including topology and empty-path dimensional identity. |
-| [Path3Data](../Path3Data.md) | Complete plain XYZ path representation, including topology and empty-path dimensional identity. |
-
-## Type aliases
-
-| API | Summary |
-| --- | --- |
-| [Path2Input](../Path2Input.md) | A matching path value, complete plain path data, or a collection of vectors. |
-| [Path3Input](../Path3Input.md) | A matching path value, complete plain path data, or a collection of vectors. |
-
-## Guides
-
-- [Path queries and closure-preserving interchange](../../../guides/concepts.md#query-paths-and-preserve-closure)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,20 +0,0 @@
-# Local resolution
-
-Choose physical curve sampling and explicit native tolerance.
-
-Exact operation counts override the operation's resolution policy, which overrides host session defaults. Pass resolution to each affected constructor or `Section` operation.
-
-`Solid.withTolerance()` changes native geometric tolerance on an immutable copy; it does not select curve sampling.
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [GeometryResolution](../GeometryResolution.md) | Tessellation policy for sampled geometry measured in millimetres. |
-| [GeometryToleranceOptions](../GeometryToleranceOptions.md) | Optional overrides for MetaMesh's geometry comparison policy. |
-
-## Guides
-
-- [Coordinates, units, and resolution](../../../guides/concepts.md#coordinates-units-and-resolution)
-
-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`.

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.17.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.17.0`.