@metamesh/modeling 0.17.0 → 0.19.0

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

@@ -1,56 +0,0 @@
-# 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.
-
-- [`maxTriangles`](TriangleMeshQualityOptions.md#maxtriangles) · `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)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,39 +0,0 @@
-# computeTriangleMeshCentroid
-
-Computes the uniform-density volume centroid of an oriented closed solid, including cavity shells.
-
-**computeTriangleMeshCentroid**(`mesh`: [`TriangleMesh`](TriangleMesh.md)): [`Vector3Data`](Vector3Data.md)
-
-
-
-Coordinates are millimetres. Indexed closure and positive aggregate volume are required; callers
-may use validateSolidMesh first when geometric intersections and shell orientation are untrusted.
-Fresh mutable input is inspected on every call, and buffers are never changed.
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-Consistently oriented closed mesh with positive enclosed volume.
-
-
-
-## Returns
-
-[`Vector3Data`](Vector3Data.md)
-
-A fresh immutable XYZ volume centroid.
-
-
-## Related APIs
-
-- [TriangleMesh](TriangleMesh.md)
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,64 +0,0 @@
-# computeTriangleMeshSignature
-
-Creates an order-independent regression signature for a manufacturing mesh.
-
-**computeTriangleMeshSignature**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`TriangleMeshSignatureOptions`](TriangleMeshSignatureOptions.md)): [`TriangleMeshSignature`](TriangleMeshSignature.md)
-
-
-
-The input must be non-empty, closed, consistently wound, and have no unreferenced vertices.
-Vertex and triangle order do not affect the fingerprint; winding, quantized geometry, and
-connectivity metrics do. The fingerprint is a regression aid, not a cryptographic digest.
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-Closed oriented mesh to measure without mutation.
-
-
-
-<a id="options"></a>
-
-**`options`** · [`TriangleMeshSignatureOptions`](TriangleMeshSignatureOptions.md) · Optional
-
-Absolute quantization and complexity limits.
-
-- [`maxTriangles`](TriangleMeshSignatureOptions.md#maxtriangles) · `number` · Optional
-
-  Maximum accepted triangle count. Defaults to 200,000.
-
-- [`positionTolerance`](TriangleMeshSignatureOptions.md#positiontolerance) · `number` · Optional
-
-  Position and bounds quantization in model units. Defaults to `1e-5`.
-
-- [`volumeTolerance`](TriangleMeshSignatureOptions.md#volumetolerance) · `number` · Optional
-
-  Signed-volume quantization in cubic model units. Defaults to `1e-4`.
-
-
-
-## Returns
-
-[`TriangleMeshSignature`](TriangleMeshSignature.md)
-
-Compact counts, bounds, volume, topology, tolerances, and canonical fingerprint.
-
-
-## Throws
-
-- GeometryError When validation, topology, tolerance, or complexity checks fail.
-
-## Related APIs
-
-- [TriangleMesh](TriangleMesh.md)
-- [TriangleMeshSignature](TriangleMeshSignature.md)
-- [TriangleMeshSignatureOptions](TriangleMeshSignatureOptions.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,77 +0,0 @@
-# extrudeMesh
-
-Linearly extrudes one simple profile along +Z with robust ear-clipped caps. Path2 profiles must be closed; raw point collections have an implicit closing edge.
-
-**extrudeMesh**(`input`: [`Path2Input`](Path2Input.md), `options`: [`ExtrudeOptions`](ExtrudeOptions.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-## Example: Extrude point data without an engine
-
-```ts
-const outline = rectangleContour({ size: [30, 20], treatment: { kind: "round", radius: 3 } });
-extrudeMesh(outline, { height: 8 });
-```
-
-## Parameters
-
-<a id="input"></a>
-
-**`input`** · [`Path2Input`](Path2Input.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`ExtrudeOptions`](ExtrudeOptions.md) · Required
-
-- [`height`](ExtrudeOptions.md#height) · `number` · Required
-
-  Positive extrusion height in millimetres.
-
-- [`center`](ExtrudeOptions.md#center) · `boolean` · Optional
-
-  Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
-
-- [`ends`](ExtrudeOptions.md#ends) · [`EndTreatments`](EndTreatments.md) · Optional
-
-  Independent inward end treatments on straight convex single-contour extrusions.
-
-- [`divisions`](ExtrudeOptions.md#divisions) · `number` · Optional
-
-  Exact number of intermediate profiles, nonnegative; overrides physical sampling.
-
-- [`limits`](ExtrudeOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
-
-  Explicit output and sampling allocation ceilings.
-
-- [`resolution`](ExtrudeOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
-
-  Operation-level physical policy over the nearest model scope.
-
-- [`scaleTop`](ExtrudeOptions.md#scaletop) · `number` \| [`Vector2Input`](Vector2Input.md) · Optional
-
-  Finite uniform or XY scale of the top profile; defaults to one.
-
-- [`twist`](ExtrudeOptions.md#twist) · `number` · Optional
-
-  Finite rotation of the top profile about +Z, in degrees; defaults to zero.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-
-## Related APIs
-
-- [ExtrudeOptions](ExtrudeOptions.md)
-- [Path2Input](Path2Input.md)
-- [TriangleMesh](TriangleMesh.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,52 +0,0 @@
-# heightfieldMesh
-
-Builds a closed indexed mesh from a rectilinear top, matched boundary walls, and flat base.
-
-**heightfieldMesh**(`options`: [`HeightfieldOptions`](HeightfieldOptions.md), `limits?`: `Partial`\<`Pick`\<[`ModelingLimits`](ModelingLimits.md), `"maxVertices"` \| `"maxTriangles"` \| `"maxBytes"`\>\>): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-## Example: Sample a closed wavy mesh
-
-```ts
-heightfieldMesh({
-  size: [30, 20], segments: [24, 16],
-  height: ([x, y]) => 3 + Math.cos(x / 5) * Math.cos(y / 5),
-});
-```
-
-Heights run once per grid point after preflight; center-error adds one evaluation per cell.
-Top winding is +Z, the base is -Z, and sides face outward. Coordinates and heights must fit
-Float32 storage. Explicit axes are captured before sampling; shared wall vertices prevent cracks.
-
-## Parameters
-
-<a id="options"></a>
-
-**`options`** · [`HeightfieldOptions`](HeightfieldOptions.md) · Required
-
-
-
-<a id="limits"></a>
-
-**`limits`** · `Partial`\<`Pick`\<[`ModelingLimits`](ModelingLimits.md), `"maxVertices"` \| `"maxTriangles"` \| `"maxBytes"`\>\> · Optional
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-
-## Related APIs
-
-- [HeightfieldOptions](HeightfieldOptions.md)
-- [ModelingLimits](ModelingLimits.md)
-- [TriangleMesh](TriangleMesh.md)
-- [preflightHeightfield](preflightHeightfield.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,72 +0,0 @@
-# helicalThreadRidgeMesh
-
-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.
-
-**helicalThreadRidgeMesh**(`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-type.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.
-
-- [`phase`](HelicalThreadRidgeMeshOptions.md#phase) · `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)
-
-## Guides
-
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,106 +0,0 @@
-# helicalThreadSolidMesh
-
-Builds one closed threaded cylinder without a ridge/core Boolean seam.
-
-**helicalThreadSolidMesh**(`options`: [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-Each circular facet includes its exact phase-shifted profile breakpoints, including duplicate-Z
-samples for vertical flanks and blunt transitions. Adjacent variable grids are stitched as a
-monotone strip, with optional intermediate rows bounded by physical `maxSegmentLength`. A
-conservative pre-allocation estimate rejects excessive meshes before constructing position
-arrays.
-
-## Parameters
-
-<a id="options"></a>
-
-**`options`** · [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md) · Required
-
-- [`length`](HelicalThreadSolidMeshOptions.md#length) · `number` · Required
-
-  Total threaded axial length in millimetres.
-
-- [`majorDiameter`](HelicalThreadSolidMeshOptions.md#majordiameter) · `number` · Required
-
-  Nominal major diameter before any caller-owned fit compensation.
-
-- [`profile`](HelicalThreadSolidMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile-type.md) · Required
-
-  Validated periodic profile repeated around the shaft.
-
-- [`ends`](HelicalThreadSolidMeshOptions.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`](HelicalThreadSolidMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
-
-  Helix direction. Default: `right`.
-
-- [`limits`](HelicalThreadSolidMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
-
-  Explicit output and circular allocation ceilings.
-
-- [`phase`](HelicalThreadSolidMeshOptions.md#phase) · `number` · Optional
-
-  Angular offset of the first start in degrees. Default: `0`.
-
-- [`resolution`](HelicalThreadSolidMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
-
-  Optional circular-resolution policy.
-
-- [`starts`](HelicalThreadSolidMeshOptions.md#starts) · `number` · Optional
-
-  Number of evenly phased starts. Default: `1`.
-
-- [`tolerance`](HelicalThreadSolidMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-  Optional numerical tolerance overrides.
-
-- [`bevelBottom`](HelicalThreadSolidMeshOptions.md#bevelbottom) · `boolean` · Optional
-
-  Apply a 45-degree radial bevel at the lower target face.
-
-- [`bevelBottomSize`](HelicalThreadSolidMeshOptions.md#bevelbottomsize) · `number` · Optional
-
-  Lower bevel size override. Takes precedence over `bevelSize`.
-
-- [`bevelOffset`](HelicalThreadSolidMeshOptions.md#beveloffset) · `number` · Optional
-
-  Distance of each bevel target face inward from the corresponding mesh end.
-
-- [`bevelMode`](HelicalThreadSolidMeshOptions.md#bevelmode) · `"inset"` \| `"outset"` · Optional
-
-  `inset` trims an external rod; `outset` expands an internal cutter.
-
-- [`bevelSize`](HelicalThreadSolidMeshOptions.md#bevelsize) · `number` · Optional
-
-  Axial and radial bevel size. Defaults to the profile depth.
-
-- [`bevelTop`](HelicalThreadSolidMeshOptions.md#beveltop) · `boolean` · Optional
-
-  Apply a 45-degree radial bevel at the upper target face.
-
-- [`bevelTopSize`](HelicalThreadSolidMeshOptions.md#beveltopsize) · `number` · Optional
-
-  Upper bevel size override. Takes precedence over `bevelSize`.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-
-## Related APIs
-
-- [HelicalThreadSolidMeshOptions](HelicalThreadSolidMeshOptions.md)
-- [TriangleMesh](TriangleMesh.md)
-
-## Guides
-
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,40 +0,0 @@
-# joinTriangleMeshes
-
-Concatenates meshes into one indexed mesh without welding coincident vertices.
-
-**joinTriangleMeshes**(`meshes`: readonly [`TriangleMesh`](TriangleMesh.md)[]): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-Inputs are validated and never mutated. Face order and winding remain stable.
-
-## Parameters
-
-<a id="meshes"></a>
-
-**`meshes`** · readonly [`TriangleMesh`](TriangleMesh.md)[] · Required
-
-One or more meshes to concatenate.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-Fresh typed arrays with indices offset to their source vertex ranges.
-
-
-## Throws
-
-- GeometryError When no mesh is supplied or an input is invalid.
-
-## Related APIs
-
-- [TriangleMesh](TriangleMesh.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,77 +0,0 @@
-# loftMesh
-
-Lofts simple point loops at z heights or explicit right-handed frames, in input order.
-
-**loftMesh**(`stations`: readonly [`LoftMeshStation`](LoftMeshStation.md)[], `options`: [`LoftOptions`](LoftOptions.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-## Example: Loft with explicit point correspondence
-
-```ts
-const bottom = rectangleContour({ size: [20, 12] });
-const top = rectangleContour({ size: [30, 20], treatment: { kind: "round", radius: 3 } });
-loftMesh([{ profile: bottom, z: 0 }, { profile: top, z: 30 }], { correspondence: "reindex" });
-```
-
-An explicit correspondence method is required. CCW-normalized loops retain their
-seam and original vertices; unequal counts gain subdivisions or repeated fan slots.
-Both ends use ear-clipped caps, supporting concave profiles without center fans.
-Intermediate slices interpolate placed world vertices, never frame axes.
-Transformed coordinates must fit finite Float32 mesh storage.
-Path2 profiles must be closed; raw point collections are interpreted as closed.
-
-## Parameters
-
-<a id="stations"></a>
-
-**`stations`** · readonly [`LoftMeshStation`](LoftMeshStation.md)[] · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`LoftOptions`](LoftOptions.md) · Required
-
-- [`correspondence`](LoftOptions.md#correspondence) · [`LoftCorrespondence`](LoftCorrespondence.md) \| readonly [`LoftCorrespondence`](LoftCorrespondence.md)[] · Optional
-
-  One method or one per consecutive station gap. Omitted preserves known landmarks, including circle/ellipse-to-rectangle corners, or maps other unlike primitive seams directly.
-
-- [`distribution`](LoftOptions.md#distribution) · `"perimeter"` \| `"segments"` · Optional
-
-  Extra points follow edge length or distribute equally across existing segments. Defaults to perimeter for direct/reindex, or segments when any distance method is selected; distance methods require segments.
-
-- [`refine`](LoftOptions.md#refine) · `number` \| readonly `number`[] · Optional
-
-  Positive integer point-density multiplier, uniformly or per input profile. Original vertices are retained. Defaults to one.
-
-- [`slices`](LoftOptions.md#slices) · `number` \| readonly `number`[] · Optional
-
-  Nonnegative count of world-linearly interpolated profiles, uniformly or per gap. Defaults to zero.
-
-- [`resolution`](LoftOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
-
-  Physical curve policy for retained primitives, and maximum edge length for point data. Exact primitive curve counts take precedence.
-
-- [`limits`](LoftOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
-
-  Explicit output and sampling budgets; native operations may only lower host ceilings.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-
-## Related APIs
-
-- [LoftMeshStation](LoftMeshStation.md)
-- [LoftOptions](LoftOptions.md)
-- [TriangleMesh](TriangleMesh.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,39 +0,0 @@
-# meshBounds
-
-Computes axis-aligned bounds for a non-empty mesh.
-
-`const` **meshBounds**: (`mesh`: [`TriangleMesh`](TriangleMesh.md)) => [`Bounds3Data`](Bounds3Data.md)
-
-
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-Mesh whose finite complete vertices will be measured.
-
-
-
-## Returns
-
-[`Bounds3Data`](Bounds3Data.md)
-
-Fresh immutable minimum and maximum XYZ tuples.
-
-
-## Throws
-
-- GeometryError When the mesh is structurally invalid.
-
-## Related APIs
-
-- [Bounds3Data](Bounds3Data.md)
-- [TriangleMesh](TriangleMesh.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.