@metamesh/modeling 0.18.0 → 0.19.0

package/dist/docs/reference/model/Vector3-type.md

@@ -1,283 +0,0 @@
-# Vector3
-
-Immutable XYZ arithmetic; vector operations return new values and measurements return numbers.
-
-## Properties
-
-### x
-
-
-
-`readonly` **x**: `number`
-
-
-
-X coordinate in the vector's coordinate units.
-
-***
-
-### y
-
-
-
-`readonly` **y**: `number`
-
-
-
-Y coordinate in the vector's coordinate units.
-
-***
-
-### z
-
-
-
-`readonly` **z**: `number`
-
-
-
-Z coordinate in the vector's coordinate units.
-
-## Methods
-
-### add()
-
-
-
-**add**(`other`: [`Vector3Input`](Vector3Input.md)): `Vector3`
-
-
-
-Adds another vector component-wise.
-
-#### Parameters
-
-<a id="other"></a>
-
-**`other`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-`Vector3`
-
-***
-
-### subtract()
-
-
-
-**subtract**(`other`: [`Vector3Input`](Vector3Input.md)): `Vector3`
-
-
-
-Subtracts another vector component-wise.
-
-#### Parameters
-
-<a id="other-1"></a>
-
-**`other`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-`Vector3`
-
-***
-
-### scale()
-
-
-
-**scale**(`factor`: `number`): `Vector3`
-
-
-
-Multiplies by a finite dimensionless scalar.
-
-#### Parameters
-
-<a id="factor"></a>
-
-**`factor`** · `number` · Required
-
-
-
-#### Returns
-
-`Vector3`
-
-***
-
-### normalize()
-
-
-
-**normalize**(`epsilon?`: `number`): `Vector3`
-
-
-
-Returns a unit vector; rejects length at or below finite nonnegative `epsilon` (default `1e-12`).
-
-#### Parameters
-
-<a id="epsilon"></a>
-
-**`epsilon`** · `number` · Optional
-
-
-
-#### Returns
-
-`Vector3`
-
-***
-
-### lerp()
-
-
-
-**lerp**(`other`: [`Vector3Input`](Vector3Input.md), `t`: `number`): `Vector3`
-
-
-
-Interpolates toward another vector by finite dimensionless `t`; extrapolation is allowed.
-
-#### Parameters
-
-<a id="other-2"></a>
-
-**`other`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="t"></a>
-
-**`t`** · `number` · Required
-
-
-
-#### Returns
-
-`Vector3`
-
-***
-
-### dot()
-
-
-
-**dot**(`other`: [`Vector3Input`](Vector3Input.md)): `number`
-
-
-
-Returns the scalar dot product.
-
-#### Parameters
-
-<a id="other-3"></a>
-
-**`other`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-`number`
-
-***
-
-### cross()
-
-
-
-**cross**(`other`: [`Vector3Input`](Vector3Input.md)): `Vector3`
-
-
-
-Returns the right-handed cross product as a new vector.
-
-#### Parameters
-
-<a id="other-4"></a>
-
-**`other`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-`Vector3`
-
-***
-
-### length()
-
-
-
-**length**(): `number`
-
-
-
-Returns Euclidean length in the vector's coordinate units.
-
-#### Returns
-
-`number`
-
-***
-
-### distance()
-
-
-
-**distance**(`other`: [`Vector3Input`](Vector3Input.md)): `number`
-
-
-
-Returns Euclidean distance to another vector in the same coordinate units.
-
-#### Parameters
-
-<a id="other-5"></a>
-
-**`other`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-`number`
-
-***
-
-### toData()
-
-
-
-**toData**(): [`Vector3Data`](Vector3Data.md)
-
-
-
-Returns this value's frozen readonly tuple for interchange; repeated calls do not allocate.
-
-#### Returns
-
-[`Vector3Data`](Vector3Data.md)
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-- [Vector3Input](Vector3Input.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.18.0`.

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

@@ -1,15 +0,0 @@
-# Vector3Data
-
-A three-dimensional Cartesian vector or point.
-
-**Vector3Data** = readonly \[`x`: `number`, `y`: `number`, `z`: `number`\]
-
-
-
-
-## Guides
-
-- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,21 +0,0 @@
-# Vector3Input
-
-An XYZ tuple or immutable fluent vector accepted by vector operations.
-
-**Vector3Input** = [`Vector3Data`](Vector3Data.md) \| [`Vector3`](Vector3-type.md)
-
-
-
-
-## Related APIs
-
-- [Vector3](Vector3-type.md)
-- [Vector3Data](Vector3Data.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.18.0`.

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

@@ -1,40 +0,0 @@
-# VectorTextLayout
-
-Immutable vector layout with no browser, font parser, or kernel ownership.
-
-## Properties
-
-### paths
-
-
-
-`readonly` **paths**: readonly `string`[]
-
-
-
-Nonzero-filled path data in millimetres, positive Y upward; empty for text with no ink.
-
-***
-
-### metrics
-
-
-
-`readonly` **metrics**: [`VectorTextMetrics`](VectorTextMetrics.md)
-
-
-
-Exact measurements of these paths and their logical text layout.
-
-
-## Related APIs
-
-- [VectorTextMetrics](VectorTextMetrics.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.18.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.18.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)): [`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 10.0.0 or newer in major 10.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Bounds2Options`](Bounds2Options.md) \| [`Bounds2`](Bounds2-type.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.18.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)): [`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 10.0.0 or newer in major 10.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Bounds3Options`](Bounds3Options.md) \| [`Bounds3`](Bounds3-type.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.18.0`.

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

@@ -1,38 +0,0 @@
-# Bounds
-
-Measure immutable axis-aligned bounds and check whether positioned bounds contain one another.
-
-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.18.0`.

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

@@ -1,16 +0,0 @@
-# Model contracts
-
-Understand opaque shape handles, dimensions, manufacturing parts, and durable model results.
-
-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 results contain copied manufacturing arrays and exact facts. Resource ceilings bound sampling and aggregate output.
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [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.18.0`.

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

@@ -1,44 +0,0 @@
-# Core values and errors
-
-Use shared coordinate data and recognize structured geometry errors.
-
-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.
-
-## Functions
-
-| API | Summary |
-| --- | --- |
-| [isGeometryError](../isGeometryError.md) | Recognizes structured geometry errors from separately bundled Modeling copies in the same realm. |
-
-## Classes
-
-| API | Summary |
-| --- | --- |
-| [GeometryError](../GeometryError.md) | Error raised when a geometry precondition or invariant is not satisfied. |
-
-## 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. |
-| [GeometryErrorContext](../GeometryErrorContext.md) | Serializable context attached to a geometry failure. |
-
-## 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. |
-| [GeometryErrorCode](../GeometryErrorCode.md) | Stable categories for invalid inputs, topology, allocation, and runtime failures. |
-
-## Guides
-
-- [Geometry vocabulary](../../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,42 +0,0 @@
-# Sampled paths
-
-Reuse immutable sampled paths in 2D or 3D.
-
-Use `path2` and `path3` for immutable sampled paths. `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. |
-| [CurveSamplingOptions](../CurveSamplingOptions.md) | Explicit physical sampling and allocation policy for reusable curves. |
-
-## 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.18.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.18.0`.