@metamesh/modeling 0.17.0 → 0.19.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.17.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.17.0`.

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

@@ -1,54 +0,0 @@
-# path2
-
-Snapshots finite XY coordinates as an immutable sampled path, independent of engine initialization.
-
-**path2**(`input`: [`Path2Input`](Path2Input.md), `options?`: [`PathOptions`](PathOptions.md)): [`Path2`](Path2-type.md)
-
-
-
-Open paths may be empty or have one point; closed paths need three vertices and omit a duplicated
-seam. Repeated adjacent vertices are retained. No winding normalization or filling is performed.
-Malformed dimensions or topology throw INVALID_ARGUMENT; nonfinite coordinates or measurement
-overflow throw NON_FINITE_VALUE; exhausted allocation ceilings throw COMPLEXITY_LIMIT GeometryError.
-A path input retains its closure. Limits bound construction only; resampling takes its own limits.
-
-Use `toData()` for a frozen record that restores coordinates, closure, and dimension together.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Path2Input`](Path2Input.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`PathOptions`](PathOptions.md) · Optional
-
-- [`closed`](PathOptions.md#closed) · `boolean` · Optional
-
-  Connects the last vertex to the first; closed paths omit the repeated seam. Defaults to false.
-
-- [`limits`](PathOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
-
-  Construction point ceiling; defaults to package sampling limits. Later sampling has its own options.
-
-
-
-## Returns
-
-[`Path2`](Path2-type.md)
-
-
-## Related APIs
-
-- [Path2](Path2-type.md)
-- [Path2Input](Path2Input.md)
-- [PathOptions](PathOptions.md)
-
-## 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/path3.md

@@ -1,49 +0,0 @@
-# path3
-
-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.
-
-**path3**(`input`: [`Path3Input`](Path3Input.md), `options?`: [`PathOptions`](PathOptions.md)): [`Path3`](Path3-type.md)
-
-
-
-Use `toData()` for a frozen record that restores coordinates, closure, and dimension together.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Path3Input`](Path3Input.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`PathOptions`](PathOptions.md) · Optional
-
-- [`closed`](PathOptions.md#closed) · `boolean` · Optional
-
-  Connects the last vertex to the first; closed paths omit the repeated seam. Defaults to false.
-
-- [`limits`](PathOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
-
-  Construction point ceiling; defaults to package sampling limits. Later sampling has its own options.
-
-
-
-## Returns
-
-[`Path3`](Path3-type.md)
-
-
-## Related APIs
-
-- [Path3](Path3-type.md)
-- [Path3Input](Path3Input.md)
-- [PathOptions](PathOptions.md)
-- [path2](path2.md)
-
-## 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/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.17.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.17.0`.

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

@@ -1,46 +0,0 @@
-# transform2
-
-Creates an immutable XY transform, identity by default.
-
-**transform2**(`input?`: [`Transform2Input`](Transform2Input.md)): [`Transform2`](Transform2-type.md)
-
-
-
-## Example
-
-```ts
-const placement = transform2().rotate(90).translate([10, 0]);
-placement.applyPoint([1, 0]).toData(); // approximately [10, 1]
-```
-
-Values and data are copied and validated.
-Pass it directly to Section.transform() and planar data helpers; to3D() explicitly crosses into XYZ.
-Zero scales and singular matrices throw GeometryError; negative scales reflect.
-
-Use `toData()` for frozen matrix interchange.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Transform2Input`](Transform2Input.md) · Optional
-
-
-
-## Returns
-
-[`Transform2`](Transform2-type.md)
-
-
-## Related APIs
-
-- [Transform2](Transform2-type.md)
-- [Transform2Input](Transform2Input.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/transform3.md

@@ -1,48 +0,0 @@
-# transform3
-
-Creates an immutable XYZ transform, identity by default.
-
-**transform3**(`input?`: [`Transform3Input`](Transform3Input.md)): [`Transform3`](Transform3-type.md)
-
-
-
-## Example
-
-```ts
-const placement = transform3().rotate([0, 0, 90]).translate([10, 0, 0]);
-placement.applyPoint([1, 0, 0]).toData(); // approximately [10, 1, 0]
-```
-
-Values and data are copied and validated.
-Calls apply in written order; rotations use degrees and pivots use current world coordinates.
-Zero scales, singular matrices, nonfinite inputs and zero rotation axes throw GeometryError.
-Use frameTransform3(frame) as the input for existing orthonormal frame placement.
-
-Use `toData()` for frozen matrix interchange.
-[composeTransform3](../geometry/composeTransform3.md) takes matrices in after, before order.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Transform3Input`](Transform3Input.md) · Optional
-
-
-
-## Returns
-
-[`Transform3`](Transform3-type.md)
-
-
-## Related APIs
-
-- [Transform3](Transform3-type.md)
-- [Transform3Input](Transform3Input.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/vector2.md

@@ -1,40 +0,0 @@
-# vector2
-
-Creates immutable XY arithmetic from a finite tuple or vector, snapshotting the coordinates.
-
-**vector2**(`input`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
-
-
-
-Values and results are finite. Invalid dimensions throw `INVALID_ARGUMENT`; nonfinite coordinates
-and overflow throw `NON_FINITE_VALUE` GeometryError.
-Use transform2().applyDirection(value) for rotations and nonuniform scaling.
-
-Use `toData()` for frozen tuple interchange, or
-[normalize2](../geometry/normalize2.md) for tuple-based normalization in numerical loops.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Vector2Input`](Vector2Input.md) · Required
-
-
-
-## Returns
-
-[`Vector2`](Vector2-type.md)
-
-
-## Related APIs
-
-- [Vector2](Vector2-type.md)
-- [Vector2Input](Vector2Input.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/vector3.md

@@ -1,47 +0,0 @@
-# vector3
-
-Creates immutable XYZ arithmetic from a finite tuple or vector, snapshotting the coordinates.
-
-**vector3**(`input`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
-
-
-
-## Example
-
-```ts
-const direction = vector3([1, 2, 3]).add([4, 0, 0]).normalize().scale(10);
-const alignment = direction.dot([0, 0, 1]);
-```
-
-Values and results are finite. Invalid dimensions throw `INVALID_ARGUMENT`; nonfinite coordinates
-and overflow throw `NON_FINITE_VALUE` GeometryError.
-Use transform3().applyDirection(value) for rotations and nonuniform scaling.
-
-Use `toData()` for frozen tuple interchange, or
-[normalize3](../geometry/normalize3.md) for tuple-based normalization in numerical loops.
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-## Returns
-
-[`Vector3`](Vector3-type.md)
-
-
-## Related APIs
-
-- [Vector3](Vector3-type.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.17.0`.

package/dist/docs/reference/text/Bounds2Data.md

@@ -1,34 +0,0 @@
-# Bounds2Data
-
-Plain axis-aligned XY bounds for interchange; use bounds2 for immutable measurement methods.
-
-## Properties
-
-### max
-
-
-
-`readonly` **max**: [`Vector2Data`](Vector2Data.md)
-
-
-
-Inclusive maximum X/Y coordinates.
-
-***
-
-### min
-
-
-
-`readonly` **min**: [`Vector2Data`](Vector2Data.md)
-
-
-
-Inclusive minimum X/Y coordinates.
-
-
-## Related APIs
-
-- [Vector2Data](Vector2Data.md)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/text/Vector2Data.md

@@ -1,7 +0,0 @@
-# Vector2Data
-
-A two-dimensional Cartesian vector or point.
-
-**Vector2Data** = readonly \[`x`: `number`, `y`: `number`\]
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/text/VectorTextArcBaseline.md

@@ -1,53 +0,0 @@
-# VectorTextArcBaseline
-
-A circular baseline centered at the XY origin, with rigid shaped glyph groups.
-
-## Properties
-
-### kind
-
-
-
-`readonly` **kind**: `"arc"`
-
-
-
-Selects a circular baseline; glyph outlines rotate without bending or stretching.
-
-***
-
-### radius
-
-
-
-`readonly` **radius**: `number`
-
-
-
-Baseline radius in millimetres, greater than zero and at most 10000.
-
-***
-
-### centerAngle?
-
-
-
-`readonly` `optional` **centerAngle?**: `number`
-
-
-
-Alignment datum in degrees counterclockwise from +X; defaults to 90.
-
-***
-
-### direction?
-
-
-
-`readonly` `optional` **direction?**: `"clockwise"` \| `"counterclockwise"`
-
-
-
-Reading direction around the circle; defaults to clockwise.
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,34 +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)
-
-Package: `@metamesh/modeling@0.17.0`.