@metamesh/modeling 0.17.0 → 0.19.0

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

@@ -1,95 +0,0 @@
-# optimizePlanarPatches
-
-Improves pathological planar triangulation with bounded legal diagonal flips.
-
-**optimizePlanarPatches**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`PlanarMeshOptimizationOptions`](PlanarMeshOptimizationOptions.md)): [`PlanarMeshOptimizationResult`](PlanarMeshOptimizationResult.md)
-
-
-
-The operation changes indices only: it never moves, adds, welds, or removes vertices; never
-crosses a coplanar-patch boundary; and never changes the face count. Each accepted flip improves
-a deterministic ordering of triangle angles, aspect ratio, diagonal locality, and local
-incidence/valence concentration. Unsupported input or a failed final integrity check returns the
-exact original mesh object. Malformed buffers and the configured analysis complexity limit throw.
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-Closed, consistently wound indexed triangle mesh in arbitrary consistent units.
-
-
-
-<a id="options"></a>
-
-**`options`** · [`PlanarMeshOptimizationOptions`](PlanarMeshOptimizationOptions.md) · Optional
-
-Patch eligibility, numeric tolerance, and deterministic work bounds.
-
-- [`maxFlipAttempts`](PlanarMeshOptimizationOptions.md#maxflipattempts) · `number` · Optional
-
-  Maximum attempted edge evaluations. By default this is twenty times the initial candidate
-  edge count, capped at `1000000`.
-
-- [`maxEdgeRevisits`](PlanarMeshOptimizationOptions.md#maxedgerevisits) · `number` · Optional
-
-  Maximum times one edge may be reconsidered after neighbouring flips. Defaults to `12`.
-
-- [`maxPatchTriangles`](PlanarMeshOptimizationOptions.md#maxpatchtriangles) · `number` · Optional
-
-  Maximum triangles allowed in one selected patch. Defaults to `50000`.
-
-- [`maxProcessedTriangles`](PlanarMeshOptimizationOptions.md#maxprocessedtriangles) · `number` · Optional
-
-  Maximum cumulative triangles across selected patches. Defaults to `200000`.
-
-- [`minPatchTriangles`](PlanarMeshOptimizationOptions.md#minpatchtriangles) · `number` · Optional
-
-  Minimum triangles required before a planar patch is eligible. Defaults to `8`.
-
-- [`triggerMaxAspectRatio`](PlanarMeshOptimizationOptions.md#triggermaxaspectratio) · `number` · Optional
-
-  Select patches whose worst normalized aspect ratio exceeds this value. Defaults to `12`.
-
-- [`triggerMaxFanRatio`](PlanarMeshOptimizationOptions.md#triggermaxfanratio) · `number` · Optional
-
-  Select patches whose largest per-vertex triangle share exceeds this ratio. Defaults to `0.2`.
-
-- [`triggerMaxVertexTriangleIncidence`](PlanarMeshOptimizationOptions.md#triggermaxvertextriangleincidence) · `number` · Optional
-
-  Select patches whose largest vertex triangle incidence exceeds this value. Defaults to `16`.
-
-- [`triggerMinAngleDegrees`](PlanarMeshOptimizationOptions.md#triggerminangledegrees) · `number` · Optional
-
-  Select patches whose smallest interior angle is below this many degrees. Defaults to `8`.
-
-- [`maxTriangles`](PlanarMeshOptimizationOptions.md#maxtriangles) · `number` · Optional
-
-  Maximum number of triangles inspected. Defaults to `200000`.
-
-- [`tolerance`](PlanarMeshOptimizationOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-  Numeric comparison overrides; model coordinates are interpreted in their existing units.
-
-
-
-## Returns
-
-[`PlanarMeshOptimizationResult`](PlanarMeshOptimizationResult.md)
-
-Optimized connectivity and before/after diagnostics, or an unchanged safe fallback.
-
-
-## Related APIs
-
-- [PlanarMeshOptimizationOptions](PlanarMeshOptimizationOptions.md)
-- [PlanarMeshOptimizationResult](PlanarMeshOptimizationResult.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/preflightHeightfield.md

@@ -1,43 +0,0 @@
-# preflightHeightfield
-
-Checks grid options, Float32 axis precision, and output limits; returns exact mesh buffer counts.
-
-**preflightHeightfield**(`options`: [`HeightfieldOptions`](HeightfieldOptions.md), `limits?`: `Partial`\<`Pick`\<[`ModelingLimits`](ModelingLimits.md), `"maxVertices"` \| `"maxTriangles"` \| `"maxBytes"`\>\>): [`HeightfieldPreflight`](HeightfieldPreflight.md)
-
-
-
-This pure operation needs no engine and neither evaluates `height` nor allocates mesh buffers.
-Successful preflight leaves height values, Float32 base storage, and generated mesh validity to
-construction. `byteCount` covers position and index buffers, not total working memory.
-
-## 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
-
-[`HeightfieldPreflight`](HeightfieldPreflight.md)
-
-
-## Related APIs
-
-- [HeightfieldOptions](HeightfieldOptions.md)
-- [HeightfieldPreflight](HeightfieldPreflight.md)
-- [ModelingLimits](ModelingLimits.md)
-- [heightfieldMesh](heightfieldMesh.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,105 +0,0 @@
-# preflightHelicalThreadSolidMesh
-
-Checks thread dimensions, profile, end treatments, sampling, and conservative estimates against output limits.
-
-**preflightHelicalThreadSolidMesh**(`options`: [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md)): [`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
-
-
-
-This pure operation needs no engine and constructs planning data without vertex or index buffers.
-`circularSegments` is the selected count; row and triangle counts are conservative estimates.
-Successful preflight leaves generated coordinate and topology checks to mesh construction.
-
-## 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
-
-[`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
-
-
-## Related APIs
-
-- [HelicalThreadSolidMeshOptions](HelicalThreadSolidMeshOptions.md)
-- [HelicalThreadSolidMeshPreflight](HelicalThreadSolidMeshPreflight.md)
-- [helicalThreadSolidMesh](helicalThreadSolidMesh.md)
-
-## Guides
-
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,34 +0,0 @@
-# reverseTriangleMesh
-
-Returns a copy of a mesh with every triangle winding reversed.
-
-**reverseTriangleMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-Mesh to copy and reverse.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-Fresh position and index buffers; the input remains unchanged.
-
-
-## 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/sweepMesh.md

@@ -1,86 +0,0 @@
-# sweepMesh
-
-Sweeps one explicitly ordered point loop, with caps or a geometrically matching closed seam.
-
-**sweepMesh**(`profile`: [`Path2Input`](Path2Input.md), `path`: [`Path3Input`](Path3Input.md), `options?`: [`SweepOptions`](SweepOptions.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-## Example: Sweep point data along a bent path
-
-```ts
-const profile = rectangleContour({ size: [6, 3] });
-sweepMesh(profile, [[0, 0, 0], [0, 0, 15], [10, 0, 25]], {
-  orientation: { kind: "transport", initialNormal: [0, 1, 0] },
-});
-```
-
-## Parameters
-
-<a id="profile"></a>
-
-**`profile`** · [`Path2Input`](Path2Input.md) · Required
-
-
-
-<a id="path"></a>
-
-**`path`** · [`Path3Input`](Path3Input.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`SweepOptions`](SweepOptions.md) · Optional
-
-- [`closed`](SweepOptions.md#closed) · `boolean` · Optional
-
-  Raw point closure defaults to false; a Path3 supplies its closure and rejects conflicts.
-
-- [`limits`](SweepOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
-
-  Explicit output and sampling allocation ceilings.
-
-- [`orientation`](SweepOptions.md#orientation) · [`SweepOrientation`](SweepOrientation.md) · Optional
-
-  Explicit frame policy; default transport minimizes rotations, initially projecting +X then +Y then +Z.
-
-- [`resolution`](SweepOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
-
-  Physical sampling of nonzero twist; inserted stations retain authored station controls.
-
-- [`twist`](SweepOptions.md#twist) · `number` · Optional
-
-  Total additional profile rotation in degrees, with progression selected by twistBy.
-
-- [`twistBy`](SweepOptions.md#twistby) · `"length"` \| `"stations"` · Optional
-
-  Twist advances by physical path length (default), or normalized authored station position, including a closed seam gap.
-
-- [`scale`](SweepOptions.md#scale) · `number` \| [`Vector2Input`](Vector2Input.md) \| readonly [`Vector2Input`](Vector2Input.md)[] · Optional
-
-  Positive uniform/XY scale, or one XY pair per path station. Defaults to one.
-
-- [`seamProfileOffset`](SweepOptions.md#seamprofileoffset) · `number` · Optional
-
-  Corresponding point-index advance at a rotationally equivalent closed seam.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-
-## Related APIs
-
-- [Path2Input](Path2Input.md)
-- [Path3Input](Path3Input.md)
-- [SweepOptions](SweepOptions.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/transformTriangleMesh.md

@@ -1,46 +0,0 @@
-# transformTriangleMesh
-
-Applies an affine transform to a mesh and preserves outward face orientation.
-
-**transformTriangleMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `placement`: [`Transform3Input`](Transform3Input.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-A transform with a negative linear determinant reflects space, so this helper
-automatically reverses every triangle. Singular transforms are rejected.
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-Mesh to transform without mutation.
-
-
-
-<a id="placement"></a>
-
-**`placement`** · [`Transform3Input`](Transform3Input.md) · Required
-
-Immutable spatial placement or canonical row-major affine matrix.
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-A mesh with fresh transformed positions and copied or reversed indices.
-
-
-## Related APIs
-
-- [Transform3Input](Transform3Input.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/validateTriangleMesh.md

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

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

@@ -1,55 +0,0 @@
-# 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**: [`Vector3Data`](Vector3Data.md)
-
-
-
-Unit outward normal used as the anchor's local +Z direction.
-
-***
-
-### position
-
-
-
-`readonly` **position**: [`Vector3Data`](Vector3Data.md)
-
-
-
-World-space attachment position.
-
-***
-
-### up
-
-
-
-`readonly` **up**: [`Vector3Data`](Vector3Data.md)
-
-
-
-Roll guide projected into the plane perpendicular to `direction`.
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.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.17.0`.

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

@@ -1,69 +0,0 @@
-# AttachOptions
-
-Options controlling how one anchor is attached to another.
-
-## Extended by
-
-- [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
-
-## 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 model units.
-
-***
-
-### spin?
-
-
-
-`readonly` `optional` **spin?**: `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)
-- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.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.17.0`.