@metamesh/modeling 0.14.0 → 0.16.0

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

@@ -0,0 +1,50 @@
+# Path3Data
+
+Complete plain XYZ path representation, including topology and empty-path dimensional identity.
+
+## Properties
+
+### dimension
+
+
+
+`readonly` **dimension**: `3`
+
+
+
+Coordinate dimension, retained even when points is empty.
+
+***
+
+### points
+
+
+
+`readonly` **points**: readonly [`Vector3Data`](Vector3Data.md)[]
+
+
+
+Frozen or caller-owned XYZ coordinates; closed paths omit a duplicated seam.
+
+***
+
+### closed
+
+
+
+`readonly` **closed**: `boolean`
+
+
+
+Whether traversal includes the last-to-first edge.
+
+
+## Related APIs
+
+- [Vector3Data](Vector3Data.md)
+
+## Guides
+
+- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,20 @@
+# Path3Input
+
+A matching path value, complete plain path data, or a collection of vectors.
+
+**Path3Input** = [`Path3`](Path3-type.md) \| [`Path3Data`](Path3Data.md) \| readonly [`Vector3Input`](Vector3Input.md)[]
+
+
+
+
+## Related APIs
+
+- [Path3](Path3-type.md)
+- [Path3Data](Path3Data.md)
+- [Vector3Input](Vector3Input.md)
+
+## Guides
+
+- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,69 @@
+# 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)
+
+## Guides
+
+- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -2,7 +2,7 @@
 
 Supplies a profile-X orientation guide for each original normalized sweep station.
 
-**PathNormalGuide** = (`point`: [`Vector3Tuple`](Vector3Tuple.md), `index`: `number`) => [`Vector3Tuple`](Vector3Tuple.md)
+**PathNormalGuide** = (`point`: [`Vector3Data`](Vector3Data.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`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
+**`point`** · [`Vector3Data`](Vector3Data.md) · Required
 
 Current XYZ path point in model units.
 
@@ -26,14 +26,15 @@ Zero-based index of `point` in the normalized authored sweep path.
 
 ## Returns
 
-[`Vector3Tuple`](Vector3Tuple.md)
+[`Vector3Input`](Vector3Input.md)
 
 A finite guide vector that is not parallel to the local path tangent.
 
 
 ## Related APIs
 
-- [Vector3Tuple](Vector3Tuple.md)
+- [Vector3Data](Vector3Data.md)
+- [Vector3Input](Vector3Input.md)
 
 ## Guides
 
@@ -42,4 +43,4 @@ A finite guide vector that is not parallel to the local path tangent.
 - [Matched-section loft](../../guides/recipes.md#matched-section-loft)
 - [Choose a modeling path](../../guides/concepts.md#choose-a-modeling-path)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,38 @@
+# 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)
+
+## Guides
+
+- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
+
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/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,12 +36,13 @@ 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
 
 - [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/PathResamplingOptions.md

@@ -0,0 +1,83 @@
+# PathResamplingOptions
+
+Equal arc-length sampling; the path itself owns whether its closing edge is included.
+
+## Extends
+
+- `CurveSamplingOptions`
+
+## Properties
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Millimetre sampling policy; circularSegments applies only to arcs.
+
+#### Inherited from
+
+`CurveSamplingOptions.resolution`
+
+***
+
+### maxVertices?
+
+
+
+`readonly` `optional` **maxVertices?**: `number`
+
+
+
+Output vertex ceiling of at least two; may only lower limits.maxPathPoints.
+
+#### Inherited from
+
+`CurveSamplingOptions.maxVertices`
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings; omitted values use package defaults without ambient state.
+
+#### Inherited from
+
+`CurveSamplingOptions.limits`
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact arc-length intervals; closed paths need at least three. Otherwise physical resolution or the effective source edge count controls sampling.
+
+#### Overrides
+
+`CurveSamplingOptions.segments`
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+## Guides
+
+- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
+
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/PatternSource.md

@@ -22,5 +22,6 @@ One immutable shape, or a synchronous factory called once per copy in index orde
 
 - [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/Pivot2Options.md

@@ -23,5 +23,6 @@ World-space point left fixed by rotation or scaling.
 
 - [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/Pivot3Options.md

@@ -23,5 +23,6 @@ World-space point left fixed by rotation or scaling.
 
 - [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/PlaneOptions.md

@@ -8,7 +8,7 @@ A world-space cutting plane, retaining the half-space in the normal's direction.
 
 
 
-`readonly` **normal**: [`Vector3Tuple`](Vector3Tuple.md)
+`readonly` **normal**: [`Vector3Input`](Vector3Input.md)
 
 
 
@@ -29,11 +29,11 @@ Signed millimetre distance from the origin along the unit normal. Defaults to ze
 
 ## Related APIs
 
-- [Vector3Tuple](Vector3Tuple.md)
+- [Vector3Input](Vector3Input.md)
 
 ## Guides
 
 - [Choose the Boolean by the material you want](../../guides/fundamentals.md#choose-the-boolean-by-the-material-you-want)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/PolygonData.md

@@ -1,6 +1,6 @@
 # PolygonData
 
-One bounded two-dimensional polygon.
+One filled two-dimensional polygon with an exterior and optional holes.
 
 `outer` is counter-clockwise and each hole is clockwise. Boundary arrays omit
 their duplicated closing point. Holes must lie inside `outer` and must not
@@ -34,10 +34,11 @@ Counter-clockwise exterior boundary, omitting its duplicated closing point.
 ## Related APIs
 
 - [Contour](Contour.md)
+- [RegionData](RegionData.md)
 
 ## Guides
 
 - [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
 - [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/PolygonOptions.md

@@ -2,7 +2,7 @@
 
 Explicit polygon topology or compound contours; all closing edges are implicit.
 
-**PolygonOptions** = \{ `outer`: [`Contour`](Contour.md); `holes?`: readonly [`Contour`](Contour.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \} \| \{ `contours`: readonly [`Contour`](Contour.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \} \| \{ `polygons`: [`RegionData`](RegionData.md); `outer?`: `never`; `holes?`: `never`; `contours?`: `never`; `fillRule?`: `never`; \}
+**PolygonOptions** = \{ `outer`: [`Path2Input`](Path2Input.md); `holes?`: readonly [`Path2Input`](Path2Input.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \} \| \{ `contours`: readonly [`Path2Input`](Path2Input.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \} \| \{ `polygons`: [`RegionData`](RegionData.md); `outer?`: `never`; `holes?`: `never`; `contours?`: `never`; `fillRule?`: `never`; \}
 
 
 
@@ -10,13 +10,13 @@ Explicit polygon topology or compound contours; all closing edges are implicit.
 
 ### Type Literal
 
-\{ `outer`: [`Contour`](Contour.md); `holes?`: readonly [`Contour`](Contour.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \}
+\{ `outer`: [`Path2Input`](Path2Input.md); `holes?`: readonly [`Path2Input`](Path2Input.md)[]; `contours?`: `never`; `fillRule?`: `never`; `polygons?`: `never`; \}
 
 #### outer
 
 
 
-`readonly` **outer**: [`Contour`](Contour.md)
+`readonly` **outer**: [`Path2Input`](Path2Input.md)
 
 
 
@@ -26,7 +26,7 @@ One simple exterior boundary, normalized to counterclockwise winding.
 
 
 
-`readonly` `optional` **holes?**: readonly [`Contour`](Contour.md)[]
+`readonly` `optional` **holes?**: readonly [`Path2Input`](Path2Input.md)[]
 
 
 
@@ -66,13 +66,13 @@ Explicit topology excludes serialized multi-polygon data.
 
 ### Type Literal
 
-\{ `contours`: readonly [`Contour`](Contour.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \}
+\{ `contours`: readonly [`Path2Input`](Path2Input.md)[]; `fillRule?`: `"nonzero"` \| `"evenodd"`; `outer?`: `never`; `holes?`: `never`; `polygons?`: `never`; \}
 
 #### contours
 
 
 
-`readonly` **contours**: readonly [`Contour`](Contour.md)[]
+`readonly` **contours**: readonly [`Path2Input`](Path2Input.md)[]
 
 
 
@@ -177,7 +177,7 @@ Serialized polygons define fill explicitly.
 
 ## Related APIs
 
-- [Contour](Contour.md)
+- [Path2Input](Path2Input.md)
 - [RegionData](RegionData.md)
 
 ## Guides
@@ -186,4 +186,4 @@ Serialized polygons define fill explicitly.
 - [SVG sections: fills and strokes are different inputs](../../guides/concepts.md#svg-sections-fills-and-strokes-are-different-inputs)
 - [Text and font variability](../../guides/concepts.md#text-and-font-variability)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/{PrimitivePlacement.md → PrimitiveAttachment.md}

@@ -1,6 +1,6 @@
-# PrimitivePlacement
+# PrimitiveAttachment
 
-Placement shared by solid and filled-section factories.
+Anchor attachment shared by solid and filled-section factories.
 
 ## Extended by
 
@@ -12,21 +12,21 @@ Placement shared by solid and filled-section factories.
 
 ## Properties
 
-### placement?
+### attachment?
 
 
 
-`readonly` `optional` **placement?**: [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md)
+`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
 
 
 
-Applied after local construction; Section placement must preserve the XY plane.
+Applied after local construction; Section attachment must preserve the XY plane.
 
 
 ## Related APIs
 
 - [BoxOptions](BoxOptions.md)
-- [PrimitivePlacementOptions](PrimitivePlacementOptions.md)
+- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
 - [RectangleOptions](RectangleOptions.md)
 - [StarOptions](StarOptions.md)
 - [TorusOptions](TorusOptions.md)
@@ -36,5 +36,6 @@ Applied after local construction; Section placement must preserve the XY plane.
 
 - [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/{PrimitivePlacementOptions.md → PrimitiveAttachmentOptions.md}

@@ -1,88 +1,110 @@
-# PrimitivePlacementOptions
+# PrimitiveAttachmentOptions
 
 Maps an explicit or named shape-local attachment anchor onto a world-space anchor.
 
+## Extends
+
+- [`AttachOptions`](AttachOptions.md)
+
 ## Properties
 
-### source
+### alignment?
 
 
 
-`readonly` **source**: `string` \| [`Anchor3`](Anchor3.md)
+`readonly` `optional` **alignment?**: `"opposed"` \| `"same"`
 
 
 
-Shape-local source frame or a named primitive anchor such as bottom.
+Align outward directions face-to-face (`opposed`) or in parallel (`same`).
+
+#### Inherited from
+
+[`AttachOptions`](AttachOptions.md).[`alignment`](AttachOptions.md#alignment)
 
 ***
 
-### target
+### gap?
 
 
 
-`readonly` **target**: [`Anchor3`](Anchor3.md)
+`readonly` `optional` **gap?**: `number`
 
 
 
-World-space target frame in millimetres.
+Separation along the target anchor's outward direction in model units.
+
+#### Inherited from
+
+[`AttachOptions`](AttachOptions.md).[`gap`](AttachOptions.md#gap)
 
 ***
 
-### alignment?
+### spin?
 
 
 
-`readonly` `optional` **alignment?**: `"opposed"` \| `"same"`
+`readonly` `optional` **spin?**: `number`
+
+
 
+Additional right-handed roll about the attached direction, in degrees.
 
+#### Inherited from
 
-Align outward directions face-to-face or in parallel. Defaults to opposed.
+[`AttachOptions`](AttachOptions.md).[`spin`](AttachOptions.md#spin)
 
 ***
 
-### gap?
+### tolerance?
 
 
 
-`readonly` `optional` **gap?**: `number`
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
 
+Optional numeric comparison overrides.
 
+#### Inherited from
 
-Finite separation along the target direction in millimetres. Defaults to zero.
+[`AttachOptions`](AttachOptions.md).[`tolerance`](AttachOptions.md#tolerance)
 
 ***
 
-### spinDegrees?
+### source
 
 
 
-`readonly` `optional` **spinDegrees?**: `number`
+`readonly` **source**: `string` \| [`Anchor3`](Anchor3.md)
 
 
 
-Finite additional roll around the attached direction in degrees. Defaults to zero.
+Shape-local source frame or a named primitive anchor such as bottom.
 
 ***
 
-### tolerance?
+### target
 
 
 
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+`readonly` **target**: [`Anchor3`](Anchor3.md)
 
 
 
-Explicit numeric comparison overrides for anchor normalization.
+World-space target frame in millimetres.
 
 
 ## Related APIs
 
 - [Anchor3](Anchor3.md)
+- [AttachOptions](AttachOptions.md)
 - [GeometryToleranceOptions](GeometryToleranceOptions.md)
 
 ## Guides
 
 - [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
 - [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/PrintableThreadFit.md

@@ -10,5 +10,6 @@ Named baseline fit policies for calibrated FDM-style printed threads.
 ## Guides
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+- [Preflight guarantees and host settings](../../guides/concepts.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/PrintableThreadFitPolicy.md

@@ -46,5 +46,6 @@ Radial reduction applied to an external thread envelope.
 ## Guides
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+- [Preflight guarantees and host settings](../../guides/concepts.md#check-preflight-guarantees)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/model/Profile.md

@@ -1,6 +1,6 @@
 # Profile
 
-An explicit component/contour/span topology, before shared family sampling.
+An explicit component/contour/span topology, before shared family sampling with matchProfiles. Component, contour and span identities establish correspondence across a loft or sweep family.
 
 ## Properties
 
@@ -18,5 +18,7 @@ Ordered components with explicit contour identities.
 ## Related APIs
 
 - [ProfileComponent2](ProfileComponent2.md)
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [matchProfiles](matchProfiles.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.