@metamesh/modeling 0.12.0 → 0.13.0

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

@@ -0,0 +1,34 @@
+# scaleTransform3
+
+Creates an immutable axis-aligned scale transform.
+
+**scaleTransform3**(`factors`: [`Vector3`](Vector3.md)): [`Transform3`](Transform3.md)
+
+
+
+Negative components are reflections. Zero components are rejected because
+they collapse volume and cannot be inverted.
+
+## Parameters
+
+<a id="factors"></a>
+
+**`factors`** · [`Vector3`](Vector3.md) · Required
+
+Finite, non-zero XYZ scale factors.
+
+
+
+## Returns
+
+[`Transform3`](Transform3.md)
+
+A frozen row-major transform.
+
+
+## Related APIs
+
+- [Transform3](Transform3.md)
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,26 @@
+# signedContourArea
+
+Returns the signed area of a non-duplicated loop; positive means CCW.
+
+**signedContourArea**(`loop`: [`Contour`](Contour.md)): `number`
+
+
+
+## Parameters
+
+<a id="loop"></a>
+
+**`loop`** · [`Contour`](Contour.md) · Required
+
+
+
+## Returns
+
+`number`
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,51 @@
+# starContour
+
+Creates a centered CCW alternating-radius star within the selected profile sampling ceiling.
+
+`const` **starContour**: (`outerRadius`: `number`, `points`: `number`, `innerRadius?`: `number`, `limits?`: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>) => readonly [`Vector2`](Vector2.md)[]
+
+
+
+## Example: Five-point outline
+
+```ts
+starContour(12, 5, 6);
+```
+
+## Parameters
+
+<a id="outerradius"></a>
+
+**`outerRadius`** · `number` · Required
+
+
+
+<a id="points"></a>
+
+**`points`** · `number` · Required
+
+
+
+<a id="innerradius"></a>
+
+**`innerRadius`** · `number` · Optional
+
+
+
+<a id="limits"></a>
+
+**`limits`** · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+
+
+## Returns
+
+readonly [`Vector2`](Vector2.md)[]
+
+
+## Related APIs
+
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,63 @@
+# strokePathRegion
+
+Converts a sampled millimetre path into the filled region covered by a centered stroke.
+
+**strokePathRegion**(`path`: [`Path2`](Path2.md), `options`: [`StrokePathRegionOptions`](StrokePathRegionOptions.md)): [`Region`](Region.md)
+
+
+
+Closed paths omit a duplicated seam point. Zero-length sampled segments are ignored, while the
+effective path must still contain visible length. Round caps and joins use deterministic physical
+resolution. Bevels fill the outer corner triangle; miters extend the outer edges to their
+intersection, falling back to bevels above SVG's default miter limit of 4.
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · [`Path2`](Path2.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`StrokePathRegionOptions`](StrokePathRegionOptions.md) · Required
+
+- [`width`](StrokePathRegionOptions.md#width) · `number` · Required
+
+  Positive total stroke width in millimetres, centered on the sampled path.
+
+- [`limits`](StrokePathRegionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit path, circular and expanded-profile allocation ceilings.
+
+- [`closed`](StrokePathRegionOptions.md#closed) · `boolean` · Optional
+
+  Treat the path as a closed non-duplicated loop. Default: `false`.
+
+- [`cap`](StrokePathRegionOptions.md#cap) · [`StrokePathCap`](StrokePathCap.md) · Optional
+
+  End-cap treatment for an open path. Ignored for closed paths. Default: `butt`.
+
+- [`join`](StrokePathRegionOptions.md#join) · [`StrokePathJoin`](StrokePathJoin.md) · Optional
+
+  Corner treatment; miters exceeding SVG's default limit of 4 become bevels. Default: `miter`.
+
+- [`resolution`](StrokePathRegionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Physical tessellation policy for round caps and joins.
+
+
+
+## Returns
+
+[`Region`](Region.md)
+
+
+## Related APIs
+
+- [Path2](Path2.md)
+- [Region](Region.md)
+- [StrokePathRegionOptions](StrokePathRegionOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,38 @@
+# subtract3
+
+Subtracts `b` from `a`.
+
+`const` **subtract3**: (`a`: [`Vector3`](Vector3.md), `b`: [`Vector3`](Vector3.md)) => [`Vector3`](Vector3.md)
+
+
+
+## Example
+
+```ts
+subtract3([4, 5, 6], [1, 2, 3]); // [3, 3, 3]
+```
+
+## Parameters
+
+<a id="a"></a>
+
+**`a`** · [`Vector3`](Vector3.md) · Required
+
+
+
+<a id="b"></a>
+
+**`b`** · [`Vector3`](Vector3.md) · Required
+
+
+
+## Returns
+
+[`Vector3`](Vector3.md)
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,82 @@
+# sweepMesh
+
+Sweeps one explicitly ordered point loop, with caps or a geometrically matching closed seam.
+
+**sweepMesh**(`profile`: [`Contour`](Contour.md), `path`: readonly [`Vector3`](Vector3.md)[], `options?`: [`SweepOptions`](SweepOptions.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+## Example: Sweep point data along a bent path
+
+```ts
+const profile = rectangleContour({ size: [6, 3] });
+sweepMesh(profile, [[0, 0, 0], [0, 0, 15], [10, 0, 25]], {
+  orientation: { kind: "transport", initialNormal: [0, 1, 0] },
+});
+```
+
+## Parameters
+
+<a id="profile"></a>
+
+**`profile`** · [`Contour`](Contour.md) · Required
+
+
+
+<a id="path"></a>
+
+**`path`** · readonly [`Vector3`](Vector3.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SweepOptions`](SweepOptions.md) · Optional
+
+- [`closed`](SweepOptions.md#closed) · `boolean` · Optional
+
+  Join the path's last station to its first. Open paths retain watertight end caps.
+
+- [`limits`](SweepOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling allocation ceilings.
+
+- [`orientation`](SweepOptions.md#orientation) · [`SweepOrientation`](SweepOrientation.md) · Optional
+
+  Explicit frame policy; default transport minimizes rotations, initially projecting +X then +Y then +Z.
+
+- [`resolution`](SweepOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Physical sampling of nonzero twist; inserted stations retain authored station controls.
+
+- [`twistDegrees`](SweepOptions.md#twistdegrees) · `number` · Optional
+
+  Total additional profile rotation in degrees, with progression selected by twistBy.
+
+- [`twistBy`](SweepOptions.md#twistby) · `"length"` \| `"stations"` · Optional
+
+  Twist advances by physical path length (default), or normalized authored station position, including a closed seam gap.
+
+- [`scale`](SweepOptions.md#scale) · `number` \| [`Vector2`](Vector2.md) \| readonly [`Vector2`](Vector2.md)[] · Optional
+
+  Positive uniform/XY scale, or one XY pair per path station. Defaults to one.
+
+- [`seamProfileOffset`](SweepOptions.md#seamprofileoffset) · `number` · Optional
+
+  Corresponding point-index advance at a rotationally equivalent closed seam.
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+- [SweepOptions](SweepOptions.md)
+- [TriangleMesh](TriangleMesh.md)
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,42 @@
+# transformContour
+
+Transforms a closed loop and preserves its original winding convention.
+
+**transformContour**(`loop`: [`Contour`](Contour.md), `transform`: [`Transform3`](Transform3.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Contour`](Contour.md)
+
+
+
+Reflections reverse the point order automatically through normalization.
+
+## Parameters
+
+<a id="loop"></a>
+
+**`loop`** · [`Contour`](Contour.md) · Required
+
+
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`Contour`](Contour.md)
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,32 @@
+# transformDeterminant3
+
+Returns the determinant of a transform's linear 3x3 component.
+
+**transformDeterminant3**(`transform`: [`Transform3`](Transform3.md)): `number`
+
+
+
+A negative result identifies a reflection; zero is rejected as singular.
+
+## Parameters
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+Valid affine transform.
+
+
+
+## Returns
+
+`number`
+
+Signed linear determinant.
+
+
+## Related APIs
+
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,40 @@
+# transformPath2
+
+Applies an XY-plane-preserving affine transform to a 2D path.
+
+**transformPath2**(`path`: [`Path2`](Path2.md), `transform`: [`Transform3`](Transform3.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Path2`](Path2.md)
+
+
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · [`Path2`](Path2.md) · Required
+
+
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`Path2`](Path2.md)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Path2](Path2.md)
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,33 @@
+# transformPath3
+
+Applies an affine transform to a 3D path without mutating its points.
+
+**transformPath3**(`path`: [`Path3`](Path3.md), `transform`: [`Transform3`](Transform3.md)): [`Path3`](Path3.md)
+
+
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · [`Path3`](Path3.md) · Required
+
+
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+
+
+## Returns
+
+[`Path3`](Path3.md)
+
+
+## Related APIs
+
+- [Path3](Path3.md)
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,40 @@
+# transformRegion
+
+Transforms an explicit outer/hole region with reflection-safe winding correction.
+
+**transformRegion**(`region`: [`Region`](Region.md), `transform`: [`Transform3`](Transform3.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Region`](Region.md)
+
+
+
+## Parameters
+
+<a id="region"></a>
+
+**`region`** · [`Region`](Region.md) · Required
+
+
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`Region`](Region.md)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Region](Region.md)
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,42 @@
+# transformTriangleMesh
+
+Applies an affine transform to a mesh and preserves outward face orientation.
+
+**transformTriangleMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `transform`: [`Transform3`](Transform3.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+A transform with a negative linear determinant reflects space, so this helper
+automatically reverses every triangle. Singular transforms are rejected.
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+Mesh to transform without mutation.
+
+
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+Row-major affine transform.
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+A mesh with fresh transformed positions and copied or reversed indices.
+
+
+## Related APIs
+
+- [Transform3](Transform3.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,31 @@
+# translationTransform3
+
+Creates an immutable translation transform.
+
+**translationTransform3**(`offset`: [`Vector3`](Vector3.md)): [`Transform3`](Transform3.md)
+
+
+
+## Parameters
+
+<a id="offset"></a>
+
+**`offset`** · [`Vector3`](Vector3.md) · Required
+
+Finite XYZ translation in model units.
+
+
+
+## Returns
+
+[`Transform3`](Transform3.md)
+
+A frozen row-major transform.
+
+
+## Related APIs
+
+- [Transform3](Transform3.md)
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,26 @@
+# triangulateContour
+
+Ear-clips one normalized simple CCW loop into stable local vertex indices.
+
+**triangulateContour**(`loop`: [`Contour`](Contour.md)): `Uint32Array`
+
+
+
+## Parameters
+
+<a id="loop"></a>
+
+**`loop`** · [`Contour`](Contour.md) · Required
+
+
+
+## Returns
+
+`Uint32Array`
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,52 @@
+# validateSolidMesh
+
+Checks closed indexed topology, triangle intersections, and alternating nested shell orientation. Outward exterior shells and inward cavity shells are accepted. Separate shells must not touch, intersect, or overlap as material. Indexed neighbours may share their own vertex or edge.
+
+**validateSolidMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`SolidMeshValidationOptions`](SolidMeshValidationOptions.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+Uses bounded floating-point tests, not exact predicates or repair. Contacts within the selected
+tolerance reject conservatively. At most 200,000 triangles and 2,000,000 spatial/containment tests
+are supported; exhausting a ceiling throws COMPLEXITY_LIMIT rather than claiming validity.
+Input buffers are freshly inspected and never modified; units are millimetres.
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+Closed triangle mesh to inspect.
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SolidMeshValidationOptions`](SolidMeshValidationOptions.md) · Optional
+
+Optional lower work ceiling and numeric comparison policy.
+
+- [`maximumTests`](SolidMeshValidationOptions.md#maximumtests) · `number` · Optional
+
+  Work ceiling for spatial comparisons and containment tests; defaults to 2,000,000 and may only lower it.
+
+- [`tolerance`](SolidMeshValidationOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Distance comparison policy in millimetres; near contacts reject conservatively.
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+The original mesh after every requested check succeeds.
+
+
+## Related APIs
+
+- [SolidMeshValidationOptions](SolidMeshValidationOptions.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,43 @@
+# validateTransform3
+
+Validates that a transform is finite, affine, and non-singular.
+
+**validateTransform3**(`transform`: [`Transform3`](Transform3.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Transform3`](Transform3.md)
+
+
+
+## Parameters
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3`](Transform3.md) · Required
+
+Row-major matrix to validate.
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+Optional comparison overrides.
+
+
+
+## Returns
+
+[`Transform3`](Transform3.md)
+
+The original transform after successful validation.
+
+
+## Throws
+
+- GeometryError For non-finite, non-affine, or singular matrices.
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Transform3](Transform3.md)
+
+Package: `@metamesh/modeling@0.13.0`.