@metamesh/modeling 0.18.0 → 0.19.0

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

@@ -1,49 +0,0 @@
-# immutableBuffer
-
-Copies numeric data once into private storage. This pure helper needs no active generation.
-
-**immutableBuffer**\<`T` *extends* [`NumericArray`](../geometry/NumericArray.md)\>(`source`: `T`): [`ImmutableBuffer`](../geometry/ImmutableBuffer-type.md)\<`T`\>
-
-
-
-## Example
-
-```ts
-import { immutableBuffer } from "@metamesh/modeling";
-const heights = immutableBuffer(new Float32Array([2, 4, 6]));
-const count = heights.length;
-const first = heights.at(0);
-const doubled = Array.from(heights, (height) => height * 2);
-const editable = heights.copy();
-editable[0] = 8; // heights still contains 2, 4, 6.
-```
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`NumericArray`](../geometry/NumericArray.md)
-
-## Parameters
-
-<a id="source"></a>
-
-**`source`** · `T` · Required
-
-
-
-## Returns
-
-[`ImmutableBuffer`](../geometry/ImmutableBuffer-type.md)\<`T`\>
-
-
-## Related APIs
-
-- [ImmutableBuffer](ImmutableBuffer-type.md)
-- [NumericArray](NumericArray.md)
-
-## Guides
-
-- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,34 +0,0 @@
-# isGeometryError
-
-Recognizes structured geometry errors from separately bundled Modeling copies in the same realm.
-
-**isGeometryError**(`value`: `unknown`): `value is GeometryError`
-
-
-
-Ordinary errors and unmarked code-shaped objects are rejected. The marker is execution-local and
-does not survive structured cloning; worker protocols carry their own serialized error envelope.
-
-## Parameters
-
-<a id="value"></a>
-
-**`value`** · `unknown` · Required
-
-
-
-## Returns
-
-`value is GeometryError`
-
-
-## Related APIs
-
-- [GeometryError](GeometryError.md)
-
-## 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/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.18.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.18.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.18.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.18.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.18.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.18.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.18.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.18.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.18.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.18.0`.

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

@@ -1,111 +0,0 @@
-# VectorTextLayoutOptions
-
-Text bounded to 512 UTF-16 units: horizontal lines or one circular line without wrapping.
-
-## Extends
-
-- [`VectorTextOptions`](VectorTextOptions.md)
-
-## Properties
-
-### align?
-
-
-
-`readonly` `optional` **align?**: `"left"` \| `"right"` \| `"center"`
-
-
-
-Place the advance's start, midpoint or end at the datum; defaults to center on arcs, otherwise left.
-
-***
-
-### baseline?
-
-
-
-`readonly` `optional` **baseline?**: [`VectorTextArcBaseline`](VectorTextArcBaseline.md)
-
-
-
-Omitted uses horizontal lines. Arcs require one line and baseline vertical alignment.
-
-***
-
-### lineHeight?
-
-
-
-`readonly` `optional` **lineHeight?**: `number`
-
-
-
-Baseline spacing in ems, 0.5–5; omitted uses the selected face's natural vertical metrics.
-
-***
-
-### verticalAlign?
-
-
-
-`readonly` `optional` **verticalAlign?**: `"top"` \| `"bottom"` \| `"center"` \| `"baseline"`
-
-
-
-Place the first baseline or complete ink bounds at Y=0; arcs only accept baseline.
-
-***
-
-### fontSize
-
-
-
-`readonly` **fontSize**: `number`
-
-
-
-Em size in millimetres, greater than zero and at most 10000; not the visible glyph height.
-
-#### Inherited from
-
-[`VectorTextOptions`](VectorTextOptions.md).[`fontSize`](VectorTextOptions.md#fontsize)
-
-***
-
-### fontWeight?
-
-
-
-`readonly` `optional` **fontWeight?**: `number`
-
-
-
-Actual static or variable weight, 1–1000; defaults to the prepared face's static weight.
-
-#### Inherited from
-
-[`VectorTextOptions`](VectorTextOptions.md).[`fontWeight`](VectorTextOptions.md#fontweight)
-
-***
-
-### letterSpacing?
-
-
-
-`readonly` `optional` **letterSpacing?**: `number`
-
-
-
-Tracking between glyph clusters in millimetres, -100–100; defaults to zero.
-
-#### Inherited from
-
-[`VectorTextOptions`](VectorTextOptions.md).[`letterSpacing`](VectorTextOptions.md#letterspacing)
-
-
-## Related APIs
-
-- [VectorTextArcBaseline](VectorTextArcBaseline.md)
-- [VectorTextOptions](VectorTextOptions.md)
-
-Package: `@metamesh/modeling@0.18.0`.

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

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