@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,33 @@
+# getMetricClearanceHole
+
+Returns one recommended metric clearance-hole diameter in millimetres.
+
+**getMetricClearanceHole**(`size`: [`MetricFastenerSize`](MetricFastenerSize.md), `fit?`: [`ClearanceHoleFit`](ClearanceHoleFit.md)): `number`
+
+
+
+## Parameters
+
+<a id="size"></a>
+
+**`size`** · [`MetricFastenerSize`](MetricFastenerSize.md) · Required
+
+
+
+<a id="fit"></a>
+
+**`fit`** · [`ClearanceHoleFit`](ClearanceHoleFit.md) · Optional
+
+
+
+## Returns
+
+`number`
+
+
+## Related APIs
+
+- [ClearanceHoleFit](ClearanceHoleFit.md)
+- [MetricFastenerSize](MetricFastenerSize.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,27 @@
+# getMetricFastenerStandard
+
+Returns the immutable standards record for one supported metric size.
+
+**getMetricFastenerStandard**(`size`: [`MetricFastenerSize`](MetricFastenerSize.md)): [`MetricFastenerStandard`](MetricFastenerStandard.md)
+
+
+
+## Parameters
+
+<a id="size"></a>
+
+**`size`** · [`MetricFastenerSize`](MetricFastenerSize.md) · Required
+
+
+
+## Returns
+
+[`MetricFastenerStandard`](MetricFastenerStandard.md)
+
+
+## Related APIs
+
+- [MetricFastenerSize](MetricFastenerSize.md)
+- [MetricFastenerStandard](MetricFastenerStandard.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,31 @@
+# gridPatternTransforms
+
+XY or XYZ grid placements in millimetres, in X-fastest order.
+
+**gridPatternTransforms**(`options`: [`GridPatternOptions`](GridPatternOptions.md)): readonly [`Transform3`](Transform3.md)[]
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`GridPatternOptions`](GridPatternOptions.md) · Required
+
+
+
+## Returns
+
+readonly [`Transform3`](Transform3.md)[]
+
+
+## Related APIs
+
+- [GridPatternOptions](GridPatternOptions.md)
+- [Transform3](Transform3.md)
+
+## Guides
+
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,43 @@
+# heightfieldMesh
+
+Builds a closed indexed mesh from a rectilinear top, matched boundary walls, and flat base. 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.
+
+**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),
+});
+```
+
+## 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)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,30 @@
+# inverseTransform3
+
+Inverts a finite, non-singular affine transform.
+
+**inverseTransform3**(`transform`: [`Transform3`](Transform3.md)): [`Transform3`](Transform3.md)
+
+
+
+## Parameters
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+Transform to invert.
+
+
+
+## Returns
+
+[`Transform3`](Transform3.md)
+
+A new frozen transform whose composition with the input is identity.
+
+
+## Related APIs
+
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,26 @@
+# isGeometryError
+
+Recognizes structured geometry errors from separately bundled Modeling copies in the same realm. Ordinary errors and unmarked code-shaped objects are rejected. The marker is execution-local and does not survive structured cloning; worker protocols carry their own serialized error envelope.
+
+**isGeometryError**(`value`: `unknown`): `value is GeometryError`
+
+
+
+## Parameters
+
+<a id="value"></a>
+
+**`value`** · `unknown` · Required
+
+
+
+## Returns
+
+`value is GeometryError`
+
+
+## Related APIs
+
+- [GeometryError](GeometryError.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,36 @@
+# 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)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,43 @@
+# layoutRow
+
+Returns immutable translations for a +X row of finite XYZ bounds with a nonnegative gap. Each minimum Y/Z becomes zero, and the first minimum X becomes zero. Supply bounds after any intended part rotation; translations apply to those bounds. An empty input returns [].
+
+**layoutRow**(`bounds`: readonly [`Bounds3`](Bounds3.md)[], `options?`: [`RowLayoutOptions`](RowLayoutOptions.md)): readonly [`Vector3`](Vector3.md)[]
+
+
+
+## Parameters
+
+<a id="bounds"></a>
+
+**`bounds`** · readonly [`Bounds3`](Bounds3.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`RowLayoutOptions`](RowLayoutOptions.md) · Optional
+
+- [`gap`](RowLayoutOptions.md#gap) · `number` · Optional
+
+  Nonnegative millimetre gap between adjacent X bounds. Defaults to zero.
+
+
+
+## Returns
+
+readonly [`Vector3`](Vector3.md)[]
+
+
+## Related APIs
+
+- [Bounds3](Bounds3.md)
+- [RowLayoutOptions](RowLayoutOptions.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/length3.md

@@ -0,0 +1,26 @@
+# length3
+
+Returns Euclidean vector length in the vector's coordinate units.
+
+`const` **length3**: (`vector`: [`Vector3`](Vector3.md)) => `number`
+
+
+
+## Parameters
+
+<a id="vector"></a>
+
+**`vector`** · [`Vector3`](Vector3.md) · Required
+
+
+
+## Returns
+
+`number`
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,38 @@
+# lerp3
+
+Linearly interpolates two vectors; `t` is dimensionless and may extrapolate.
+
+`const` **lerp3**: (`a`: [`Vector3`](Vector3.md), `b`: [`Vector3`](Vector3.md), `t`: `number`) => [`Vector3`](Vector3.md)
+
+
+
+## Parameters
+
+<a id="a"></a>
+
+**`a`** · [`Vector3`](Vector3.md) · Required
+
+
+
+<a id="b"></a>
+
+**`b`** · [`Vector3`](Vector3.md) · Required
+
+
+
+<a id="t"></a>
+
+**`t`** · `number` · Required
+
+
+
+## Returns
+
+[`Vector3`](Vector3.md)
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,31 @@
+# linearPatternTransforms
+
+Equal linear placements in millimetres, including the original at the origin.
+
+**linearPatternTransforms**(`options`: [`LinearPatternOptions`](LinearPatternOptions.md)): readonly [`Transform3`](Transform3.md)[]
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`LinearPatternOptions`](LinearPatternOptions.md) · Required
+
+
+
+## Returns
+
+readonly [`Transform3`](Transform3.md)[]
+
+
+## Related APIs
+
+- [LinearPatternOptions](LinearPatternOptions.md)
+- [Transform3](Transform3.md)
+
+## Guides
+
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,72 @@
+# 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.
+
+## 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)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,51 @@
+# matchProfiles
+
+Explicitly matches identified component/contour/span topology across a family. Every paired span uses the maximum physical subdivision count requested by any member. Cubics share a checked uniform parameter grid, including grids selected by exact paired requests. Input order and winding are preserved. Collapsed spans retain repeated logical slots, which the engine maps to shared physical vertices while omitting degenerate faces.
+
+**matchProfiles**(`profiles`: readonly [`Profile`](Profile.md)[], `options?`: [`MatchProfilesOptions`](MatchProfilesOptions.md)): readonly [`CorrespondingProfile`](CorrespondingProfile.md)[]
+
+
+
+## Example: Match named rectangle landmarks
+
+```ts
+matchProfiles([
+  rectangleProfile({ size: [20, 12] }),
+  rectangleProfile({ size: [30, 20], treatment: { kind: "round", radius: 3 } }),
+]);
+```
+
+## Parameters
+
+<a id="profiles"></a>
+
+**`profiles`** · readonly [`Profile`](Profile.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`MatchProfilesOptions`](MatchProfilesOptions.md) · Optional
+
+- [`resolution`](MatchProfilesOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+- [`limits`](MatchProfilesOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit per-profile and circular ceilings; the family also has a one-million-slot work bound.
+
+
+
+## Returns
+
+readonly [`CorrespondingProfile`](CorrespondingProfile.md)[]
+
+
+## Related APIs
+
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [MatchProfilesOptions](MatchProfilesOptions.md)
+- [Profile](Profile.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,47 @@
+# measureInternalCylindricalGearPairMotion
+
+Measures sampled kinematic interference over one tooth cycle of an internal gear pair.
+
+**measureInternalCylindricalGearPairMotion**(`spec`: [`CylindricalGearPairSpec`](CylindricalGearPairSpec.md), `options?`: [`CylindricalGearPairMotionOptions`](CylindricalGearPairMotionOptions.md)): [`CylindricalGearPairMotionReport`](CylindricalGearPairMotionReport.md)
+
+
+
+The driver and ring rotate in the same direction at their resolved tooth-count ratio. Each
+sampled pinion outline is subtracted from the ring's center-and-space opening; remaining area is
+solid overlap. This catches involute, tip, and trimming interference that a single assembled pose
+misses. It is a deterministic model check, not a certified gear-rating calculation.
+
+## Parameters
+
+<a id="spec"></a>
+
+**`spec`** · [`CylindricalGearPairSpec`](CylindricalGearPairSpec.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`CylindricalGearPairMotionOptions`](CylindricalGearPairMotionOptions.md) · Optional
+
+- [`outline`](CylindricalGearPairMotionOptions.md#outline) · [`CylindricalGearOutlineOptions`](CylindricalGearOutlineOptions.md) · Optional
+
+  Optional deterministic outline sampling overrides.
+
+- [`samples`](CylindricalGearPairMotionOptions.md#samples) · `number` · Optional
+
+  Coupled poses sampled over one driver tooth pitch. Defaults to 24.
+
+
+
+## Returns
+
+[`CylindricalGearPairMotionReport`](CylindricalGearPairMotionReport.md)
+
+
+## Related APIs
+
+- [CylindricalGearPairMotionOptions](CylindricalGearPairMotionOptions.md)
+- [CylindricalGearPairMotionReport](CylindricalGearPairMotionReport.md)
+- [CylindricalGearPairSpec](CylindricalGearPairSpec.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,55 @@
+# measureTriangleMesh
+
+Measures bounds, surface area, and signed volume without changing the mesh.
+
+**measureTriangleMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md)): [`TriangleMeshMeasurements`](TriangleMeshMeasurements.md)
+
+
+
+Signed volume is meaningful for a consistently wound closed mesh. Set
+`requireClosed` when measurements will be used as manufacturing assertions.
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+Mesh to validate and measure.
+
+
+
+<a id="options"></a>
+
+**`options`** · [`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md) · Optional
+
+Validation policy applied before measurement.
+
+- [`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
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md)
+
+Immutable deterministic scalar and bounds measurements.
+
+
+## Related APIs
+
+- [TriangleMesh](TriangleMesh.md)
+- [TriangleMeshMeasurements](TriangleMeshMeasurements.md)
+- [TriangleMeshValidationOptions](TriangleMeshValidationOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

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

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

@@ -0,0 +1,29 @@
+# minimumCylindricalGearToothCountWithoutUndercut
+
+Returns the smallest unshifted full-depth external tooth count that avoids rack-cutter undercut.
+
+**minimumCylindricalGearToothCountWithoutUndercut**(`spec?`: `Readonly`\<`Pick`\<[`CylindricalGearSpec`](CylindricalGearSpec.md), `"helixAngleDegrees"` \| `"pressureAngleDegrees"`\>\>): `number`
+
+
+
+The normal-plane limit is `2 / sin²(alpha_n)`. Helical gears use the standard virtual tooth
+count `z_v = z / cos³(beta)`, so increasing helix angle can reduce the physical tooth count.
+
+## Parameters
+
+<a id="spec"></a>
+
+**`spec`** · `Readonly`\<`Pick`\<[`CylindricalGearSpec`](CylindricalGearSpec.md), `"helixAngleDegrees"` \| `"pressureAngleDegrees"`\>\> · Optional
+
+
+
+## Returns
+
+`number`
+
+
+## Related APIs
+
+- [CylindricalGearSpec](CylindricalGearSpec.md)
+
+Package: `@metamesh/modeling@0.13.0`.