@metamesh/modeling 0.11.0 → 0.13.0

package/dist/docs/reference/geometry/validateTriangleMesh.md

@@ -0,0 +1,59 @@
+# validateTriangleMesh
+
+Validates mesh buffers, indices, triangle area, and optionally closed topology.
+
+**validateTriangleMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+Closed validation requires exactly two oppositely directed uses per edge, rejecting boundary
+and non-manifold edges. It establishes edge connectivity without detecting geometric
+self-intersections between faces. The mesh is neither mutated nor copied.
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+Mesh to inspect.
+
+
+
+<a id="options"></a>
+
+**`options`** · [`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md) · Optional
+
+Empty-mesh, topology, and tolerance policy.
+
+- [`allowEmpty`](TriangleMeshValidationOptions.md#allowempty) · `boolean` · Optional
+
+  Permit an empty position and index buffer. Defaults to `false`.
+
+- [`requireClosed`](TriangleMeshValidationOptions.md#requireclosed) · `boolean` · Optional
+
+  Require two oppositely wound faces per edge; geometric self-intersections are not detected.
+
+- [`tolerance`](TriangleMeshValidationOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Numeric comparison overrides used for zero-area triangle detection.
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+The original mesh after successful validation.
+
+
+## Throws
+
+- GeometryError When any requested invariant fails.
+
+## Related APIs
+
+- [TriangleMesh](TriangleMesh.md)
+- [TriangleMeshValidationOptions](TriangleMeshValidationOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry.md

@@ -0,0 +1,30 @@
+# Geometry foundations
+
+Pure curves, profiles, regions, meshes, transforms, and mechanical construction without initializing a native engine.
+
+Import runtime-neutral geometry from `@metamesh/modeling/geometry`. Curves, profiles, transforms, regions, meshes, SVG parsing, and mechanical kernels work without an SDK or native engine.
+
+```ts
+import { sampleCurve2, rectangleContour } from "@metamesh/modeling/geometry";
+const arc = sampleCurve2({ kind: "arc", center: [0, 0], radius: 10, sweepDegrees: 90 });
+const contour = rectangleContour({ size: [30, 20], treatment: { kind: "round", radius: 3 } });
+```
+
+Lengths use millimetres. Winding and closing conventions are explicit. Mutable external meshes are inspected freshly, and predictable allocations are bounded before sampling.
+
+Use shared Bounds2/Bounds3 and bounds helpers for measurements, positioned containment, fitting, and part layout. Fit text vector paths before sampling to retain physical tolerance.
+
+## Categories
+
+- [Mechanical foundations](geometry/categories/mechanical.md) — Resolve gears, fastener standards, thread profiles, fit, and predictable allocations.
+- [Triangle meshes and surfaces](geometry/categories/meshes.md) — Build, transform, validate, analyze, and locally optimize copied indexed meshes.
+- [SVG and vector layouts](geometry/categories/vector-import.md) — Parse bounded painted SVG and carry explicit prepared text geometry.
+- [Profiles and regions](geometry/categories/profiles-regions.md) — Define winding, holes, stable profile landmarks, and reusable planar boundaries.
+- [Curves and paths](geometry/categories/curves-paths.md) — Sample reusable lines, arcs, cubic curves, and path frames with explicit physical policies.
+- [Bounds & Layout](geometry/categories/bounds-layout.md) — Measure finite bounds, test positioned containment, and fit or arrange geometry.
+- [Pattern Placement](geometry/categories/pattern-placement.md) — Calculate pure linear, radial, grid, and path transforms.
+- [Transforms and vector math](geometry/categories/transforms-math.md) — Compose explicit coordinate transforms and reusable placement anchors.
+- [Resolution and errors](geometry/categories/resolution-errors.md) — Resolve physical sampling, numerical tolerances, and contextual failures.
+- [Primitive options](geometry/categories/primitive-options.md) — Share one option contract for dimensional primitives and edge treatments.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,54 @@
+# Anchor3
+
+An attachment pose on a solid or assembly.
+
+`direction` is the outward attachment normal. `up` controls roll and must not
+be parallel to `direction`; anchor construction projects and normalizes it.
+
+## Properties
+
+### direction
+
+
+
+`readonly` **direction**: [`Vector3`](Vector3.md)
+
+
+
+Unit outward normal used as the anchor's local +Z direction.
+
+***
+
+### position
+
+
+
+`readonly` **position**: [`Vector3`](Vector3.md)
+
+
+
+World-space attachment position.
+
+***
+
+### up
+
+
+
+`readonly` **up**: [`Vector3`](Vector3.md)
+
+
+
+Roll guide projected into the plane perpendicular to `direction`.
+
+
+## Related APIs
+
+- [Vector3](Vector3.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.13.0`.

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

@@ -0,0 +1,63 @@
+# AttachOptions
+
+Degree-based anchor attachment controls for a scoped solid.
+
+## Properties
+
+### alignment?
+
+
+
+`readonly` `optional` **alignment?**: `"opposed"` \| `"same"`
+
+
+
+Align outward directions face-to-face (`opposed`) or in parallel (`same`).
+
+***
+
+### gap?
+
+
+
+`readonly` `optional` **gap?**: `number`
+
+
+
+Separation along the target anchor's outward direction in millimetres.
+
+***
+
+### spinDegrees?
+
+
+
+`readonly` `optional` **spinDegrees?**: `number`
+
+
+
+Additional right-handed roll about the attached direction, in degrees.
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Optional numeric comparison overrides.
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.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.13.0`.

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

@@ -0,0 +1,39 @@
+# Bounds2
+
+Axis-aligned bounds in two-dimensional model space.
+
+## Properties
+
+### max
+
+
+
+`readonly` **max**: [`Vector2`](Vector2.md)
+
+
+
+Inclusive maximum X/Y coordinates.
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector2`](Vector2.md)
+
+
+
+Inclusive minimum X/Y coordinates.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+## Guides
+
+- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,39 @@
+# Bounds3
+
+Axis-aligned bounds in three-dimensional model space.
+
+## Properties
+
+### max
+
+
+
+`readonly` **max**: [`Vector3`](Vector3.md)
+
+
+
+Inclusive maximum X/Y/Z coordinates.
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector3`](Vector3.md)
+
+
+
+Inclusive minimum X/Y/Z coordinates.
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+## Guides
+
+- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,15 @@
+# BoxEdge
+
+Box edges use +Z top, +Y front and +X right; vertical names list front/back first.
+
+**BoxEdge** = `"top-front"` \| `"top-back"` \| `"top-left"` \| `"top-right"` \| `"bottom-front"` \| `"bottom-back"` \| `"bottom-left"` \| `"bottom-right"` \| `"front-left"` \| `"front-right"` \| `"back-left"` \| `"back-right"`
+
+
+
+
+## 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.13.0`.

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

@@ -0,0 +1,19 @@
+# BoxEdgeSelection
+
+Named individual edges or top/bottom rims and all four vertical edges.
+
+**BoxEdgeSelection** = [`BoxEdge`](BoxEdge.md) \| `"top"` \| `"bottom"` \| `"vertical"`
+
+
+
+
+## Related APIs
+
+- [BoxEdge](BoxEdge.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.13.0`.

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

@@ -0,0 +1,20 @@
+# BoxEdgeTreatments
+
+Independent treatments for disjoint named edge selections; overlapping selections fail.
+
+**BoxEdgeTreatments** = `Readonly`\<`Partial`\<`Record`\<[`BoxEdgeSelection`](BoxEdgeSelection.md), [`EdgeTreatment`](EdgeTreatment.md)\>\>\>
+
+
+
+
+## Related APIs
+
+- [BoxEdgeSelection](BoxEdgeSelection.md)
+- [EdgeTreatment](EdgeTreatment.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.13.0`.

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

@@ -0,0 +1,92 @@
+# BoxOptions
+
+Dimensions, placement, and uniform or independently selected finishing for an axis-aligned box.
+
+## Extends
+
+- [`PrimitivePlacement`](PrimitivePlacement.md)
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings for edge treatments, bounded by the host policy.
+
+***
+
+### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
+
+Centers the box on the XYZ origin when `true`; otherwise its minimum corner is at the origin.
+
+#### Default Value
+
+`true`
+
+***
+
+### size
+
+
+
+`readonly` **size**: `number` \| [`Vector3`](Vector3.md)
+
+
+
+Positive uniform size or explicit `[X, Y, Z]` extents in millimetres.
+
+***
+
+### treatment?
+
+
+
+`readonly` `optional` **treatment?**: [`EdgeTreatment`](EdgeTreatment.md) \| `Readonly`\<`Partial`\<`Record`\<[`BoxEdgeSelection`](BoxEdgeSelection.md), [`EdgeTreatment`](EdgeTreatment.md)\>\>\>
+
+
+
+Uniform treatment or independent disjoint nominal edge/group treatments.
+
+***
+
+### placement?
+
+
+
+`readonly` `optional` **placement?**: [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md)
+
+
+
+Applied after local construction; Section placement must preserve the XY plane.
+
+#### Inherited from
+
+[`PrimitivePlacement`](PrimitivePlacement.md).[`placement`](PrimitivePlacement.md#placement)
+
+
+## Related APIs
+
+- [BoxEdgeSelection](BoxEdgeSelection.md)
+- [EdgeTreatment](EdgeTreatment.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [PrimitivePlacement](PrimitivePlacement.md)
+- [PrimitivePlacementOptions](PrimitivePlacementOptions.md)
+- [Vector3](Vector3.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.13.0`.

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

@@ -0,0 +1,35 @@
+# ChamferedEdgeTreatment
+
+A planar edge or corner chamfer with equal or independent surface setbacks.
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"chamfer"`
+
+
+
+Selects a straight bevel between adjoining surfaces.
+
+***
+
+### distance
+
+
+
+`readonly` **distance**: `number` \| readonly \[`number`, `number`\]
+
+
+
+Millimetre setbacks, equal or [first surface, second surface]. Zero or [0, 0] leaves the edge untreated; otherwise both must be positive and fit without overlap.
+
+
+## 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.13.0`.

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

@@ -0,0 +1,21 @@
+# CircleContourOptions
+
+Circular profile dimensions with exactly one radius or diameter and explicit sampling.
+
+**CircleContourOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`RadialSizingOptions`](RadialSizingOptions.md) & (\{ `radius`: `number`; `diameter?`: `never`; \} \| \{ `diameter`: `number`; `radius?`: `never`; \})
+
+
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [RadialSizingOptions](RadialSizingOptions.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.13.0`.

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

@@ -0,0 +1,21 @@
+# CircleOptions
+
+Circular dimensions with exactly one nominal radius or diameter.
+
+**CircleOptions** = [`CircleContourOptions`](CircleContourOptions.md) & [`PrimitivePlacement`](PrimitivePlacement.md)
+
+
+
+
+## Related APIs
+
+- [CircleContourOptions](CircleContourOptions.md)
+- [PrimitivePlacement](PrimitivePlacement.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.13.0`.

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

@@ -0,0 +1,64 @@
+# CircularPrimitiveOptions
+
+Tessellation controls shared by circular primitives across Geometry entry points.
+
+## Extended by
+
+- [`RevolveOptions`](RevolveOptions.md)
+- [`RoundedEdgeTreatment`](RoundedEdgeTreatment.md)
+- [`TubeOptions`](TubeOptions.md)
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings; bound modeling operations may only lower the host policy.
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact circumferential segment count from three through the configured safety limit.
+
+This local topology override takes precedence over [CircularPrimitiveOptions.resolution](#resolution)
+and any active model-wide resolution policy.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical tessellation policy over the active model-wide policy.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [RevolveOptions](RevolveOptions.md)
+- [RoundedEdgeTreatment](RoundedEdgeTreatment.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.13.0`.

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

@@ -0,0 +1,35 @@
+# Computed
+
+Reads immutable data or a deferred recipe; evaluation is synchronous and cached.
+
+A lazy session-owned reader. Calling it tracks its output in the current computation.
+
+## Type Parameters
+
+### T
+
+`T`
+
+
+
+**Computed**(): `T`
+
+
+
+## Returns
+
+`T`
+
+## Properties
+
+### \[computedBrand\]
+
+
+
+`readonly` **\[computedBrand\]**: `"Computed"`
+
+
+
+Compile-time ownership brand; readers are created by the engine's context helper.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,20 @@
+# ComputedValue
+
+A value supplied immediately or by a lazy computed reader.
+
+**ComputedValue**\<`T`\> = `T` \| [`Computed`](Computed.md)\<`T`\>
+
+
+
+## Type Parameters
+
+### T
+
+`T`
+
+
+## Related APIs
+
+- [Computed](Computed.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,22 @@
+# Contour
+
+A closed two-dimensional boundary whose first point is not repeated at the end.
+
+**Contour** = readonly [`Vector2`](Vector2.md)[]
+
+
+
+Polygon exteriors are counter-clockwise and holes are clockwise. Algorithms
+may reject duplicate adjacent points or fewer than three effective vertices.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+## Guides
+
+- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.