@metamesh/modeling 0.18.0 → 0.20.0

package/dist/docs/reference/{geometry → mechanical}/sampleThreadHelices.md

@@ -1,6 +1,6 @@
 # sampleThreadHelices
 
-Samples evenly phased thread helices with finite `lead = pitch * starts`. All starts together respect maxPathPoints (default 100000); excessive counts fail before allocation.
+Samples evenly phased thread helices with finite `lead = pitch * starts`. All starts together respect `maxPathPoints`; excessive counts fail before allocation.
 
 **sampleThreadHelices**(`options`: [`ThreadHelixOptions`](ThreadHelixOptions.md)): [`SampledThreadHelices`](SampledThreadHelices.md)
 
@@ -12,6 +12,8 @@ Samples evenly phased thread helices with finite `lead = pitch * starts`. All st
 
 **`options`** · [`ThreadHelixOptions`](ThreadHelixOptions.md) · Required
 
+Dimensions in millimetres; lead is pitch multiplied by starts.
+
 - [`length`](ThreadHelixOptions.md#length) · `number` · Required
 
   Total sampled axial length in millimetres.
@@ -28,7 +30,7 @@ Samples evenly phased thread helices with finite `lead = pitch * starts`. All st
 
   Helix direction. Default: `right`.
 
-- [`limits`](ThreadHelixOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+- [`limits`](ThreadHelixOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\> · Optional
 
   Explicit aggregate path allocation ceilings across all starts.
 
@@ -44,7 +46,7 @@ Samples evenly phased thread helices with finite `lead = pitch * starts`. All st
 
   Number of evenly phased helices. Default: `1`.
 
-- [`tolerance`](ThreadHelixOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+- [`tolerance`](ThreadHelixOptions.md#tolerance) · [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md) · Optional
 
   Optional numerical tolerance overrides.
 
@@ -62,6 +64,12 @@ Samples evenly phased thread helices with finite `lead = pitch * starts`. All st
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { sampleThreadHelices } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mechanical}/threadProfile.md

@@ -9,6 +9,8 @@ Creates a periodic thread profile for the shaft-locked helical mesher.
 ## Example: Printable triangular thread profile
 
 ```ts
+import { threadProfile } from "@metamesh/modeling/geometry/mechanical";
+
 threadProfile({ kind: "triangular", pitch: 1.75 });
 ```
 
@@ -22,6 +24,8 @@ non-decreasing, periodic at their endpoints, and reach radial zero.
 
 **`spec`** · [`ThreadProfileSpec`](ThreadProfileSpec.md) · Required
 
+Profile family or custom one-pitch `[axial, radial]` path, in millimetres.
+
 
 
 ## Returns
@@ -36,6 +40,12 @@ non-decreasing, periodic at their endpoints, and reach radial zero.
 
 ## Guides
 
-- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Conservative estimates and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import { threadProfile } from "@metamesh/modeling/geometry/mechanical";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mechanical.md

@@ -0,0 +1,19 @@
+# Mechanical geometry
+
+Mechanical dimensions, fit policies, standards, and preflight calculations.
+
+Use @metamesh/modeling/geometry/mechanical for pure mechanical dimensions, gear outlines, thread profiles, fit policies, fastener standards, and preflight calculations. Results describe geometry and sampling, without certifying strength, printer fit, or a metrology class. Modeling constructors such as threadedRod and knuckleHinge remain in @metamesh/modeling.
+
+Preflights use explicit resolution and limits or package defaults. During generation, pass the effective resolution and limits from the callback context.
+
+## Categories
+
+- [Mechanical foundations](mechanical/categories/mechanical.md) — Resolve gears, knuckle joints, fastener standards, thread profiles, fit, and predictable allocations.
+
+## Import
+
+```ts
+import * as mechanical from "@metamesh/modeling/geometry/mechanical";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/ExtrudeMeshOptions.md

@@ -8,47 +8,23 @@ Dimensions and sampling for pure +Z mesh extrusion, without end treatments.
 
 ## Extended by
 
-- [`ExtrudeOptions`](../geometry/ExtrudeOptions.md)
+- [`ExtrudeOptions`](../model/ExtrudeOptions.md)
 
 ## Properties
 
-### height
-
-
-
-`readonly` **height**: `number`
-
-
-
-Positive extrusion height in millimetres.
-
-***
-
-### center?
-
-
-
-`readonly` `optional` **center?**: `boolean`
-
-
-
-Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
-
-***
-
-### divisions?
+### slices?
 
 
 
-`readonly` `optional` **divisions?**: `number`
+`readonly` `optional` **slices?**: `number`
 
 
 
-Exact number of intermediate profiles, nonnegative; overrides physical sampling.
+Positive longitudinal interval count; n slices create n + 1 profile layers. Overrides ordinary extrusion's physical sampling.
 
 #### Inherited from
 
-[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`divisions`](../geometry/ExtrusionSamplingOptions.md#divisions)
+[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`slices`](../geometry/ExtrusionSamplingOptions.md#slices)
 
 ***
 
@@ -84,19 +60,19 @@ Operation-level physical policy over the nearest model scope.
 
 ***
 
-### scaleTop?
+### scale?
 
 
 
-`readonly` `optional` **scaleTop?**: `number` \| [`Vector2Input`](../geometry/Vector2Input.md)
+`readonly` `optional` **scale?**: `number` \| [`Vector2Input`](../geometry/Vector2Input.md)
 
 
 
-Finite uniform or XY scale of the top profile; defaults to one.
+Final profile-local uniform or XY scale, interpolated from one before twisting. Both components must be positive or both zero for an apex of one simple boundary. Defaults to one.
 
 #### Inherited from
 
-[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`scaleTop`](../geometry/ExtrusionSamplingOptions.md#scaletop)
+[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`scale`](../geometry/ExtrusionSamplingOptions.md#scale)
 
 ***
 
@@ -114,16 +90,39 @@ Finite rotation of the top profile about +Z, in degrees; defaults to zero.
 
 [`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`twist`](../geometry/ExtrusionSamplingOptions.md#twist)
 
+***
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Positive extrusion height in millimetres.
+
+***
+
+### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
 
-## Related APIs
+Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
 
-- [ExtrusionSamplingOptions](ExtrusionSamplingOptions.md)
-- [GeometryResolution](GeometryResolution.md)
-- [ModelingLimits](ModelingLimits.md)
-- [Vector2Input](Vector2Input.md)
 
 ## Guides
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import type { ExtrudeMeshOptions } from "@metamesh/modeling/geometry/mesh";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -1,18 +1,20 @@
 # HeightfieldMeshLimits
 
-Trusted output ceilings for pure construction; omitted fields use engine defaults.
+Trusted output ceilings for pure construction; omitted fields use package defaults.
 
 **HeightfieldMeshLimits** = `Partial`\<`Pick`\<[`ModelingLimits`](../geometry/ModelingLimits.md), `"maxVertices"` \| `"maxTriangles"` \| `"maxBytes"`\>\>
 
 
 
 
-## Related APIs
+## Guides
 
-- [ModelingLimits](ModelingLimits.md)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Guides
+## Import
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+```ts
+import type { HeightfieldMeshLimits } from "@metamesh/modeling/geometry/mesh";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -53,6 +53,12 @@ Total bytes of Float32 positions and Uint32 indices, excluding temporary storage
 
 ## Guides
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import type { HeightfieldPreflight } from "@metamesh/modeling/geometry/mesh";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/ImmutableTriangleMesh.md

@@ -1,6 +1,6 @@
 # ImmutableTriangleMesh
 
-Immutable local XYZ positions and triangle indices, suitable for a computed value or part.
+Immutable local XYZ positions and triangle indices, suitable for a memo result or part.
 
 ## Extended by
 
@@ -32,12 +32,14 @@ Packed XYZ coordinates in millimetres.
 Zero-based vertex indices, three per triangle.
 
 
-## Related APIs
+## Guides
 
-- [ImmutableBuffer](ImmutableBuffer.md)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Guides
+## Import
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+```ts
+import type { ImmutableTriangleMesh } from "@metamesh/modeling/geometry/mesh";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/LoftMeshStation.md

@@ -1,6 +1,6 @@
 # LoftMeshStation
 
-One point-data profile at a height or explicit right-handed spatial frame.
+One point-data profile at a horizontal height or explicit affine transform.
 
 **LoftMeshStation** = [`LoftPlacement`](../geometry/LoftPlacement.md) & `object`
 
@@ -19,13 +19,14 @@ One point-data profile at a height or explicit right-handed spatial frame.
 Closed Path2 or ordered finite XY boundary points with an implicit closing edge.
 
 
-## Related APIs
+## Guides
 
-- [LoftPlacement](LoftPlacement.md)
-- [Path2Input](Path2Input.md)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Guides
+## Import
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+```ts
+import type { LoftMeshStation } from "@metamesh/modeling/geometry/mesh";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/MeshRenderOptions.md

@@ -0,0 +1,28 @@
+# MeshRenderOptions
+
+Shading policy for a render copy; manufacturing positions and triangle order never change.
+
+## Properties
+
+### creaseAngle?
+
+
+
+`readonly` `optional` **creaseAngle?**: `number`
+
+
+
+Maximum angle between averaged face normals, in degrees. Defaults to `20`; `0` is flat.
+
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import type { MeshRenderOptions } from "@metamesh/modeling/geometry/mesh";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/PlanarMeshOptimizationFallbackReason.md

@@ -1,6 +1,6 @@
 # PlanarMeshOptimizationFallbackReason
 
-Stable reason why planar optimization returned the original mesh unchanged.
+Stable reason why planar optimization preserved the original connectivity.
 
 **PlanarMeshOptimizationFallbackReason** = `"candidate-boundary-changed"` \| `"candidate-measurements-changed"` \| `"candidate-not-closed-oriented-manifold"` \| `"candidate-quality-regressed"` \| `"input-not-closed-oriented-manifold"`
 
@@ -9,6 +9,12 @@ Stable reason why planar optimization returned the original mesh unchanged.
 
 ## Guides
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import type { PlanarMeshOptimizationFallbackReason } from "@metamesh/modeling/geometry/mesh";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/PlanarMeshOptimizationOptions.md

@@ -4,7 +4,7 @@ Options controlling bounded, connectivity-only optimization of planar triangle p
 
 ## Extends
 
-- [`TriangleMeshQualityOptions`](../geometry/TriangleMeshQualityOptions.md)
+- [`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md)
 
 ## Properties
 
@@ -129,7 +129,7 @@ Maximum number of triangles inspected. Defaults to `200000`.
 
 #### Inherited from
 
-[`TriangleMeshQualityOptions`](../geometry/TriangleMeshQualityOptions.md).[`maxTriangles`](../geometry/TriangleMeshQualityOptions.md#maxtriangles)
+[`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md).[`maxTriangles`](TriangleMeshQualityOptions.md#maxtriangles)
 
 ***
 
@@ -145,16 +145,21 @@ Numeric comparison overrides; model coordinates are interpreted in their existin
 
 #### Inherited from
 
-[`TriangleMeshQualityOptions`](../geometry/TriangleMeshQualityOptions.md).[`tolerance`](../geometry/TriangleMeshQualityOptions.md#tolerance)
+[`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md).[`tolerance`](TriangleMeshQualityOptions.md#tolerance)
 
 
 ## Related APIs
 
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [TriangleMeshQualityOptions](TriangleMeshQualityOptions.md)
 
 ## Guides
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import type { PlanarMeshOptimizationOptions } from "@metamesh/modeling/geometry/mesh";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/PlanarMeshOptimizationResult.md

@@ -8,7 +8,7 @@ Outcome of bounded planar-patch optimization, including before/after diagnostics
 
 
 
-`readonly` **after**: [`TriangleMeshQualityReport`](../geometry/TriangleMeshQualityReport.md)
+`readonly` **after**: [`TriangleMeshQualityReport`](TriangleMeshQualityReport.md)
 
 
 
@@ -20,7 +20,7 @@ Quality report for the returned mesh; equal to `before` on unchanged or fallback
 
 
 
-`readonly` **before**: [`TriangleMeshQualityReport`](../geometry/TriangleMeshQualityReport.md)
+`readonly` **before**: [`TriangleMeshQualityReport`](TriangleMeshQualityReport.md)
 
 
 
@@ -56,7 +56,7 @@ Whether the returned mesh has different triangle connectivity.
 
 
 
-`readonly` `optional` **fallbackReason?**: [`PlanarMeshOptimizationFallbackReason`](../geometry/PlanarMeshOptimizationFallbackReason.md)
+`readonly` `optional` **fallbackReason?**: [`PlanarMeshOptimizationFallbackReason`](PlanarMeshOptimizationFallbackReason.md)
 
 
 
@@ -80,11 +80,11 @@ Number of accepted legal diagonal flips.
 
 
 
-`readonly` **mesh**: [`TriangleMesh`](../geometry/TriangleMesh.md)
+`readonly` **mesh**: [`TriangleMesh`](TriangleMesh.md)
 
 
 
-Returned mesh; unchanged results preserve the exact input object.
+Returned mesh; unchanged raw inputs retain their identity, while immutable inputs produce owned buffers.
 
 ***
 
@@ -119,6 +119,12 @@ Number of triggered patches omitted because a configured triangle bound would be
 
 ## Guides
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.18.0`.
+## Import
+
+```ts
+import type { PlanarMeshOptimizationResult } from "@metamesh/modeling/geometry/mesh";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/PlanarPatchQuality.md

@@ -183,12 +183,14 @@ Number of triangles in this patch.
 Number of distinct indexed vertices referenced by this patch.
 
 
-## Related APIs
+## Guides
 
-- [Vector3Data](Vector3Data.md)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Guides
+## Import
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+```ts
+import type { PlanarPatchQuality } from "@metamesh/modeling/geometry/mesh";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/RenderMesh.md

@@ -0,0 +1,68 @@
+# RenderMesh
+
+Owned indexed render buffers with unit vertex normals and positions in millimetres.
+
+## Extends
+
+- [`TriangleMesh`](TriangleMesh.md)
+
+## Properties
+
+### normals
+
+
+
+`readonly` **normals**: `Float32Array`
+
+
+
+XYZ unit normals, one for each render vertex. Vertices split at shading discontinuities.
+
+***
+
+### indices
+
+
+
+`readonly` **indices**: `Uint32Array`
+
+
+
+Three unsigned vertex indices per triangle.
+
+#### Inherited from
+
+[`TriangleMesh`](TriangleMesh.md).[`indices`](TriangleMesh.md#indices)
+
+***
+
+### positions
+
+
+
+`readonly` **positions**: `Float32Array`
+
+
+
+Flat XYZ coordinates in millimetres.
+
+#### Inherited from
+
+[`TriangleMesh`](TriangleMesh.md).[`positions`](TriangleMesh.md#positions)
+
+
+## Related APIs
+
+- [TriangleMesh](TriangleMesh.md)
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import type { RenderMesh } from "@metamesh/modeling/geometry/mesh";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/SolidMeshValidationOptions.md

@@ -27,12 +27,14 @@ Work ceiling for spatial comparisons and containment tests; defaults to 2,000,00
 Distance comparison policy in millimetres; near contacts reject conservatively.
 
 
-## Related APIs
+## Guides
 
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Guides
+## Import
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+```ts
+import type { SolidMeshValidationOptions } from "@metamesh/modeling/geometry/mesh";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/TriangleMesh.md

@@ -2,6 +2,10 @@
 
 A topology-preserving indexed triangle mesh with mutable owned XYZ buffers.
 
+## Extended by
+
+- [`RenderMesh`](RenderMesh.md)
+
 ## Properties
 
 ### indices
@@ -27,8 +31,18 @@ Three unsigned vertex indices per triangle.
 Flat XYZ coordinates in millimetres.
 
 
+## Related APIs
+
+- [RenderMesh](RenderMesh.md)
+
 ## Guides
 
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import type { TriangleMesh } from "@metamesh/modeling/geometry/mesh";
+```
 
-Package: `@metamesh/modeling@0.18.0`.
+Package: `@metamesh/modeling@0.20.0`.