@metamesh/modeling 0.13.0 → 0.15.0

package/dist/docs/reference/geometry/Transform2-type.md

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

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

@@ -0,0 +1,19 @@
+# Transform2Input
+
+An immutable XY transform or its canonical row-major matrix for interchange.
+
+**Transform2Input** = [`Transform2`](Transform2-type.md) \| [`Transform2Matrix`](Transform2Matrix.md)
+
+
+
+
+## Related APIs
+
+- [Transform2](Transform2-type.md)
+- [Transform2Matrix](Transform2Matrix.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,14 @@
+# Transform2Matrix
+
+A row-major affine 3x3 XY matrix applied to column vectors. Translation occupies indices 2 and 5; the final row is `[0, 0, 1]`.
+
+**Transform2Matrix** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`\]
+
+
+
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.15.0`.

package/dist/docs/reference/geometry/Transform3-type.md

@@ -0,0 +1,295 @@
+# Transform3
+
+Immutable reusable XYZ placement. Methods apply in written order; angles are degrees.
+
+## Methods
+
+### translate()
+
+
+
+**translate**(`offset`: [`Vector3Input`](Vector3Input.md)): `Transform3`
+
+
+
+Applies a translation in model units after this placement.
+
+#### Parameters
+
+<a id="offset"></a>
+
+**`offset`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+`Transform3`
+
+***
+
+### rotate()
+
+
+
+**rotate**(`degrees`: [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
+
+
+
+Rotates about global X, then Y, then Z in degrees, about an optional world-space pivot.
+
+#### Parameters
+
+<a id="degrees"></a>
+
+**`degrees`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
+
+- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Transform3`
+
+***
+
+### rotateAxis()
+
+
+
+**rotateAxis**(`axis`: [`Vector3Input`](Vector3Input.md), `degrees`: `number`, `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
+
+
+
+Rotates right-handed in degrees about a nonzero axis and optional world-space pivot.
+
+#### Parameters
+
+<a id="axis"></a>
+
+**`axis`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+<a id="degrees-1"></a>
+
+**`degrees`** · `number` · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
+
+- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Transform3`
+
+***
+
+### scale()
+
+
+
+**scale**(`factors`: `number` \| [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
+
+
+
+Scales about an optional world-space pivot; finite nonzero factors may reflect.
+
+#### Parameters
+
+<a id="factors"></a>
+
+**`factors`** · `number` \| [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+<a id="options-2"></a>
+
+**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
+
+- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Transform3`
+
+***
+
+### andThen()
+
+
+
+**andThen**(`next`: [`Transform3Input`](Transform3Input.md)): `Transform3`
+
+
+
+Applies this placement first, then `next`; equivalent to composeTransform3(next, current).
+
+#### Parameters
+
+<a id="next"></a>
+
+**`next`** · [`Transform3Input`](Transform3Input.md) · Required
+
+
+
+#### Returns
+
+`Transform3`
+
+***
+
+### inverse()
+
+
+
+**inverse**(): `Transform3`
+
+
+
+Returns the inverse; singular and numerically unstable transforms throw GeometryError.
+
+#### Returns
+
+`Transform3`
+
+***
+
+### applyPoint()
+
+
+
+**applyPoint**(`point`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
+
+
+
+Transforms a finite point, including translation. Returns a fresh immutable vector.
+
+#### Parameters
+
+<a id="point"></a>
+
+**`point`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector3`](Vector3-type.md)
+
+***
+
+### applyDirection()
+
+
+
+**applyDirection**(`direction`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
+
+
+
+Transforms a finite direction, excluding translation and retaining scale. This is not a normal transform.
+
+#### Parameters
+
+<a id="direction"></a>
+
+**`direction`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector3`](Vector3-type.md)
+
+***
+
+### applyNormal()
+
+
+
+**applyNormal**(`normal`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
+
+
+
+Applies the inverse transpose and normalizes. Ignores translation; rejects zero normals.
+
+#### Parameters
+
+<a id="normal"></a>
+
+**`normal`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector3`](Vector3-type.md)
+
+***
+
+### toMatrix()
+
+
+
+**toMatrix**(): [`Transform3Matrix`](Transform3Matrix.md)
+
+
+
+Returns the frozen canonical row-major 4x4 matrix for interchange.
+
+#### Returns
+
+[`Transform3Matrix`](Transform3Matrix.md)
+
+***
+
+### to2D()
+
+
+
+**to2D**(): [`Transform2`](Transform2-type.md)
+
+
+
+Restricts to XY; throws GeometryError for a plane change or singular XY restriction.
+
+#### Returns
+
+[`Transform2`](Transform2-type.md)
+
+
+## Related APIs
+
+- [Pivot3Options](Pivot3Options.md)
+- [Transform2](Transform2-type.md)
+- [Transform3Input](Transform3Input.md)
+- [Transform3Matrix](Transform3Matrix.md)
+- [Vector3](Vector3-type.md)
+- [Vector3Input](Vector3Input.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,19 @@
+# Transform3Input
+
+An immutable XYZ transform or its canonical row-major matrix for interchange.
+
+**Transform3Input** = [`Transform3`](Transform3-type.md) \| [`Transform3Matrix`](Transform3Matrix.md)
+
+
+
+
+## Related APIs
+
+- [Transform3](Transform3-type.md)
+- [Transform3Matrix](Transform3Matrix.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,17 @@
+# Transform3Matrix
+
+A row-major affine 4x4 matrix applied to column vectors.
+
+**Transform3Matrix** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m03`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m13`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`, `m23`: `number`, `m30`: `number`, `m31`: `number`, `m32`: `number`, `m33`: `number`\]
+
+
+
+Translation occupies indices 3, 7, and 11. The final row must be
+`[0, 0, 0, 1]` within the active geometry tolerance.
+
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -68,15 +68,16 @@ Radial depth in millimetres.
 
 ***
 
-### threadAngle?
+### includedAngle?
 
 
 
-`readonly` `optional` **threadAngle?**: `number`
+`readonly` `optional` **includedAngle?**: `number`
 
 
 
-Included flank angle in degrees. Use `90` for printable 45-degree slopes.
+Full angle between the flanks in degrees, from `0` inclusive to `180` exclusive.
+Each flank uses half this angle from the radial direction; `90` gives 45-degree slopes.
 
 #### Default Value
 
@@ -88,4 +89,4 @@ Included flank angle in degrees. Use `90` for printable 45-degree slopes.
 - [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -31,4 +31,4 @@ Three unsigned vertex indices per triangle.
 
 Flat XYZ coordinates, three finite values per vertex.
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -16,7 +16,7 @@ Measurements and optional edge-connected topology from one validated mesh traver
 
 
 
-Number of referenced edge-connected components when `includeTopology` is requested.
+Number of referenced edge-connected boundary shells when `includeTopology` is requested; cavities count separately.
 
 ***
 
@@ -116,4 +116,4 @@ Number of distinct entries in the position buffer.
 - [Bounds3](Bounds3.md)
 - [TriangleMeshMeasurements](TriangleMeshMeasurements.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -72,4 +72,4 @@ Numeric comparison overrides used for zero-area triangle detection.
 - [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [TriangleMeshValidationOptions](TriangleMeshValidationOptions.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -72,4 +72,4 @@ Number of distinct entries in the position buffer.
 - [Bounds3](Bounds3.md)
 - [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -8,11 +8,11 @@ Options controlling bounded triangle-mesh quality analysis.
 
 ## Properties
 
-### maximumTriangleCount?
+### maxTriangles?
 
 
 
-`readonly` `optional` **maximumTriangleCount?**: `number`
+`readonly` `optional` **maxTriangles?**: `number`
 
 
 
@@ -36,4 +36,4 @@ Numeric comparison overrides; model coordinates are interpreted in their existin
 - [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [PlanarMeshOptimizationOptions](PlanarMeshOptimizationOptions.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -187,4 +187,4 @@ Number of entries in the position buffer.
 
 - [PlanarPatchQuality](PlanarPatchQuality.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.