@metamesh/modeling 0.12.0 → 0.14.0

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

@@ -0,0 +1,63 @@
+# sampleThreadHelices
+
+Samples evenly phased thread helices with finite `lead = pitch * starts`. All starts together respect maxPathPoints (default 100000); excessive counts fail before allocation.
+
+**sampleThreadHelices**(`options`: [`ThreadHelixOptions`](ThreadHelixOptions.md)): [`SampledThreadHelices`](SampledThreadHelices.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`ThreadHelixOptions`](ThreadHelixOptions.md) · Required
+
+- [`length`](ThreadHelixOptions.md#length) · `number` · Required
+
+  Total sampled axial length in millimetres.
+
+- [`pitch`](ThreadHelixOptions.md#pitch) · `number` · Required
+
+  Adjacent axial thread spacing in millimetres.
+
+- [`radius`](ThreadHelixOptions.md#radius) · `number` · Required
+
+  Radial distance from the +Z axis in millimetres.
+
+- [`handedness`](ThreadHelixOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](ThreadHelixOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit aggregate path allocation ceilings across all starts.
+
+- [`phaseDegrees`](ThreadHelixOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`segmentsPerTurn`](ThreadHelixOptions.md#segmentsperturn) · `number` · Optional
+
+  Angular sampling density for each revolution. Default: `32`.
+
+- [`starts`](ThreadHelixOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased helices. Default: `1`.
+
+- [`tolerance`](ThreadHelixOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+
+
+## Returns
+
+[`SampledThreadHelices`](SampledThreadHelices.md)
+
+
+## Related APIs
+
+- [SampledThreadHelices](SampledThreadHelices.md)
+- [ThreadHelixOptions](ThreadHelixOptions.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,36 @@
+# scale2
+
+Multiplies a vector by a dimensionless scalar.
+
+`const` **scale2**: (`vector`: [`Vector2Tuple`](Vector2Tuple.md), `scale`: `number`) => [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+## Parameters
+
+<a id="vector"></a>
+
+**`vector`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+
+
+
+<a id="scale"></a>
+
+**`scale`** · `number` · Required
+
+
+
+## Returns
+
+[`Vector2Tuple`](Vector2Tuple.md)
+
+
+## Related APIs
+
+- [Vector2Tuple](Vector2Tuple.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/scale3.md

@@ -0,0 +1,42 @@
+# scale3
+
+Multiplies a vector by a dimensionless scalar.
+
+`const` **scale3**: (`vector`: [`Vector3Tuple`](Vector3Tuple.md), `scale`: `number`) => [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+## Example
+
+```ts
+scale3([1, 2, 3], 2); // [2, 4, 6]
+```
+
+## Parameters
+
+<a id="vector"></a>
+
+**`vector`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
+
+
+
+<a id="scale"></a>
+
+**`scale`** · `number` · Required
+
+
+
+## Returns
+
+[`Vector3Tuple`](Vector3Tuple.md)
+
+
+## Related APIs
+
+- [Vector3Tuple](Vector3Tuple.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/scaleTransform3.md

@@ -0,0 +1,38 @@
+# scaleTransform3
+
+Creates an immutable axis-aligned scale transform.
+
+**scaleTransform3**(`factors`: [`Vector3Tuple`](Vector3Tuple.md)): [`Transform3Matrix`](Transform3Matrix.md)
+
+
+
+Negative components are reflections. Zero components are rejected because
+they collapse volume and cannot be inverted.
+
+## Parameters
+
+<a id="factors"></a>
+
+**`factors`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
+
+Finite, non-zero XYZ scale factors.
+
+
+
+## Returns
+
+[`Transform3Matrix`](Transform3Matrix.md)
+
+A frozen row-major transform.
+
+
+## Related APIs
+
+- [Transform3Matrix](Transform3Matrix.md)
+- [Vector3Tuple](Vector3Tuple.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/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.14.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 [`Vector2Tuple`](Vector2Tuple.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 [`Vector2Tuple`](Vector2Tuple.md)[]
+
+
+## Related APIs
+
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [Vector2Tuple](Vector2Tuple.md)
+
+Package: `@metamesh/modeling@0.14.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)): [`RegionData`](RegionData.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
+
+[`RegionData`](RegionData.md)
+
+
+## Related APIs
+
+- [Path2](Path2.md)
+- [RegionData](RegionData.md)
+- [StrokePathRegionOptions](StrokePathRegionOptions.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,36 @@
+# subtract2
+
+Subtracts `b` from `a` component-wise.
+
+`const` **subtract2**: (`a`: [`Vector2Tuple`](Vector2Tuple.md), `b`: [`Vector2Tuple`](Vector2Tuple.md)) => [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+## Parameters
+
+<a id="a"></a>
+
+**`a`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+
+
+
+<a id="b"></a>
+
+**`b`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+
+
+
+## Returns
+
+[`Vector2Tuple`](Vector2Tuple.md)
+
+
+## Related APIs
+
+- [Vector2Tuple](Vector2Tuple.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/subtract3.md

@@ -0,0 +1,42 @@
+# subtract3
+
+Subtracts `b` from `a`.
+
+`const` **subtract3**: (`a`: [`Vector3Tuple`](Vector3Tuple.md), `b`: [`Vector3Tuple`](Vector3Tuple.md)) => [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+## Example
+
+```ts
+subtract3([4, 5, 6], [1, 2, 3]); // [3, 3, 3]
+```
+
+## Parameters
+
+<a id="a"></a>
+
+**`a`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
+
+
+
+<a id="b"></a>
+
+**`b`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
+
+
+
+## Returns
+
+[`Vector3Tuple`](Vector3Tuple.md)
+
+
+## Related APIs
+
+- [Vector3Tuple](Vector3Tuple.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/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 [`Vector3Tuple`](Vector3Tuple.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 [`Vector3Tuple`](Vector3Tuple.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` \| [`Vector2Tuple`](Vector2Tuple.md) \| readonly [`Vector2Tuple`](Vector2Tuple.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)
+- [Vector3Tuple](Vector3Tuple.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,38 @@
+# transform2
+
+Creates an immutable XY transform, identity by default. Matrices are copied and validated. Pass it directly to Section.transform() and planar data helpers; to3D() explicitly crosses into XYZ. Zero scales and singular matrices throw GeometryError; negative scales reflect.
+
+**transform2**(`matrix?`: [`Transform2Matrix`](Transform2Matrix.md)): [`Transform2`](Transform2-type.md)
+
+
+
+## Example
+
+```ts
+const placement = transform2().rotate(90).translate([10, 0]);
+placement.applyPoint([1, 0]).toArray(); // approximately [10, 1]
+```
+
+## Parameters
+
+<a id="matrix"></a>
+
+**`matrix`** · [`Transform2Matrix`](Transform2Matrix.md) · Optional
+
+
+
+## Returns
+
+[`Transform2`](Transform2-type.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.14.0`.

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

@@ -0,0 +1,38 @@
+# transform3
+
+Creates an immutable XYZ transform, identity by default. Matrices are copied and validated. Calls apply in written order; rotations use degrees and pivots use current world coordinates. Zero scales, singular matrices, nonfinite inputs and zero rotation axes throw GeometryError. Use frameTransform3(frame) as the input for existing orthonormal frame placement.
+
+**transform3**(`matrix?`: [`Transform3Matrix`](Transform3Matrix.md)): [`Transform3`](Transform3-type.md)
+
+
+
+## Example
+
+```ts
+const placement = transform3().rotate([0, 0, 90]).translate([10, 0, 0]);
+placement.applyPoint([1, 0, 0]).toArray(); // approximately [10, 1, 0]
+```
+
+## Parameters
+
+<a id="matrix"></a>
+
+**`matrix`** · [`Transform3Matrix`](Transform3Matrix.md) · Optional
+
+
+
+## Returns
+
+[`Transform3`](Transform3-type.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/transformContour.md

@@ -0,0 +1,42 @@
+# transformContour
+
+Applies a canonical affine XY transform to a closed loop and preserves its original winding.
+
+**transformContour**(`loop`: [`Contour`](Contour.md), `transform`: [`Transform2Input`](Transform2Input.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`** · [`Transform2Input`](Transform2Input.md) · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`Contour`](Contour.md)
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Transform2Input](Transform2Input.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,36 @@
+# transformDeterminant3
+
+Returns the determinant of a transform's linear 3x3 component.
+
+**transformDeterminant3**(`transform`: [`Transform3Matrix`](Transform3Matrix.md)): `number`
+
+
+
+A negative result identifies a reflection; zero is rejected as singular.
+
+## Parameters
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform3Matrix`](Transform3Matrix.md) · Required
+
+Valid affine transform.
+
+
+
+## Returns
+
+`number`
+
+Signed linear determinant.
+
+
+## Related APIs
+
+- [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/transformPath2.md

@@ -0,0 +1,40 @@
+# transformPath2
+
+Applies a canonical affine XY transform to a 2D path without changing point order.
+
+**transformPath2**(`path`: [`Path2`](Path2.md), `transform`: [`Transform2Input`](Transform2Input.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Path2`](Path2.md)
+
+
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · [`Path2`](Path2.md) · Required
+
+
+
+<a id="transform"></a>
+
+**`transform`** · [`Transform2Input`](Transform2Input.md) · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`Path2`](Path2.md)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Path2](Path2.md)
+- [Transform2Input](Transform2Input.md)
+
+Package: `@metamesh/modeling@0.14.0`.