@metamesh/modeling 0.12.0 → 0.14.0

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

@@ -0,0 +1,39 @@
+# transform3
+
+Creates an immutable XYZ transform, identity by default. Matrices 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.
+
+**transform3**(`matrix?`: [`Transform3Matrix`](Transform3Matrix.md)): [`Transform3`](Transform3-type.md)
+
+
+
+## Example
+
+```ts
+const placement = transform3().rotate([0, 0, 90]).translate([10, 0, 0]);
+placement.applyPoint([1, 0, 0]).toArray(); // approximately [10, 1, 0]
+```
+
+## Parameters
+
+<a id="matrix"></a>
+
+**`matrix`** · [`Transform3Matrix`](Transform3Matrix.md) · Optional
+
+
+
+## Returns
+
+[`Transform3`](Transform3-type.md)
+
+
+## Related APIs
+
+- [Transform3](Transform3-type.md)
+- [Transform3Matrix](Transform3Matrix.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)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,77 @@
+# tube
+
+Hollow +Z tube.
+
+**tube**(`options`: [`TubeOptions`](TubeOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Tube
+
+
+
+```ts
+tube({ height: 20, outerRadius: 10, innerRadius: 6 });
+```
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`TubeOptions`](TubeOptions.md) · Required
+
+- [`height`](TubeOptions.md#height) · `number` · Required
+
+  Total height along Z in millimetres.
+
+- [`innerRadius`](TubeOptions.md#innerradius) · `number` · Required
+
+  Positive inner radius in millimetres.
+
+- [`outerRadius`](TubeOptions.md#outerradius) · `number` · Required
+
+  Outer radius in millimetres; greater than [TubeOptions.innerRadius](TubeOptions.md#innerradius).
+
+- [`limits`](TubeOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings; bound modeling operations may only lower the host policy.
+
+- [`segments`](TubeOptions.md#segments) · `number` · Optional
+
+  Exact circumferential segment count from three through the configured safety limit.
+
+  This local topology override takes precedence over [CircularPrimitiveOptions.resolution](CircularPrimitiveOptions.md#resolution)
+  and any active model-wide resolution policy.
+
+- [`resolution`](TubeOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+- [`placement`](TubeOptions.md#placement) · [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md) · Optional
+
+  Applied after local construction; Section placement must preserve the XY plane.
+
+- [`center`](TubeOptions.md#center) · `boolean` · Optional · Default: `true`
+
+  Centers the tube on the Z origin when `true`; otherwise its bottom is at `Z = 0`.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [TubeOptions](TubeOptions.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,72 @@
+# union
+
+Robust union.
+
+## Call Signature
+
+
+
+**union**(`solids`: readonly [`Solid`](Solid.md)[]): [`Solid`](Solid.md)
+
+
+
+## Example: Union
+
+
+
+```ts
+const block = box({ size: 20 });
+const cap = sphere({ radius: 10 }).translate([0, 0, 10]);
+union([block, cap]);
+```
+
+
+
+Robust union.
+
+### Parameters
+
+<a id="solids"></a>
+
+**`solids`** · readonly [`Solid`](Solid.md)[] · Required
+
+
+
+### Returns
+
+[`Solid`](Solid.md)
+
+## Call Signature
+
+
+
+**union**(`sections`: readonly [`Section`](Section.md)[]): [`Section`](Section.md)
+
+
+
+Native filled section union; dimensions cannot be mixed.
+
+### Parameters
+
+<a id="sections"></a>
+
+**`sections`** · readonly [`Section`](Section.md)[] · Required
+
+
+
+### Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.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.14.0`.

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

@@ -0,0 +1,32 @@
+# vector2
+
+Creates immutable XY arithmetic from a finite tuple or vector, snapshotting the coordinates. 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.
+
+**vector2**(`input`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
+
+
+
+## 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)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,39 @@
+# vector3
+
+Creates immutable XYZ arithmetic from a finite tuple or vector, snapshotting the coordinates. 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.
+
+**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]);
+```
+
+## 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)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model.md

@@ -0,0 +1,39 @@
+# Model API
+
+Immutable shapes, vectors and transforms with fluent operations and host-owned geometry evaluation.
+
+Import `generate`, shape constructors, vectors, transforms and collection functions from `@metamesh/modeling`. Chain shape methods to transform, subtract, and finish immutable recipes; a host session owns execution and optional computed caches.
+
+```ts
+import { box, cylinder, generate } from "@metamesh/modeling";
+import { createModelEngine } from "@metamesh/modeling/engine";
+const model = generate<Record<never, never>>(({ part }) => [part("plate", box({ size: [30, 20, 6] }).subtract([cylinder({ radius: 3, height: 8 })]))]);
+const engine = await createModelEngine();
+const session = engine.createSession(model);
+const snapshot = session.run({});
+snapshot.dispose();
+session.dispose();
+```
+
+Computed data and recipes reuse unchanged work. Part placement and color are separate from local geometry. Section recipes preserve holes through Boolean and offset chains. Construction and composition work without an engine. Ordinary recipes may be reused across sessions regardless of where constructed. Explicit resolution settings are captured; unspecified settings inherit the evaluating host defaults. Observed component selections remain restricted to their originating session. Observations require synchronous host execution. Temporary native allocations belong to the current transaction; sessions may retain bounded evaluated geometry privately. Copied snapshots remain valid after session disposal until they are disposed.
+
+See [host lifecycle](engine.md) and [pure foundations](geometry.md).
+
+## Categories
+
+- [Primitives](model/categories/primitives.md) — Create foundational solid geometry and configure its dimensions and tessellation.
+- [Local resolution](model/categories/resolution.md) — Choose physical curve sampling and explicit native tolerance.
+- [2D Sections](model/categories/sections.md) — Create immutable filled XY shapes, including prepared text and bounded painted SVG.
+- [Boolean Operations](model/categories/boolean-operations.md) — Combine, intersect and subtract same-dimensional shapes; construct solid envelopes and sums.
+- [Transforms, Vectors & Placement](model/categories/transforms-placement.md) — Calculate with immutable vectors, reuse transforms, and arrange geometry with explicit placement contracts.
+- [Extrude, Revolve & Sweep](model/categories/extrude-revolve-sweep.md) — Turn sections and paths into extruded, lofted, revolved, or swept solids.
+- [Printable threads](model/categories/threads.md) — Construct compensated thread forms and inspect allocation-free preflight facts.
+- [Mesh & Inspection](model/categories/mesh-inspection.md) — Convert validated meshes and inspect stable section or solid measurements.
+- [Core Values & Errors](model/categories/core-values-errors.md) — Use the small shared vocabulary for authored geometry, coordinates, paths, and stable failures.
+- [Explicit matching profiles](model/categories/explicit-profiles.md) — Build hollow or multicomponent lofts and sweeps using stable landmarks.
+- [Sampled surfaces](model/categories/bounded-surfaces.md) — Construct bounded heightfields and positive-inside implicit fields.
+- [Solid inspection](model/categories/inspection.md) — Evaluate recipes and copy observations while the host owns native resources.
+- [Model generation](model/categories/generation.md) — Declare typed programs, optional computations, semantic parts and structured diagnostics.
+- [Model contracts](model/categories/contracts.md) — Describe opaque handles, dimensions, manufacturing parts, and completed snapshots.
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,34 @@
+# Bounds2
+
+Axis-aligned bounds in two-dimensional model space.
+
+## Properties
+
+### max
+
+
+
+`readonly` **max**: [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Inclusive maximum X/Y coordinates.
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Inclusive minimum X/Y coordinates.
+
+
+## Related APIs
+
+- [Vector2Tuple](Vector2Tuple.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,7 @@
+# MAX_VECTOR_FONT_BYTES
+
+Limits apply before parsing or shaping untrusted font data.
+
+`const` **MAX\_VECTOR\_FONT\_BYTES**: `number`
+
+Package: `@metamesh/modeling@0.14.0`.

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

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

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

@@ -0,0 +1,186 @@
+# VectorFont
+
+A prepared font owns its parsed bytes; keep handles local to their Worker or invocation.
+
+## Properties
+
+### layout
+
+
+
+`readonly` **layout**: (`text`: `string`, `options`: [`VectorTextLayoutOptions`](VectorTextLayoutOptions.md)) => [`VectorTextLayout`](VectorTextLayout.md)
+
+
+
+Shape horizontal lines or one circular line; bounded to 512 UTF-16 units and supports blank text.
+
+#### Parameters
+
+<a id="text"></a>
+
+**`text`** · `string` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`VectorTextLayoutOptions`](VectorTextLayoutOptions.md) · Required
+
+- [`fontSize`](VectorTextLayoutOptions.md#fontsize) · `number` · Required
+
+  Em size in millimetres, greater than zero and at most 10000; not the visible glyph height.
+
+- [`align`](VectorTextLayoutOptions.md#align) · `"left"` \| `"right"` \| `"center"` · Optional
+
+  Place the advance's start, midpoint or end at the datum; defaults to center on arcs, otherwise left.
+
+- [`baseline`](VectorTextLayoutOptions.md#baseline) · [`VectorTextArcBaseline`](VectorTextArcBaseline.md) · Optional
+
+  Omitted uses horizontal lines. Arcs require one line and baseline vertical alignment.
+
+- [`lineHeight`](VectorTextLayoutOptions.md#lineheight) · `number` · Optional
+
+  Baseline spacing in ems, 0.5–5; omitted uses the selected face's natural vertical metrics.
+
+- [`verticalAlign`](VectorTextLayoutOptions.md#verticalalign) · `"top"` \| `"bottom"` \| `"center"` \| `"baseline"` · Optional
+
+  Place the first baseline or complete ink bounds at Y=0; arcs only accept baseline.
+
+- [`fontWeight`](VectorTextLayoutOptions.md#fontweight) · `number` · Optional
+
+  Actual static or variable weight, 1–1000; defaults to the prepared face's static weight.
+
+- [`letterSpacing`](VectorTextLayoutOptions.md#letterspacing) · `number` · Optional
+
+  Tracking between glyph clusters in millimetres, -100–100; defaults to zero.
+
+
+
+#### Returns
+
+[`VectorTextLayout`](VectorTextLayout.md)
+
+***
+
+### measure
+
+
+
+`readonly` **measure**: (`text`: `string`, `options`: [`VectorTextLayoutOptions`](VectorTextLayoutOptions.md)) => [`VectorTextMetrics`](VectorTextMetrics.md)
+
+
+
+Measure the same cached vector layout; all returned lengths are in millimetres.
+
+#### Parameters
+
+<a id="text-1"></a>
+
+**`text`** · `string` · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`VectorTextLayoutOptions`](VectorTextLayoutOptions.md) · Required
+
+- [`fontSize`](VectorTextLayoutOptions.md#fontsize) · `number` · Required
+
+  Em size in millimetres, greater than zero and at most 10000; not the visible glyph height.
+
+- [`align`](VectorTextLayoutOptions.md#align) · `"left"` \| `"right"` \| `"center"` · Optional
+
+  Place the advance's start, midpoint or end at the datum; defaults to center on arcs, otherwise left.
+
+- [`baseline`](VectorTextLayoutOptions.md#baseline) · [`VectorTextArcBaseline`](VectorTextArcBaseline.md) · Optional
+
+  Omitted uses horizontal lines. Arcs require one line and baseline vertical alignment.
+
+- [`lineHeight`](VectorTextLayoutOptions.md#lineheight) · `number` · Optional
+
+  Baseline spacing in ems, 0.5–5; omitted uses the selected face's natural vertical metrics.
+
+- [`verticalAlign`](VectorTextLayoutOptions.md#verticalalign) · `"top"` \| `"bottom"` \| `"center"` \| `"baseline"` · Optional
+
+  Place the first baseline or complete ink bounds at Y=0; arcs only accept baseline.
+
+- [`fontWeight`](VectorTextLayoutOptions.md#fontweight) · `number` · Optional
+
+  Actual static or variable weight, 1–1000; defaults to the prepared face's static weight.
+
+- [`letterSpacing`](VectorTextLayoutOptions.md#letterspacing) · `number` · Optional
+
+  Tracking between glyph clusters in millimetres, -100–100; defaults to zero.
+
+
+
+#### Returns
+
+[`VectorTextMetrics`](VectorTextMetrics.md)
+
+***
+
+### toSvg
+
+
+
+`readonly` **toSvg**: (`text`: `string`, `options`: [`VectorTextLayoutOptions`](VectorTextLayoutOptions.md)) => `string`
+
+
+
+Serialize visible horizontal or circular outlines as bounded path-only SVG in physical millimetres.
+
+#### Parameters
+
+<a id="text-2"></a>
+
+**`text`** · `string` · Required
+
+
+
+<a id="options-2"></a>
+
+**`options`** · [`VectorTextLayoutOptions`](VectorTextLayoutOptions.md) · Required
+
+- [`fontSize`](VectorTextLayoutOptions.md#fontsize) · `number` · Required
+
+  Em size in millimetres, greater than zero and at most 10000; not the visible glyph height.
+
+- [`align`](VectorTextLayoutOptions.md#align) · `"left"` \| `"right"` \| `"center"` · Optional
+
+  Place the advance's start, midpoint or end at the datum; defaults to center on arcs, otherwise left.
+
+- [`baseline`](VectorTextLayoutOptions.md#baseline) · [`VectorTextArcBaseline`](VectorTextArcBaseline.md) · Optional
+
+  Omitted uses horizontal lines. Arcs require one line and baseline vertical alignment.
+
+- [`lineHeight`](VectorTextLayoutOptions.md#lineheight) · `number` · Optional
+
+  Baseline spacing in ems, 0.5–5; omitted uses the selected face's natural vertical metrics.
+
+- [`verticalAlign`](VectorTextLayoutOptions.md#verticalalign) · `"top"` \| `"bottom"` \| `"center"` \| `"baseline"` · Optional
+
+  Place the first baseline or complete ink bounds at Y=0; arcs only accept baseline.
+
+- [`fontWeight`](VectorTextLayoutOptions.md#fontweight) · `number` · Optional
+
+  Actual static or variable weight, 1–1000; defaults to the prepared face's static weight.
+
+- [`letterSpacing`](VectorTextLayoutOptions.md#letterspacing) · `number` · Optional
+
+  Tracking between glyph clusters in millimetres, -100–100; defaults to zero.
+
+
+
+#### Returns
+
+`string`
+
+
+## Related APIs
+
+- [VectorTextLayout](VectorTextLayout.md)
+- [VectorTextLayoutOptions](VectorTextLayoutOptions.md)
+- [VectorTextMetrics](VectorTextMetrics.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,17 @@
+# VectorFontOptions
+
+Identifies the actual weight of a static face, without synthesizing a different weight.
+
+## Properties
+
+### staticWeight?
+
+
+
+`readonly` `optional` **staticWeight?**: `number`
+
+
+
+Actual weight of a static face, 1–1000; defaults to 400.
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,53 @@
+# 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.
+
+***
+
+### centerAngleDegrees?
+
+
+
+`readonly` `optional` **centerAngleDegrees?**: `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.14.0`.

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

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