@metamesh/modeling 0.12.0 → 0.14.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.14.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.14.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.14.0`.

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

@@ -0,0 +1,91 @@
+# TrapezoidalThreadProfileSpec
+
+Trapezoidal thread profile with a configurable included angle.
+
+## Extends
+
+- [`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md)
+
+## Properties
+
+### pitch
+
+
+
+`readonly` **pitch**: `number`
+
+
+
+Adjacent axial thread spacing in millimetres.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`pitch`](ThreadProfileBaseSpec.md#pitch)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Optional numerical tolerance overrides.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`tolerance`](ThreadProfileBaseSpec.md#tolerance)
+
+***
+
+### kind
+
+
+
+`readonly` **kind**: `"trapezoidal"`
+
+
+
+Selects the trapezoidal profile family.
+
+***
+
+### depth?
+
+
+
+`readonly` `optional` **depth?**: `number`
+
+
+
+Radial depth in millimetres.
+
+#### Default Value
+
+`pitch / 2`
+
+***
+
+### threadAngle?
+
+
+
+`readonly` `optional` **threadAngle?**: `number`
+
+
+
+Included flank angle in degrees. Use `90` for printable 45-degree slopes.
+
+#### Default Value
+
+`30`
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,34 @@
+# TriangleMesh
+
+A topology-preserving indexed triangle mesh with XYZ vertex positions.
+
+## Extended by
+
+- [`GeometryResource`](../engine/GeometryResource.md)
+- [`ExportMeshPart`](../engine/ExportMeshPart.md)
+
+## Properties
+
+### indices
+
+
+
+`readonly` **indices**: `Uint32Array`
+
+
+
+Three unsigned vertex indices per triangle.
+
+***
+
+### positions
+
+
+
+`readonly` **positions**: `Float32Array`
+
+
+
+Flat XYZ coordinates, three finite values per vertex.
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,119 @@
+# TriangleMeshAnalysis
+
+Measurements and optional edge-connected topology from one validated mesh traversal.
+
+## Extends
+
+- [`TriangleMeshMeasurements`](TriangleMeshMeasurements.md)
+
+## Properties
+
+### connectedComponentCount?
+
+
+
+`readonly` `optional` **connectedComponentCount?**: `number`
+
+
+
+Number of referenced edge-connected components when `includeTopology` is requested.
+
+***
+
+### edgeCount?
+
+
+
+`readonly` `optional` **edgeCount?**: `number`
+
+
+
+Number of distinct indexed undirected edges when `includeTopology` is requested.
+
+***
+
+### bounds
+
+
+
+`readonly` **bounds**: [`Bounds3`](Bounds3.md)
+
+
+
+Axis-aligned bounds.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`bounds`](TriangleMeshMeasurements.md#bounds)
+
+***
+
+### signedVolume
+
+
+
+`readonly` **signedVolume**: `number`
+
+
+
+Signed enclosed volume; positive values correspond to outward winding.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`signedVolume`](TriangleMeshMeasurements.md#signedvolume)
+
+***
+
+### surfaceArea
+
+
+
+`readonly` **surfaceArea**: `number`
+
+
+
+Sum of all triangle areas in squared model units.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`surfaceArea`](TriangleMeshMeasurements.md#surfacearea)
+
+***
+
+### triangleCount
+
+
+
+`readonly` **triangleCount**: `number`
+
+
+
+Number of indexed triangles.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`triangleCount`](TriangleMeshMeasurements.md#trianglecount)
+
+***
+
+### vertexCount
+
+
+
+`readonly` **vertexCount**: `number`
+
+
+
+Number of distinct entries in the position buffer.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`vertexCount`](TriangleMeshMeasurements.md#vertexcount)
+
+
+## Related APIs
+
+- [Bounds3](Bounds3.md)
+- [TriangleMeshMeasurements](TriangleMeshMeasurements.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,75 @@
+# TriangleMeshAnalysisOptions
+
+Validation and optional connectivity controls for a shared mesh analysis.
+
+## Extends
+
+- [`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md)
+
+## Properties
+
+### includeTopology?
+
+
+
+`readonly` `optional` **includeTopology?**: `boolean`
+
+
+
+Compute indexed edge/component counts and reject unreferenced vertices; defaults to false.
+
+***
+
+### allowEmpty?
+
+
+
+`readonly` `optional` **allowEmpty?**: `boolean`
+
+
+
+Permit an empty position and index buffer. Defaults to `false`.
+
+#### Inherited from
+
+[`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md).[`allowEmpty`](TriangleMeshValidationOptions.md#allowempty)
+
+***
+
+### requireClosed?
+
+
+
+`readonly` `optional` **requireClosed?**: `boolean`
+
+
+
+Require two oppositely wound faces per edge; geometric self-intersections are not detected.
+
+#### Inherited from
+
+[`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md).[`requireClosed`](TriangleMeshValidationOptions.md#requireclosed)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Numeric comparison overrides used for zero-area triangle detection.
+
+#### Inherited from
+
+[`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md).[`tolerance`](TriangleMeshValidationOptions.md#tolerance)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [TriangleMeshValidationOptions](TriangleMeshValidationOptions.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,75 @@
+# TriangleMeshMeasurements
+
+Geometric measurements derived from a validated, non-empty triangle mesh.
+
+## Extended by
+
+- [`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
+
+## Properties
+
+### bounds
+
+
+
+`readonly` **bounds**: [`Bounds3`](Bounds3.md)
+
+
+
+Axis-aligned bounds.
+
+***
+
+### signedVolume
+
+
+
+`readonly` **signedVolume**: `number`
+
+
+
+Signed enclosed volume; positive values correspond to outward winding.
+
+***
+
+### surfaceArea
+
+
+
+`readonly` **surfaceArea**: `number`
+
+
+
+Sum of all triangle areas in squared model units.
+
+***
+
+### triangleCount
+
+
+
+`readonly` **triangleCount**: `number`
+
+
+
+Number of indexed triangles.
+
+***
+
+### vertexCount
+
+
+
+`readonly` **vertexCount**: `number`
+
+
+
+Number of distinct entries in the position buffer.
+
+
+## Related APIs
+
+- [Bounds3](Bounds3.md)
+- [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
+
+Package: `@metamesh/modeling@0.14.0`.