@metamesh/modeling 0.13.0 → 0.15.0

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

@@ -15,4 +15,4 @@ responsibilities.
 
 - [MetricFastenerStandard](MetricFastenerStandard.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -32,4 +32,4 @@ Explicit per-profile and circular ceilings; the family also has a one-million-sl
 - [GeometryResolution](GeometryResolution.md)
 - [GeometrySamplingLimits](GeometrySamplingLimits.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -4,4 +4,4 @@ Metric fastener sizes included in the first mechanical standards table.
 
 **MetricFastenerSize** = `"M2"` \| `"M2.5"` \| `"M3"` \| `"M4"` \| `"M5"` \| `"M6"` \| `"M8"` \| `"M10"` \| `"M12"`
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -69,4 +69,4 @@ Socket-head cap screw envelope and drive size.
 - [MetricHexNutDimensions](MetricHexNutDimensions.md)
 - [MetricSocketCapHeadDimensions](MetricSocketCapHeadDimensions.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -26,4 +26,4 @@ Nominal wrench size across flats.
 
 Nominal full-nut thickness.
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -38,4 +38,4 @@ Nominal head height.
 
 Nominal internal hex key size across flats.
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -123,4 +123,4 @@ Maximum unique transferable output backing-buffer bytes.
 
 - [GeometrySamplingLimits](GeometrySamplingLimits.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -14,4 +14,4 @@ calibrate them for its printer, material, layer height, and thread scale.
 
 - [PrintableThreadFitPolicy](PrintableThreadFitPolicy.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,192 @@
+# Path2
+
+Immutable directed XY polyline. Closure is explicit and does not imply a filled Section.
+
+## Properties
+
+### dimension
+
+
+
+`readonly` **dimension**: `2`
+
+
+
+Coordinate dimension; identifies planar paths even when empty.
+
+***
+
+### closed
+
+
+
+`readonly` **closed**: `boolean`
+
+
+
+Whether traversal includes the last-to-first edge.
+
+## Methods
+
+### toArray()
+
+
+
+**toArray**(): [`Path2Data`](Path2Data.md)
+
+
+
+Returns frozen tuple coordinates; closure remains separate metadata. Repeated calls do not allocate.
+
+#### Returns
+
+[`Path2Data`](Path2Data.md)
+
+***
+
+### length()
+
+
+
+**length**(): `number`
+
+
+
+Total sampled edge length in model units, including the closing edge when closed.
+
+#### Returns
+
+`number`
+
+***
+
+### bounds()
+
+
+
+**bounds**(): [`Bounds2`](Bounds2.md) \| `undefined`
+
+
+
+Axis-aligned bounds, or undefined for an empty path.
+
+#### Returns
+
+[`Bounds2`](Bounds2.md) \| `undefined`
+
+***
+
+### closestPoint()
+
+
+
+**closestPoint**(`point`: [`Vector2Input`](Vector2Input.md)): [`PathLocation`](PathLocation.md)\<[`Vector2`](Vector2-type.md)\>
+
+
+
+Finds the nearest edge location; requires at least two vertices.
+
+#### Parameters
+
+<a id="point"></a>
+
+**`point`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+[`PathLocation`](PathLocation.md)\<[`Vector2`](Vector2-type.md)\>
+
+***
+
+### transform()
+
+
+
+**transform**(`placement`: [`Transform2Input`](Transform2Input.md)): `Path2`
+
+
+
+Applies an XY placement without reordering traversal, including after reflection.
+
+#### Parameters
+
+<a id="placement"></a>
+
+**`placement`** · [`Transform2Input`](Transform2Input.md) · Required
+
+
+
+#### Returns
+
+`Path2`
+
+***
+
+### reverse()
+
+
+
+**reverse**(): `Path2`
+
+
+
+Reverses vertex order and traversal; neither the source nor its coordinates are mutated.
+
+#### Returns
+
+`Path2`
+
+***
+
+### resample()
+
+
+
+**resample**(`options?`: [`PathResamplingOptions`](PathResamplingOptions.md)): `Path2`
+
+
+
+Returns a path sampled at equal arc lengths. Corners may be bridged; closure is preserved.
+
+#### Parameters
+
+<a id="options"></a>
+
+**`options`** · [`PathResamplingOptions`](PathResamplingOptions.md) · Optional
+
+- [`resolution`](PathResamplingOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Millimetre sampling policy; circularSegments applies only to arcs.
+
+- [`maxVertices`](PathResamplingOptions.md#maxvertices) · `number` · Optional
+
+  Output vertex ceiling of at least two; may only lower limits.maxPathPoints.
+
+- [`limits`](PathResamplingOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings; omitted values use package defaults without ambient state.
+
+- [`segments`](PathResamplingOptions.md#segments) · `number` · Optional
+
+  Exact arc-length intervals; closed paths need at least three. Otherwise physical resolution or the effective source edge count controls sampling.
+
+
+
+#### Returns
+
+`Path2`
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [Path2Data](Path2Data.md)
+- [PathLocation](PathLocation.md)
+- [PathResamplingOptions](PathResamplingOptions.md)
+- [Transform2Input](Transform2Input.md)
+- [Vector2](Vector2-type.md)
+- [Vector2Input](Vector2Input.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,14 @@
+# Path2Data
+
+XY point tuples for interchange; closure is supplied by the consuming operation or Path2 value.
+
+**Path2Data** = readonly [`Vector2Tuple`](Vector2Tuple.md)[]
+
+
+
+
+## Related APIs
+
+- [Vector2Tuple](Vector2Tuple.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,15 @@
+# Path2Input
+
+An immutable XY sampled path or a collection of XY tuples and fluent vectors.
+
+**Path2Input** = [`Path2`](Path2-type.md) \| readonly [`Vector2Input`](Vector2Input.md)[]
+
+
+
+
+## Related APIs
+
+- [Path2](Path2-type.md)
+- [Vector2Input](Vector2Input.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,192 @@
+# Path3
+
+Immutable directed XYZ polyline; it represents sampled edges, not an analytic curve.
+
+## Properties
+
+### dimension
+
+
+
+`readonly` **dimension**: `3`
+
+
+
+Coordinate dimension; identifies spatial paths even when empty.
+
+***
+
+### closed
+
+
+
+`readonly` **closed**: `boolean`
+
+
+
+Whether traversal includes the last-to-first edge.
+
+## Methods
+
+### toArray()
+
+
+
+**toArray**(): [`Path3Data`](Path3Data.md)
+
+
+
+Returns frozen tuple coordinates; closure remains separate metadata. Repeated calls do not allocate.
+
+#### Returns
+
+[`Path3Data`](Path3Data.md)
+
+***
+
+### length()
+
+
+
+**length**(): `number`
+
+
+
+Total sampled edge length in model units, including the closing edge when closed.
+
+#### Returns
+
+`number`
+
+***
+
+### bounds()
+
+
+
+**bounds**(): [`Bounds3`](Bounds3.md) \| `undefined`
+
+
+
+Axis-aligned bounds, or undefined for an empty path.
+
+#### Returns
+
+[`Bounds3`](Bounds3.md) \| `undefined`
+
+***
+
+### closestPoint()
+
+
+
+**closestPoint**(`point`: [`Vector3Input`](Vector3Input.md)): [`PathLocation`](PathLocation.md)\<[`Vector3`](Vector3-type.md)\>
+
+
+
+Finds the nearest edge location; requires at least two vertices.
+
+#### Parameters
+
+<a id="point"></a>
+
+**`point`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+[`PathLocation`](PathLocation.md)\<[`Vector3`](Vector3-type.md)\>
+
+***
+
+### transform()
+
+
+
+**transform**(`placement`: [`Transform3Input`](Transform3Input.md)): `Path3`
+
+
+
+Applies an XYZ placement without changing traversal order or closure.
+
+#### Parameters
+
+<a id="placement"></a>
+
+**`placement`** · [`Transform3Input`](Transform3Input.md) · Required
+
+
+
+#### Returns
+
+`Path3`
+
+***
+
+### reverse()
+
+
+
+**reverse**(): `Path3`
+
+
+
+Reverses vertex order and traversal without mutating the source.
+
+#### Returns
+
+`Path3`
+
+***
+
+### resample()
+
+
+
+**resample**(`options?`: [`PathResamplingOptions`](PathResamplingOptions.md)): `Path3`
+
+
+
+Returns a path sampled at equal arc lengths. Corners may be bridged; closure is preserved.
+
+#### Parameters
+
+<a id="options"></a>
+
+**`options`** · [`PathResamplingOptions`](PathResamplingOptions.md) · Optional
+
+- [`resolution`](PathResamplingOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Millimetre sampling policy; circularSegments applies only to arcs.
+
+- [`maxVertices`](PathResamplingOptions.md#maxvertices) · `number` · Optional
+
+  Output vertex ceiling of at least two; may only lower limits.maxPathPoints.
+
+- [`limits`](PathResamplingOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings; omitted values use package defaults without ambient state.
+
+- [`segments`](PathResamplingOptions.md#segments) · `number` · Optional
+
+  Exact arc-length intervals; closed paths need at least three. Otherwise physical resolution or the effective source edge count controls sampling.
+
+
+
+#### Returns
+
+`Path3`
+
+
+## Related APIs
+
+- [Bounds3](Bounds3.md)
+- [Path3Data](Path3Data.md)
+- [PathLocation](PathLocation.md)
+- [PathResamplingOptions](PathResamplingOptions.md)
+- [Transform3Input](Transform3Input.md)
+- [Vector3](Vector3-type.md)
+- [Vector3Input](Vector3Input.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,14 @@
+# Path3Data
+
+XYZ point tuples for interchange; closure is supplied by the consuming operation or Path3 value.
+
+**Path3Data** = readonly [`Vector3Tuple`](Vector3Tuple.md)[]
+
+
+
+
+## Related APIs
+
+- [Vector3Tuple](Vector3Tuple.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,15 @@
+# Path3Input
+
+An immutable XYZ sampled path or a collection of XYZ tuples and fluent vectors.
+
+**Path3Input** = [`Path3`](Path3-type.md) \| readonly [`Vector3Input`](Vector3Input.md)[]
+
+
+
+
+## Related APIs
+
+- [Path3](Path3-type.md)
+- [Vector3Input](Vector3Input.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -8,7 +8,7 @@ Orthonormal right-handed frame sampled along a path.
 
 
 
-`readonly` **tangent**: [`Vector3`](Vector3.md)
+`readonly` **tangent**: [`Vector3Tuple`](Vector3Tuple.md)
 
 
 
@@ -20,7 +20,7 @@ Unit path tangent.
 
 
 
-`readonly` **normal**: [`Vector3`](Vector3.md)
+`readonly` **normal**: [`Vector3Tuple`](Vector3Tuple.md)
 
 
 
@@ -32,7 +32,7 @@ Unit transported profile X axis.
 
 
 
-`readonly` **binormal**: [`Vector3`](Vector3.md)
+`readonly` **binormal**: [`Vector3Tuple`](Vector3Tuple.md)
 
 
 
@@ -41,6 +41,6 @@ Unit profile Y axis equal to tangent × normal.
 
 ## Related APIs
 
-- [Vector3](Vector3.md)
+- [Vector3Tuple](Vector3Tuple.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,65 @@
+# PathLocation
+
+Nearest location on a sampled boundary, rather than inside a filled shape or on an analytic curve.
+
+## Type Parameters
+
+### Point
+
+`Point` *extends* [`Vector2`](Vector2-type.md) \| [`Vector3`](Vector3-type.md)
+
+## Properties
+
+### point
+
+
+
+`readonly` **point**: `Point`
+
+
+
+Immutable position on the selected edge.
+
+***
+
+### distance
+
+
+
+`readonly` **distance**: `number`
+
+
+
+Euclidean distance from the query in model units.
+
+***
+
+### edgeIndex
+
+
+
+`readonly` **edgeIndex**: `number`
+
+
+
+Starting vertex of the selected edge; ties keep the first edge in traversal order.
+
+***
+
+### fraction
+
+
+
+`readonly` **fraction**: `number`
+
+
+
+Clamped fraction along that edge, not the whole path's normalized arc length.
+
+
+## Related APIs
+
+- [Vector2](Vector2-type.md)
+- [Vector3](Vector3-type.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -2,7 +2,7 @@
 
 Supplies a profile-X orientation guide for each original normalized sweep station.
 
-**PathNormalGuide** = (`point`: [`Vector3`](Vector3.md), `index`: `number`) => [`Vector3`](Vector3.md)
+**PathNormalGuide** = (`point`: [`Vector3Tuple`](Vector3Tuple.md), `index`: `number`) => [`Vector3Input`](Vector3Input.md)
 
 
 
@@ -10,7 +10,7 @@ Supplies a profile-X orientation guide for each original normalized sweep statio
 
 <a id="point"></a>
 
-**`point`** · [`Vector3`](Vector3.md) · Required
+**`point`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
 
 Current XYZ path point in model units.
 
@@ -26,13 +26,14 @@ Zero-based index of `point` in the normalized authored sweep path.
 
 ## Returns
 
-[`Vector3`](Vector3.md)
+[`Vector3Input`](Vector3Input.md)
 
 A finite guide vector that is not parallel to the local path tangent.
 
 
 ## Related APIs
 
-- [Vector3](Vector3.md)
+- [Vector3Input](Vector3Input.md)
+- [Vector3Tuple](Vector3Tuple.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -0,0 +1,34 @@
+# PathOptions
+
+Topology and allocation ceiling for an immutable sampled path.
+
+## Properties
+
+### closed?
+
+
+
+`readonly` `optional` **closed?**: `boolean`
+
+
+
+Connects the last vertex to the first; closed paths omit the repeated seam. Defaults to false.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Construction point ceiling; defaults to package sampling limits. Later sampling has its own options.
+
+
+## Related APIs
+
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+Package: `@metamesh/modeling@0.15.0`.

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

@@ -24,7 +24,7 @@ Positive number of copies; open paths include both endpoints when greater than o
 
 
 
-Include the closing edge without duplicating the seam; defaults to false.
+Raw point closure defaults to false; a path value supplies closure and rejects conflicts.
 
 ***
 
@@ -36,11 +36,11 @@ Include the closing edge without duplicating the seam; defaults to false.
 
 
 
-Preserve the source orientation, or align its +Z to the path tangent; defaults to fixed.
+Preserve orientation, or align local +X for Sections / +Z for Solids to the tangent. Defaults to fixed.
 
 
 ## Guides
 
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.15.0`.