@metamesh/modeling 0.14.0 → 0.16.0

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

@@ -44,11 +44,11 @@ Optional maximum sampled edge length in millimetres.
 
 ***
 
-### maximumSegments?
+### maxSegments?
 
 
 
-`readonly` `optional` **maximumSegments?**: `number`
+`readonly` `optional` **maxSegments?**: `number`
 
 
 
@@ -56,11 +56,11 @@ Upper safety bound for a full circle; defaults to the selected maxCircularSegmen
 
 ***
 
-### minimumSegments?
+### minSegments?
 
 
 
-`readonly` `optional` **minimumSegments?**: `number`
+`readonly` `optional` **minSegments?**: `number`
 
 
 
@@ -71,4 +71,4 @@ Lower full-circle segment count; defaults to 16 or a lower selected circular cei
 
 - [CircularResolutionOptions](CircularResolutionOptions.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -59,4 +59,8 @@ Maximum segments around one complete circle.
 
 - [ModelingLimits](ModelingLimits.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -38,4 +38,4 @@ Angular comparison threshold in radians. Must be finite and greater than zero.
 
 Dimensionless scale multiplier. Must be finite and non-negative.
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -1,11 +1,17 @@
 # GridPatternOptions
 
-XY or XYZ grid with X varying fastest. The first item starts at the local origin.
+XY or XYZ grid with X varying fastest. The first item starts at the local origin. Dimension 2 restricts counts and spacing to XY; any frame must preserve the XY plane.
 
-**GridPatternOptions** = `object` & (\{ `count`: [`Vector2Tuple`](Vector2Tuple.md); `spacing`: [`Vector2Tuple`](Vector2Tuple.md); \} \| \{ `count`: [`Vector3Tuple`](Vector3Tuple.md); `spacing`: [`Vector3Tuple`](Vector3Tuple.md); \})
+**GridPatternOptions**\<`Dimension` *extends* `2` \| `3` = `3`\> = `object` & (\{ `count`: [`Vector2Data`](Vector2Data.md); `spacing`: [`Vector2Data`](Vector2Data.md); \} \| `Dimension` *extends* `3` ? `object` : `never`)
 
 
 
+## Type Parameters
+
+### Dimension
+
+`Dimension` *extends* `2` \| `3` = `3`
+
 ## Type Declaration
 
 ### center?
@@ -32,11 +38,11 @@ Optional right-handed local axes and origin for the grid.
 ## Related APIs
 
 - [Frame3](Frame3.md)
-- [Vector2Tuple](Vector2Tuple.md)
-- [Vector3Tuple](Vector3Tuple.md)
+- [Vector2Data](Vector2Data.md)
+- [Vector3Data](Vector3Data.md)
 
 ## Guides
 
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -11,4 +11,8 @@ Trusted output ceilings for pure construction; omitted fields use engine default
 
 - [ModelingLimits](ModelingLimits.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -2,7 +2,7 @@
 
 A closed rectilinear heightfield above a flat base, with uniform or explicit XY samples in millimetres.
 
-**HeightfieldOptions** = `object` & (\{ `size`: [`Vector2Tuple`](Vector2Tuple.md); `segments`: readonly \[`x`: `number`, `y`: `number`\]; `origin?`: [`Vector2Tuple`](Vector2Tuple.md); `coordinates?`: `never`; \} \| \{ `coordinates`: \{ `x`: readonly `number`[]; `y`: readonly `number`[]; \}; `size?`: `never`; `segments?`: `never`; `origin?`: `never`; \})
+**HeightfieldOptions** = `object` & (\{ `size`: [`Vector2Data`](Vector2Data.md); `segments`: readonly \[`x`: `number`, `y`: `number`\]; `origin?`: [`Vector2Data`](Vector2Data.md); `coordinates?`: `never`; \} \| \{ `coordinates`: \{ `x`: readonly `number`[]; `y`: readonly `number`[]; \}; `size?`: `never`; `segments?`: `never`; `origin?`: `never`; \})
 
 
 
@@ -18,7 +18,7 @@ absolute samples per axis, distinct in Float32. This infers the footprint and in
 
 
 
-`readonly` **height**: (`point`: [`Vector2Tuple`](Vector2Tuple.md)) => `number`
+`readonly` **height**: (`point`: [`Vector2Data`](Vector2Data.md)) => `number`
 
 
 
@@ -28,7 +28,7 @@ Absolute top Z at the supplied XY point. Every sample must be above baseZ.
 
 <a id="point"></a>
 
-**`point`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+**`point`** · [`Vector2Data`](Vector2Data.md) · Required
 
 
 
@@ -62,6 +62,10 @@ All policies retain two triangles per cell; neither estimates error elsewhere in
 
 ## Related APIs
 
-- [Vector2Tuple](Vector2Tuple.md)
+- [Vector2Data](Vector2Data.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -1,6 +1,6 @@
 # HeightfieldPreflight
 
-Predictable rectilinear-grid allocation facts; this does not evaluate the height callback.
+Exact grid and mesh buffer allocation counts resolved without evaluating the height callback.
 
 ## Properties
 
@@ -12,7 +12,7 @@ Predictable rectilinear-grid allocation facts; this does not evaluate the height
 
 
 
-Number of top grid points; center-error also evaluates one height per cell.
+Number of top grid points; excludes the extra per-cell height evaluations for center-error.
 
 ***
 
@@ -48,6 +48,11 @@ Number of allocated indexed triangles.
 
 
 
-Total bytes of Float32 positions and Uint32 indices.
+Total bytes of Float32 positions and Uint32 indices, excluding temporary storage.
 
-Package: `@metamesh/modeling@0.14.0`.
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -69,11 +69,11 @@ Nominal major diameter before any caller-owned fit compensation.
 
 ***
 
-### phaseDegrees?
+### phase?
 
 
 
-`readonly` `optional` **phaseDegrees?**: `number`
+`readonly` `optional` **phase?**: `number`
 
 
 
@@ -85,7 +85,7 @@ Angular offset of the first start in degrees. Default: `0`.
 
 
 
-`readonly` **profile**: [`ThreadProfile`](ThreadProfile.md)
+`readonly` **profile**: [`ThreadProfile`](ThreadProfile-type.md)
 
 
 
@@ -136,6 +136,10 @@ Optional numerical tolerance overrides.
 - [ModelingLimits](ModelingLimits.md)
 - [ThreadEndTreatmentOptions](ThreadEndTreatmentOptions.md)
 - [ThreadHandedness](ThreadHandedness.md)
-- [ThreadProfile](ThreadProfile.md)
+- [ThreadProfile](ThreadProfile-type.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -89,11 +89,11 @@ Nominal major diameter before any caller-owned fit compensation.
 
 ***
 
-### phaseDegrees?
+### phase?
 
 
 
-`readonly` `optional` **phaseDegrees?**: `number`
+`readonly` `optional` **phase?**: `number`
 
 
 
@@ -101,7 +101,7 @@ Angular offset of the first start in degrees. Default: `0`.
 
 #### Inherited from
 
-[`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md).[`phaseDegrees`](HelicalThreadRidgeMeshOptions.md#phasedegrees)
+[`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md).[`phase`](HelicalThreadRidgeMeshOptions.md#phase)
 
 ***
 
@@ -109,7 +109,7 @@ Angular offset of the first start in degrees. Default: `0`.
 
 
 
-`readonly` **profile**: [`ThreadProfile`](ThreadProfile.md)
+`readonly` **profile**: [`ThreadProfile`](ThreadProfile-type.md)
 
 
 
@@ -260,6 +260,10 @@ Upper bevel size override. Takes precedence over `bevelSize`.
 - [ModelingLimits](ModelingLimits.md)
 - [ThreadEndTreatmentOptions](ThreadEndTreatmentOptions.md)
 - [ThreadHandedness](ThreadHandedness.md)
-- [ThreadProfile](ThreadProfile.md)
+- [ThreadProfile](ThreadProfile-type.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -1,6 +1,6 @@
 # HelicalThreadSolidMeshPreflight
 
-Conservative allocation facts resolved before constructing a direct thread solid mesh.
+Selected sampling counts and conservative allocation estimates, before thread mesh construction.
 
 ## Properties
 
@@ -50,4 +50,9 @@ Conservative surface-row count across profile breaks, ends, and bevel stations.
 
 Conservative triangle count used by the selected output allocation policy.
 
-Package: `@metamesh/modeling@0.14.0`.
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -2,17 +2,18 @@
 
 Identity transform, safe to share because it is frozen.
 
-`const` **IDENTITY\_TRANSFORM3**: [`Transform3Matrix`](Transform3Matrix.md)
+`const` **IDENTITY\_TRANSFORM3**: [`Transform3Data`](Transform3Data.md)
 
 
 
 
 ## Related APIs
 
-- [Transform3Matrix](Transform3Matrix.md)
+- [Transform3Data](Transform3Data.md)
 
 ## Guides
 
 - [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+- [Fluent values and tuple kernels](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -74,11 +74,11 @@ Explicit output and circular allocation ceilings.
 
 ***
 
-### phaseDegrees?
+### phase?
 
 
 
-`readonly` `optional` **phaseDegrees?**: `number`
+`readonly` `optional` **phase?**: `number`
 
 
 
@@ -86,7 +86,7 @@ Angular offset of the first start in degrees. Default: `0`.
 
 #### Inherited from
 
-[`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md).[`phaseDegrees`](HelicalThreadRidgeMeshOptions.md#phasedegrees)
+[`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md).[`phase`](HelicalThreadRidgeMeshOptions.md#phase)
 
 ***
 
@@ -94,7 +94,7 @@ Angular offset of the first start in degrees. Default: `0`.
 
 
 
-`readonly` **profile**: [`ThreadProfile`](ThreadProfile.md)
+`readonly` **profile**: [`ThreadProfile`](ThreadProfile-type.md)
 
 
 
@@ -237,6 +237,10 @@ Apply a 45-degree bevel at Z=length.
 - [ThreadBevelOptions](ThreadBevelOptions.md)
 - [ThreadEndTreatmentOptions](ThreadEndTreatmentOptions.md)
 - [ThreadHandedness](ThreadHandedness.md)
-- [ThreadProfile](ThreadProfile.md)
+- [ThreadProfile](ThreadProfile-type.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,82 @@
+# KnuckleHingeBaseSpec
+
+Shared knuckle-joint dimensions in millimetres, independent of mounting geometry.
+
+## Properties
+
+### length
+
+
+
+`readonly` **length**: `number`
+
+
+
+Total extent along the +X pin axis, centered at the origin.
+
+***
+
+### knuckleCount
+
+
+
+`readonly` **knuckleCount**: `number`
+
+
+
+Number of equal alternating intervals, starting with half A.
+
+***
+
+### barrelDiameter
+
+
+
+`readonly` **barrelDiameter**: `number`
+
+
+
+Outside vertex-sized barrel diameter.
+
+***
+
+### pinDiameter
+
+
+
+`readonly` **pinDiameter**: `number`
+
+
+
+Vertex-sized shaft diameter, including an externally supplied shaft.
+
+***
+
+### radialClearance
+
+
+
+`readonly` **radialClearance**: `number`
+
+
+
+Nonnegative per-side radial allowance; bores circumscribe this running envelope.
+
+***
+
+### axialGap
+
+
+
+`readonly` **axialGap**: `number`
+
+
+
+Nonnegative total air gap between each neighboring pair of knuckle ends.
+
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,148 @@
+# KnuckleHingeDimensions
+
+Immutable joint layout and conservative faceted envelopes; no engine initialization.
+
+## Properties
+
+### spec
+
+
+
+`readonly` **spec**: [`KnuckleHingeSpec`](KnuckleHingeSpec.md)
+
+
+
+Validated, copied nominal inputs.
+
+***
+
+### barrelRadius
+
+
+
+`readonly` **barrelRadius**: `number`
+
+
+
+Nominal outside barrel radius.
+
+***
+
+### pinRadius
+
+
+
+`readonly` **pinRadius**: `number`
+
+
+
+Maximum shaft radius under any rotation.
+
+***
+
+### boreRadius
+
+
+
+`readonly` **boreRadius**: `number`
+
+
+
+Minimum face-sized bore radius, including radial clearance.
+
+***
+
+### boreOuterRadius
+
+
+
+`readonly` **boreOuterRadius**: `number`
+
+
+
+Maximum radius at the faceted bore vertices.
+
+***
+
+### minimumBarrelWall
+
+
+
+`readonly` **minimumBarrelWall**: `number`
+
+
+
+Conservative radial wall before outer end chamfers, accounting for both polygons.
+
+***
+
+### knuckleLength
+
+
+
+`readonly` **knuckleLength**: `number`
+
+
+
+Equal length of every interval.
+
+***
+
+### segments
+
+
+
+`readonly` **segments**: `number`
+
+
+
+Common exact full-circle segment count.
+
+***
+
+### knuckles
+
+
+
+`readonly` **knuckles**: readonly [`KnuckleHingeInterval`](KnuckleHingeInterval.md)[]
+
+
+
+Alternating schedule ordered from negative to positive X.
+
+***
+
+### pin
+
+
+
+`readonly` **pin**: `Readonly`\<\{ `start`: `number`; `length`: `number`; \}\> \| `null`
+
+
+
+Integral pin interval; null when the consumer supplies an inserted pin.
+
+***
+
+### axis
+
+
+
+`readonly` **axis**: [`Anchor3`](Anchor3-type.md)
+
+
+
+Origin at the joint center, direction +X, roll guide +Z.
+
+
+## Related APIs
+
+- [Anchor3](Anchor3-type.md)
+- [KnuckleHingeInterval](KnuckleHingeInterval.md)
+- [KnuckleHingeSpec](KnuckleHingeSpec.md)
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,46 @@
+# KnuckleHingeInterval
+
+One equal-length barrel interval in the shared pin-centered frame.
+
+## Properties
+
+### side
+
+
+
+`readonly` **side**: `"a"` \| `"b"`
+
+
+
+Alternating owner, beginning with A at the negative end of X.
+
+***
+
+### start
+
+
+
+`readonly` **start**: `number`
+
+
+
+Start along X, in millimetres.
+
+***
+
+### length
+
+
+
+`readonly` **length**: `number`
+
+
+
+Axial length, excluding the neighboring gaps.
+
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,51 @@
+# KnuckleHingeSamplingOptions
+
+Shared circular sampling for barrels, shafts, and bores.
+
+## Properties
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact full-circle count, divisible by four and at least four; overrides adaptive sampling.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Physical tessellation policy. Exact circular counts must also be divisible by four.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit allocation ceilings; defaults to the pure geometry sampling limits.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,22 @@
+# KnuckleHingeSpec
+
+Knuckle-joint construction modes and interval ownership.
+
+**KnuckleHingeSpec** = [`KnuckleHingeBaseSpec`](KnuckleHingeBaseSpec.md) & (\{ `mode`: `"print-in-place"` \| `"inserted-pin"`; `pinEngagement?`: `never`; \} \| \{ `mode`: `"lift-off"`; `knuckleCount`: `2`; `pinEngagement`: `number`; \})
+
+
+
+Print-in-place requires an odd count of at least three: A owns both
+end anchors and the entire shaft. Inserted-pin bores both halves and supplies no shaft.
+Lift-off requires exactly two intervals; A's integral pin enters B without a far anchor.
+
+
+## Related APIs
+
+- [KnuckleHingeBaseSpec](KnuckleHingeBaseSpec.md)
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.