@metamesh/modeling 0.17.0 → 0.18.0

package/dist/docs/reference/{model/HelicalThreadRidgeMeshOptions.md → mesh/ThreadRidgeOptions.md}

@@ -1,14 +1,18 @@
-# HelicalThreadRidgeMeshOptions
+# ThreadRidgeOptions
 
 Runtime-neutral options for the dedicated helical ridge mesher.
 
+## Extended by
+
+- [`ThreadSolidOptions`](../geometry/ThreadSolidOptions.md)
+
 ## Properties
 
 ### ends?
 
 
 
-`readonly` `optional` **ends?**: [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md)
+`readonly` `optional` **ends?**: [`ThreadEndTreatmentOptions`](../geometry/ThreadEndTreatmentOptions.md)
 
 
 
@@ -21,7 +25,7 @@ BOSL2-style non-cut lead-in scaling is available on complete thread solids.
 
 
 
-`readonly` `optional` **handedness?**: [`ThreadHandedness`](ThreadHandedness.md)
+`readonly` `optional` **handedness?**: [`ThreadHandedness`](../geometry/ThreadHandedness.md)
 
 
 
@@ -45,7 +49,7 @@ Total threaded axial length in millimetres.
 
 
 
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\>
 
 
 
@@ -81,7 +85,7 @@ Angular offset of the first start in degrees. Default: `0`.
 
 
 
-`readonly` **profile**: [`ThreadProfile`](ThreadProfile.md)
+`readonly` **profile**: [`ThreadProfile`](../geometry/ThreadProfile-type.md)
 
 
 
@@ -93,7 +97,7 @@ Validated periodic profile repeated around the shaft.
 
 
 
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+`readonly` `optional` **resolution?**: [`GeometryResolution`](../geometry/GeometryResolution.md)
 
 
 
@@ -117,7 +121,7 @@ Number of evenly phased starts. Default: `1`.
 
 
 
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
 
 
 
@@ -132,10 +136,10 @@ Optional numerical tolerance overrides.
 - [ThreadEndTreatmentOptions](ThreadEndTreatmentOptions.md)
 - [ThreadHandedness](ThreadHandedness.md)
 - [ThreadProfile](ThreadProfile.md)
+- [ThreadSolidOptions](ThreadSolidOptions.md)
 
 ## Guides
 
-- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
-- [Preflight guarantees and host settings](../../guides/concepts.md#check-preflight-guarantees)
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.17.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -0,0 +1,222 @@
+# ThreadSolidOptions
+
+Options for a complete threaded-cylinder mesh; base semantics match the ridge builder.
+
+## Extends
+
+- [`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md)
+
+## Properties
+
+### ends?
+
+
+
+`readonly` `optional` **ends?**: [`ThreadEndTreatmentOptions`](../geometry/ThreadEndTreatmentOptions.md)
+
+
+
+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.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`ends`](../geometry/ThreadRidgeOptions.md#ends)
+
+***
+
+### handedness?
+
+
+
+`readonly` `optional` **handedness?**: [`ThreadHandedness`](../geometry/ThreadHandedness.md)
+
+
+
+Helix direction. Default: `right`.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`handedness`](../geometry/ThreadRidgeOptions.md#handedness)
+
+***
+
+### length
+
+
+
+`readonly` **length**: `number`
+
+
+
+Total threaded axial length in millimetres.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`length`](../geometry/ThreadRidgeOptions.md#length)
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\>
+
+
+
+Explicit output and circular allocation ceilings.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`limits`](../geometry/ThreadRidgeOptions.md#limits)
+
+***
+
+### majorDiameter
+
+
+
+`readonly` **majorDiameter**: `number`
+
+
+
+Nominal major diameter before any caller-owned fit compensation.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`majorDiameter`](../geometry/ThreadRidgeOptions.md#majordiameter)
+
+***
+
+### phase?
+
+
+
+`readonly` `optional` **phase?**: `number`
+
+
+
+Angular offset of the first start in degrees. Default: `0`.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`phase`](../geometry/ThreadRidgeOptions.md#phase)
+
+***
+
+### profile
+
+
+
+`readonly` **profile**: [`ThreadProfile`](../geometry/ThreadProfile-type.md)
+
+
+
+Validated periodic profile repeated around the shaft.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`profile`](../geometry/ThreadRidgeOptions.md#profile)
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](../geometry/GeometryResolution.md)
+
+
+
+Optional circular-resolution policy.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`resolution`](../geometry/ThreadRidgeOptions.md#resolution)
+
+***
+
+### starts?
+
+
+
+`readonly` `optional` **starts?**: `number`
+
+
+
+Number of evenly phased starts. Default: `1`.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`starts`](../geometry/ThreadRidgeOptions.md#starts)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
+
+
+
+Optional numerical tolerance overrides.
+
+#### Inherited from
+
+[`ThreadRidgeOptions`](../geometry/ThreadRidgeOptions.md).[`tolerance`](../geometry/ThreadRidgeOptions.md#tolerance)
+
+***
+
+### bevel?
+
+
+
+`readonly` `optional` **bevel?**: [`Bevel`](../geometry/Bevel.md)
+
+
+
+Independent 45-degree bottom/top bevels; omitted disables both. Auto uses profile depth.
+
+***
+
+### bevelOffset?
+
+
+
+`readonly` `optional` **bevelOffset?**: `number`
+
+
+
+Distance of each bevel target face inward from the corresponding mesh end.
+
+***
+
+### bevelMode?
+
+
+
+`readonly` `optional` **bevelMode?**: `"inset"` \| `"outset"`
+
+
+
+`inset` trims an external rod; `outset` expands an internal cutter.
+
+
+## Related APIs
+
+- [Bevel](Bevel.md)
+- [GeometryResolution](GeometryResolution.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [ModelingLimits](ModelingLimits.md)
+- [ThreadEndTreatmentOptions](ThreadEndTreatmentOptions.md)
+- [ThreadHandedness](ThreadHandedness.md)
+- [ThreadProfile](ThreadProfile.md)
+- [ThreadRidgeOptions](ThreadRidgeOptions.md)
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -0,0 +1,58 @@
+# ThreadSolidPreflight
+
+Selected sampling counts and conservative allocation estimates, before thread mesh construction.
+
+## Properties
+
+### axialIntervals
+
+
+
+`readonly` **axialIntervals**: `number`
+
+
+
+Uniform axial intervals required only by a requested physical segment-length limit.
+
+***
+
+### circularSegments
+
+
+
+`readonly` **circularSegments**: `number`
+
+
+
+Start-aligned full-circle segment count used by the surface mesh.
+
+***
+
+### estimatedRows
+
+
+
+`readonly` **estimatedRows**: `number`
+
+
+
+Conservative surface-row count across profile breaks, ends, and bevel stations.
+
+***
+
+### estimatedTriangles
+
+
+
+`readonly` **estimatedTriangles**: `number`
+
+
+
+Conservative triangle count used by the selected output allocation policy.
+
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -0,0 +1,256 @@
+# Transform2
+
+Immutable reusable XY placement. Methods apply in written order; angles are degrees.
+
+## Methods
+
+### translate()
+
+
+
+**translate**(`offset`: [`Vector2Input`](../geometry/Vector2Input.md)): `Transform2`
+
+
+
+Applies a translation in model units after this placement.
+
+#### Parameters
+
+<a id="offset"></a>
+
+**`offset`** · [`Vector2Input`](../geometry/Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### rotate()
+
+
+
+**rotate**(`degrees`: `number`, `options?`: [`Pivot2Options`](../geometry/Pivot2Options.md)): `Transform2`
+
+
+
+Rotates counterclockwise in degrees about an optional world-space pivot (default origin).
+
+#### Parameters
+
+<a id="degrees"></a>
+
+**`degrees`** · `number` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`Pivot2Options`](../geometry/Pivot2Options.md) · Optional
+
+- [`pivot`](../geometry/Pivot2Options.md#pivot) · [`Vector2Input`](../geometry/Vector2Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### scale()
+
+
+
+**scale**(`factors`: `number` \| [`Vector2Input`](../geometry/Vector2Input.md), `options?`: [`Pivot2Options`](../geometry/Pivot2Options.md)): `Transform2`
+
+
+
+Scales about an optional world-space pivot; finite nonzero factors may reflect.
+
+#### Parameters
+
+<a id="factors"></a>
+
+**`factors`** · `number` \| [`Vector2Input`](../geometry/Vector2Input.md) · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`Pivot2Options`](../geometry/Pivot2Options.md) · Optional
+
+- [`pivot`](../geometry/Pivot2Options.md#pivot) · [`Vector2Input`](../geometry/Vector2Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### andThen()
+
+
+
+**andThen**(`next`: [`Transform2Input`](../geometry/Transform2Input.md)): `Transform2`
+
+
+
+Applies this placement first, then `next`; neither operand is mutated.
+
+#### Parameters
+
+<a id="next"></a>
+
+**`next`** · [`Transform2Input`](../geometry/Transform2Input.md) · Required
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### inverse()
+
+
+
+**inverse**(): `Transform2`
+
+
+
+Returns the inverse; singular and numerically unstable transforms throw GeometryError.
+
+#### Returns
+
+`Transform2`
+
+***
+
+### applyPoint()
+
+
+
+**applyPoint**(`point`: [`Vector2Input`](../geometry/Vector2Input.md)): [`Vector2`](../geometry/Vector2-type.md)
+
+
+
+Transforms a finite point, including translation. Returns a fresh immutable vector.
+
+#### Parameters
+
+<a id="point"></a>
+
+**`point`** · [`Vector2Input`](../geometry/Vector2Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector2`](../geometry/Vector2-type.md)
+
+***
+
+### applyDirection()
+
+
+
+**applyDirection**(`direction`: [`Vector2Input`](../geometry/Vector2Input.md)): [`Vector2`](../geometry/Vector2-type.md)
+
+
+
+Transforms a finite direction, excluding translation and retaining scale. This is not a normal transform.
+
+#### Parameters
+
+<a id="direction"></a>
+
+**`direction`** · [`Vector2Input`](../geometry/Vector2Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector2`](../geometry/Vector2-type.md)
+
+***
+
+### applyNormal()
+
+
+
+**applyNormal**(`normal`: [`Vector2Input`](../geometry/Vector2Input.md)): [`Vector2`](../geometry/Vector2-type.md)
+
+
+
+Applies the inverse transpose and normalizes. Ignores translation; rejects zero normals.
+
+#### Parameters
+
+<a id="normal"></a>
+
+**`normal`** · [`Vector2Input`](../geometry/Vector2Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector2`](../geometry/Vector2-type.md)
+
+***
+
+### toData()
+
+
+
+**toData**(): [`Transform2Data`](../geometry/Transform2Data.md)
+
+
+
+Returns the frozen canonical row-major 3x3 matrix for interchange.
+
+#### Returns
+
+[`Transform2Data`](../geometry/Transform2Data.md)
+
+***
+
+### to3D()
+
+
+
+**to3D**(): [`Transform3`](../geometry/Transform3-type.md)
+
+
+
+Embeds this placement in XYZ, leaving Z unchanged, for solids and 3D paths.
+
+#### Returns
+
+[`Transform3`](../geometry/Transform3-type.md)
+
+
+## Related APIs
+
+- [Pivot2Options](Pivot2Options.md)
+- [Transform2](Transform2.md)
+- [Transform2Data](Transform2Data.md)
+- [Transform2Input](Transform2Input.md)
+- [Transform3](Transform3.md)
+- [Vector2](Vector2.md)
+- [Vector2Input](Vector2Input.md)
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -0,0 +1,14 @@
+# Transform2Data
+
+A row-major affine 3x3 XY matrix applied to column vectors. Translation occupies indices 2 and 5; the final row is `[0, 0, 1]`.
+
+**Transform2Data** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`\]
+
+
+
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -0,0 +1,19 @@
+# Transform2Input
+
+An immutable XY transform or its canonical row-major matrix for interchange.
+
+**Transform2Input** = [`Transform2`](../geometry/Transform2-type.md) \| [`Transform2Data`](../geometry/Transform2Data.md)
+
+
+
+
+## Related APIs
+
+- [Transform2](Transform2.md)
+- [Transform2Data](Transform2Data.md)
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.18.0`.