@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,38 @@
+# add3
+
+Adds two finite XYZ vectors component-wise.
+
+`const` **add3**: (`a`: [`Vector3`](Vector3.md), `b`: [`Vector3`](Vector3.md)) => [`Vector3`](Vector3.md)
+
+
+
+## Example
+
+```ts
+add3([1, 2, 3], [4, 5, 6]); // [5, 7, 9]
+```
+
+## Parameters
+
+<a id="a"></a>
+
+**`a`** · [`Vector3`](Vector3.md) · Required
+
+
+
+<a id="b"></a>
+
+**`b`** · [`Vector3`](Vector3.md) · Required
+
+
+
+## Returns
+
+[`Vector3`](Vector3.md)
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,57 @@
+# analyzeTriangleMesh
+
+Validates and measures a mesh in one position and one triangle traversal.
+
+**analyzeTriangleMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`TriangleMeshAnalysisOptions`](TriangleMeshAnalysisOptions.md)): [`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
+
+
+
+Bounds, area in square model units and signed volume in cubic model units are computed without
+copying or changing the input buffers. Volume is meaningful for consistently wound closed
+geometry; `requireClosed` checks oriented edge closure. Optional indexed topology counts require
+every position vertex to be referenced and do not establish freedom from self-intersections.
+Results and nested bounds are immutable snapshots. Caller-owned mutable meshes are freshly
+inspected on every call, never cached.
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`TriangleMeshAnalysisOptions`](TriangleMeshAnalysisOptions.md) · Optional
+
+- [`includeTopology`](TriangleMeshAnalysisOptions.md#includetopology) · `boolean` · Optional
+
+  Compute indexed edge/component counts and reject unreferenced vertices; defaults to false.
+
+- [`allowEmpty`](TriangleMeshAnalysisOptions.md#allowempty) · `boolean` · Optional
+
+  Permit an empty position and index buffer. Defaults to `false`.
+
+- [`requireClosed`](TriangleMeshAnalysisOptions.md#requireclosed) · `boolean` · Optional
+
+  Require two oppositely wound faces per edge; geometric self-intersections are not detected.
+
+- [`tolerance`](TriangleMeshAnalysisOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Numeric comparison overrides used for zero-area triangle detection.
+
+
+
+## Returns
+
+[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
+
+
+## Related APIs
+
+- [TriangleMesh](TriangleMesh.md)
+- [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
+- [TriangleMeshAnalysisOptions](TriangleMeshAnalysisOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,52 @@
+# analyzeTriangleMeshQuality
+
+Measures triangle shape, edge topology, vertex concentration, and connected planar patches.
+
+**analyzeTriangleMeshQuality**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md)): [`TriangleMeshQualityReport`](TriangleMeshQualityReport.md)
+
+
+
+Positions are never welded: valence and manifold status describe the supplied indexed topology.
+Degenerate triangles are reported rather than rejected, while malformed buffers, non-finite
+positions, missing vertex references, and the configured complexity limit throw.
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+Indexed triangle mesh in arbitrary consistent model units.
+
+
+
+<a id="options"></a>
+
+**`options`** · [`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md) · Optional
+
+Scale-aware tolerance and analysis budget.
+
+- [`maximumTriangleCount`](TriangleMeshQualityOptions.md#maximumtrianglecount) · `number` · Optional
+
+  Maximum number of triangles inspected. Defaults to `200000`.
+
+- [`tolerance`](TriangleMeshQualityOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Numeric comparison overrides; model coordinates are interpreted in their existing units.
+
+
+
+## Returns
+
+[`TriangleMeshQualityReport`](TriangleMeshQualityReport.md)
+
+A deterministic report without mutating or copying the mesh.
+
+
+## Related APIs
+
+- [TriangleMesh](TriangleMesh.md)
+- [TriangleMeshQualityOptions](TriangleMeshQualityOptions.md)
+- [TriangleMeshQualityReport](TriangleMeshQualityReport.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,40 @@
+# anchorFrame3
+
+Converts an anchor into a right-handed frame with direction as local +Z.
+
+**anchorFrame3**(`anchor`: [`Anchor3`](Anchor3.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Frame3`](Frame3.md)
+
+
+
+## Parameters
+
+<a id="anchor"></a>
+
+**`anchor`** · [`Anchor3`](Anchor3.md) · Required
+
+Anchor created by [createAnchor3](createAnchor3.md) or equivalent valid data.
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+Optional comparison overrides.
+
+
+
+## Returns
+
+[`Frame3`](Frame3.md)
+
+A normalized right-handed frame at the anchor position.
+
+
+## Related APIs
+
+- [Anchor3](Anchor3.md)
+- [Frame3](Frame3.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,41 @@
+# applyTransformDirection3
+
+Applies only the linear component of an affine transform to a direction.
+
+**applyTransformDirection3**(`transform`: [`Transform3`](Transform3.md), `direction`: [`Vector3`](Vector3.md)): [`Vector3`](Vector3.md)
+
+
+
+The result is not normalized, preserving scale information.
+
+## Parameters
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+Valid row-major affine transform.
+
+
+
+<a id="direction"></a>
+
+**`direction`** · [`Vector3`](Vector3.md) · Required
+
+Finite XYZ direction.
+
+
+
+## Returns
+
+[`Vector3`](Vector3.md)
+
+A fresh transformed direction.
+
+
+## Related APIs
+
+- [Transform3](Transform3.md)
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,39 @@
+# applyTransformPoint3
+
+Applies an affine transform to a point, including translation.
+
+**applyTransformPoint3**(`transform`: [`Transform3`](Transform3.md), `point`: [`Vector3`](Vector3.md)): [`Vector3`](Vector3.md)
+
+
+
+## Parameters
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+Valid row-major affine transform.
+
+
+
+<a id="point"></a>
+
+**`point`** · [`Vector3`](Vector3.md) · Required
+
+Finite XYZ point.
+
+
+
+## Returns
+
+[`Vector3`](Vector3.md)
+
+A fresh transformed point.
+
+
+## Related APIs
+
+- [Transform3](Transform3.md)
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,73 @@
+# attachTransform
+
+Builds the transform that moves a source anchor onto a target anchor.
+
+**attachTransform**(`source`: [`Anchor3`](Anchor3.md), `target`: [`Anchor3`](Anchor3.md), `options?`: [`AttachTransformOptions`](AttachTransformOptions.md)): [`Transform3`](Transform3.md)
+
+
+
+The default `opposed` alignment points the source outward normal against the
+target outward normal, producing face-to-face mating. A positive gap moves the
+attachment point along the target's outward direction. Spin is applied after
+alignment around the final source direction.
+
+## Parameters
+
+<a id="source"></a>
+
+**`source`** · [`Anchor3`](Anchor3.md) · Required
+
+Anchor expressed in the moving object's local coordinates.
+
+
+
+<a id="target"></a>
+
+**`target`** · [`Anchor3`](Anchor3.md) · Required
+
+Desired anchor pose in destination coordinates.
+
+
+
+<a id="options"></a>
+
+**`options`** · [`AttachTransformOptions`](AttachTransformOptions.md) · Optional
+
+Alignment, gap, spin, and tolerance policy.
+
+- [`alignment`](AttachTransformOptions.md#alignment) · `"opposed"` \| `"same"` · Optional
+
+  Align outward directions face-to-face (`opposed`) or in parallel (`same`).
+
+- [`gap`](AttachTransformOptions.md#gap) · `number` · Optional
+
+  Separation along the target anchor's outward direction in model units.
+
+- [`spinRadians`](AttachTransformOptions.md#spinradians) · `number` · Optional
+
+  Additional right-handed roll about the attached direction, in radians.
+
+- [`tolerance`](AttachTransformOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numeric comparison overrides.
+
+
+
+## Returns
+
+[`Transform3`](Transform3.md)
+
+A frozen affine transform for the moving object.
+
+
+## Throws
+
+- GeometryError For invalid anchors or non-finite options.
+
+## Related APIs
+
+- [Anchor3](Anchor3.md)
+- [AttachTransformOptions](AttachTransformOptions.md)
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,62 @@
+# boundsCenter
+
+Midpoint of finite XY bounds in millimetres.
+
+## Call Signature
+
+
+
+**boundsCenter**(`bounds`: [`Bounds2`](Bounds2.md)): [`Vector2`](Vector2.md)
+
+
+
+Midpoint of finite XY bounds in millimetres.
+
+### Parameters
+
+<a id="bounds"></a>
+
+**`bounds`** · [`Bounds2`](Bounds2.md) · Required
+
+
+
+### Returns
+
+[`Vector2`](Vector2.md)
+
+## Call Signature
+
+
+
+**boundsCenter**(`bounds`: [`Bounds3`](Bounds3.md)): [`Vector3`](Vector3.md)
+
+
+
+Midpoint of finite XYZ bounds in millimetres.
+
+### Parameters
+
+<a id="bounds-1"></a>
+
+**`bounds`** · [`Bounds3`](Bounds3.md) · Required
+
+
+
+### Returns
+
+[`Vector3`](Vector3.md)
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [Bounds3](Bounds3.md)
+- [Vector2](Vector2.md)
+- [Vector3](Vector3.md)
+
+## Guides
+
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,83 @@
+# boundsFromSize
+
+Creates immutable centered XY bounds from nonnegative dimensions in millimetres.
+
+## Call Signature
+
+
+
+**boundsFromSize**(`size`: [`Vector2`](Vector2.md), `options?`: [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md)): [`Bounds2`](Bounds2.md)
+
+
+
+Creates immutable centered XY bounds from nonnegative dimensions in millimetres.
+
+### Parameters
+
+<a id="size"></a>
+
+**`size`** · [`Vector2`](Vector2.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md) · Optional
+
+- [`center`](BoundsFromSizeOptions.md#center) · `boolean` · Optional
+
+  Center on the origin; false starts at the origin. Defaults to true.
+
+
+
+### Returns
+
+[`Bounds2`](Bounds2.md)
+
+## Call Signature
+
+
+
+**boundsFromSize**(`size`: [`Vector3`](Vector3.md), `options?`: [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md)): [`Bounds3`](Bounds3.md)
+
+
+
+Creates immutable centered XYZ bounds from nonnegative dimensions in millimetres.
+
+### Parameters
+
+<a id="size-1"></a>
+
+**`size`** · [`Vector3`](Vector3.md) · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`BoundsFromSizeOptions`](BoundsFromSizeOptions.md) · Optional
+
+- [`center`](BoundsFromSizeOptions.md#center) · `boolean` · Optional
+
+  Center on the origin; false starts at the origin. Defaults to true.
+
+
+
+### Returns
+
+[`Bounds3`](Bounds3.md)
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [Bounds3](Bounds3.md)
+- [BoundsFromSizeOptions](BoundsFromSizeOptions.md)
+- [Vector2](Vector2.md)
+- [Vector3](Vector3.md)
+
+## Guides
+
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,62 @@
+# boundsSize
+
+Inclusive XY dimensions in millimetres; zero extents are retained.
+
+## Call Signature
+
+
+
+**boundsSize**(`bounds`: [`Bounds2`](Bounds2.md)): [`Vector2`](Vector2.md)
+
+
+
+Inclusive XY dimensions in millimetres; zero extents are retained.
+
+### Parameters
+
+<a id="bounds"></a>
+
+**`bounds`** · [`Bounds2`](Bounds2.md) · Required
+
+
+
+### Returns
+
+[`Vector2`](Vector2.md)
+
+## Call Signature
+
+
+
+**boundsSize**(`bounds`: [`Bounds3`](Bounds3.md)): [`Vector3`](Vector3.md)
+
+
+
+Inclusive XYZ dimensions in millimetres; zero extents are retained.
+
+### Parameters
+
+<a id="bounds-1"></a>
+
+**`bounds`** · [`Bounds3`](Bounds3.md) · Required
+
+
+
+### Returns
+
+[`Vector3`](Vector3.md)
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [Bounds3](Bounds3.md)
+- [Vector2](Vector2.md)
+- [Vector3](Vector3.md)
+
+## Guides
+
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,48 @@
+# boxAnchor3
+
+Creates an outward face-center anchor using the same local origin convention as box().
+
+**boxAnchor3**(`options`: [`BoxAnchorOptions`](BoxAnchorOptions.md)): [`Anchor3`](Anchor3.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`BoxAnchorOptions`](BoxAnchorOptions.md) · Required
+
+- [`size`](BoxAnchorOptions.md#size) · `number` \| [`Vector3`](Vector3.md) · Required
+
+  XYZ dimensions, or one uniform dimension, in millimetres.
+
+- [`face`](BoxAnchorOptions.md#face) · [`BoxAnchorFace`](BoxAnchorFace.md) · Required
+
+  Named outward face whose center is the attachment point.
+
+- [`center`](BoxAnchorOptions.md#center) · `boolean` · Optional
+
+  Centers the box around its construction origin; defaults to true, matching box().
+
+- [`origin`](BoxAnchorOptions.md#origin) · [`Vector3`](Vector3.md) · Optional
+
+  Construction origin; centered-box center or noncentered minimum corner. Defaults to zero.
+
+
+
+## Returns
+
+[`Anchor3`](Anchor3.md)
+
+## Remarks
+
+origin applies an explicit translation. For rotated components, transform the
+resulting anchor frame explicitly; no anchor is inherited from a Boolean result.
+
+
+## Related APIs
+
+- [Anchor3](Anchor3.md)
+- [BoxAnchorOptions](BoxAnchorOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,68 @@
+# buildHelicalThreadRidgeMesh
+
+Builds closed thread-ridge components with every profile locked to the shaft's radial/axial frame. The mesh is intended for union with its minor-envelope cylinder and never owns WASM objects.
+
+**buildHelicalThreadRidgeMesh**(`options`: [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md) · Required
+
+- [`length`](HelicalThreadRidgeMeshOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`majorDiameter`](HelicalThreadRidgeMeshOptions.md#majordiameter) · `number` · Required
+
+  Nominal major diameter before any caller-owned fit compensation.
+
+- [`profile`](HelicalThreadRidgeMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`ends`](HelicalThreadRidgeMeshOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](HelicalThreadRidgeMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](HelicalThreadRidgeMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](HelicalThreadRidgeMeshOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](HelicalThreadRidgeMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](HelicalThreadRidgeMeshOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](HelicalThreadRidgeMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+
+## Related APIs
+
+- [HelicalThreadRidgeMeshOptions](HelicalThreadRidgeMeshOptions.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.13.0`.