@metamesh/modeling 0.14.0 → 0.16.0

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

@@ -8,11 +8,11 @@ Options controlling bounded, connectivity-only optimization of planar triangle p
 
 ## Properties
 
-### maximumFlipAttempts?
+### maxFlipAttempts?
 
 
 
-`readonly` `optional` **maximumFlipAttempts?**: `number`
+`readonly` `optional` **maxFlipAttempts?**: `number`
 
 
 
@@ -21,11 +21,11 @@ edge count, capped at `1000000`.
 
 ***
 
-### maximumEdgeRevisits?
+### maxEdgeRevisits?
 
 
 
-`readonly` `optional` **maximumEdgeRevisits?**: `number`
+`readonly` `optional` **maxEdgeRevisits?**: `number`
 
 
 
@@ -33,11 +33,11 @@ Maximum times one edge may be reconsidered after neighbouring flips. Defaults to
 
 ***
 
-### maximumPatchTriangleCount?
+### maxPatchTriangles?
 
 
 
-`readonly` `optional` **maximumPatchTriangleCount?**: `number`
+`readonly` `optional` **maxPatchTriangles?**: `number`
 
 
 
@@ -45,11 +45,11 @@ Maximum triangles allowed in one selected patch. Defaults to `50000`.
 
 ***
 
-### maximumProcessedTriangleCount?
+### maxProcessedTriangles?
 
 
 
-`readonly` `optional` **maximumProcessedTriangleCount?**: `number`
+`readonly` `optional` **maxProcessedTriangles?**: `number`
 
 
 
@@ -57,11 +57,11 @@ Maximum cumulative triangles across selected patches. Defaults to `200000`.
 
 ***
 
-### minimumPatchTriangleCount?
+### minPatchTriangles?
 
 
 
-`readonly` `optional` **minimumPatchTriangleCount?**: `number`
+`readonly` `optional` **minPatchTriangles?**: `number`
 
 
 
@@ -69,11 +69,11 @@ Minimum triangles required before a planar patch is eligible. Defaults to `8`.
 
 ***
 
-### triggerMaximumAspectRatio?
+### triggerMaxAspectRatio?
 
 
 
-`readonly` `optional` **triggerMaximumAspectRatio?**: `number`
+`readonly` `optional` **triggerMaxAspectRatio?**: `number`
 
 
 
@@ -81,11 +81,11 @@ Select patches whose worst normalized aspect ratio exceeds this value. Defaults
 
 ***
 
-### triggerMaximumFanRatio?
+### triggerMaxFanRatio?
 
 
 
-`readonly` `optional` **triggerMaximumFanRatio?**: `number`
+`readonly` `optional` **triggerMaxFanRatio?**: `number`
 
 
 
@@ -93,11 +93,11 @@ Select patches whose largest per-vertex triangle share exceeds this ratio. Defau
 
 ***
 
-### triggerMaximumVertexTriangleIncidence?
+### triggerMaxVertexTriangleIncidence?
 
 
 
-`readonly` `optional` **triggerMaximumVertexTriangleIncidence?**: `number`
+`readonly` `optional` **triggerMaxVertexTriangleIncidence?**: `number`
 
 
 
@@ -105,11 +105,11 @@ Select patches whose largest vertex triangle incidence exceeds this value. Defau
 
 ***
 
-### triggerMinimumAngleDegrees?
+### triggerMinAngleDegrees?
 
 
 
-`readonly` `optional` **triggerMinimumAngleDegrees?**: `number`
+`readonly` `optional` **triggerMinAngleDegrees?**: `number`
 
 
 
@@ -117,11 +117,11 @@ Select patches whose smallest interior angle is below this many degrees. Default
 
 ***
 
-### maximumTriangleCount?
+### maxTriangles?
 
 
 
-`readonly` `optional` **maximumTriangleCount?**: `number`
+`readonly` `optional` **maxTriangles?**: `number`
 
 
 
@@ -129,7 +129,7 @@ Maximum number of triangles inspected. Defaults to `200000`.
 
 #### Inherited from
 
-[`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md).[`maximumTriangleCount`](TriangleMeshQualityOptions.md#maximumtrianglecount)
+[`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md).[`maxTriangles`](TriangleMeshQualityOptions.md#maxtriangles)
 
 ***
 
@@ -153,4 +153,8 @@ Numeric comparison overrides; model coordinates are interpreted in their existin
 - [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [TriangleMeshQualityOptions](TriangleMeshQualityOptions.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -117,4 +117,8 @@ Number of triggered patches omitted because a configured triangle bound would be
 - [TriangleMesh](TriangleMesh.md)
 - [TriangleMeshQualityReport](TriangleMeshQualityReport.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -128,7 +128,7 @@ Smallest interior triangle angle in degrees.
 
 
 
-`readonly` **normal**: [`Vector3Tuple`](Vector3Tuple.md)
+`readonly` **normal**: [`Vector3Data`](Vector3Data.md)
 
 
 
@@ -185,6 +185,10 @@ Number of distinct indexed vertices referenced by this patch.
 
 ## Related APIs
 
-- [Vector3Tuple](Vector3Tuple.md)
+- [Vector3Data](Vector3Data.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/geometry/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,5 +34,10 @@ Counter-clockwise exterior boundary, omitting its duplicated closing point.
 ## Related APIs
 
 - [Contour](Contour.md)
+- [RegionData](RegionData.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -24,11 +24,11 @@ Millimetre sampling policy; circularSegments applies only to arcs.
 
 ***
 
-### maximumVertices?
+### maxVertices?
 
 
 
-`readonly` `optional` **maximumVertices?**: `number`
+`readonly` `optional` **maxVertices?**: `number`
 
 
 
@@ -36,7 +36,7 @@ Output vertex ceiling of at least two; may only lower limits.maxPathPoints.
 
 #### Inherited from
 
-[`CurveSamplingOptions`](CurveSamplingOptions.md).[`maximumVertices`](CurveSamplingOptions.md#maximumvertices)
+[`CurveSamplingOptions`](CurveSamplingOptions.md).[`maxVertices`](CurveSamplingOptions.md#maxvertices)
 
 ***
 
@@ -89,4 +89,8 @@ Includes the closing edge without repeating the first output point; defaults to
 - [GeometryResolution](GeometryResolution.md)
 - [GeometrySamplingLimits](GeometrySamplingLimits.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## 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/geometry/PrimitiveAttachment.md

@@ -0,0 +1,31 @@
+# PrimitiveAttachment
+
+Anchor attachment shared by solid and filled-section factories.
+
+## Extended by
+
+- [`BoxOptions`](BoxOptions.md)
+- [`TorusOptions`](TorusOptions.md)
+- [`TubeOptions`](TubeOptions.md)
+
+## Properties
+
+### attachment?
+
+
+
+`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
+
+
+
+Applied after local construction; Section attachment must preserve the XY plane.
+
+
+## Related APIs
+
+- [BoxOptions](BoxOptions.md)
+- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
+- [TorusOptions](TorusOptions.md)
+- [TubeOptions](TubeOptions.md)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -0,0 +1,104 @@
+# PrimitiveAttachmentOptions
+
+Maps an explicit or named shape-local attachment anchor onto a world-space anchor.
+
+## Extends
+
+- [`AttachOptions`](AttachOptions.md)
+
+## Properties
+
+### alignment?
+
+
+
+`readonly` `optional` **alignment?**: `"opposed"` \| `"same"`
+
+
+
+Align outward directions face-to-face (`opposed`) or in parallel (`same`).
+
+#### Inherited from
+
+[`AttachOptions`](AttachOptions.md).[`alignment`](AttachOptions.md#alignment)
+
+***
+
+### gap?
+
+
+
+`readonly` `optional` **gap?**: `number`
+
+
+
+Separation along the target anchor's outward direction in model units.
+
+#### Inherited from
+
+[`AttachOptions`](AttachOptions.md).[`gap`](AttachOptions.md#gap)
+
+***
+
+### spin?
+
+
+
+`readonly` `optional` **spin?**: `number`
+
+
+
+Additional right-handed roll about the attached direction, in degrees.
+
+#### Inherited from
+
+[`AttachOptions`](AttachOptions.md).[`spin`](AttachOptions.md#spin)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Optional numeric comparison overrides.
+
+#### Inherited from
+
+[`AttachOptions`](AttachOptions.md).[`tolerance`](AttachOptions.md#tolerance)
+
+***
+
+### source
+
+
+
+`readonly` **source**: `string` \| [`Anchor3`](Anchor3-type.md)
+
+
+
+Shape-local source frame or a named primitive anchor such as bottom.
+
+***
+
+### target
+
+
+
+`readonly` **target**: [`Anchor3`](Anchor3-type.md)
+
+
+
+World-space target frame in millimetres.
+
+
+## Related APIs
+
+- [Anchor3](Anchor3-type.md)
+- [AttachOptions](AttachOptions.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -4,4 +4,11 @@ Named baseline fit policies for calibrated FDM-style printed threads.
 
 **PrintableThreadFit** = `"tight"` \| `"normal"` \| `"loose"`
 
-Package: `@metamesh/modeling@0.14.0`.
+
+
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -42,4 +42,9 @@ Radial increase applied to an internal thread envelope.
 
 Radial reduction applied to an external thread envelope.
 
-Package: `@metamesh/modeling@0.14.0`.
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

package/dist/docs/reference/geometry/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,11 @@ Ordered components with explicit contour identities.
 ## Related APIs
 
 - [ProfileComponent2](ProfileComponent2.md)
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [matchProfiles](matchProfiles.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -43,4 +43,8 @@ Clockwise hole contours belonging to this component.
 
 - [ProfileContour2](ProfileContour2.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -1,6 +1,6 @@
 # ProfileContour2
 
-Ordered, closed spans. Outer winding is CCW and hole winding is CW.
+An identified closed boundary of curve spans, before shared family sampling. Outer winding is CCW and hole winding is CW. matchProfiles retains span identities in sampled contours.
 
 ## Properties
 
@@ -30,5 +30,11 @@ Ordered identified spans; the last endpoint meets the first start.
 ## Related APIs
 
 - [ProfileSpan2](ProfileSpan2.md)
+- [Contour](Contour.md)
+- [CorrespondingContour](CorrespondingContour.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -2,7 +2,7 @@
 
 An identified line, circular arc, or cubic Bézier between corresponding landmarks.
 
-**ProfileSpan2** = `object` & (\{ `kind`: `"line"`; `start`: [`Vector2Tuple`](Vector2Tuple.md); `end`: [`Vector2Tuple`](Vector2Tuple.md); \} \| \{ `kind`: `"arc"`; `center`: [`Vector2Tuple`](Vector2Tuple.md); `radius`: `number`; `startDegrees`: `number`; `sweepDegrees`: `number`; \} \| \{ `kind`: `"cubic"`; `start`: [`Vector2Tuple`](Vector2Tuple.md); `control1`: [`Vector2Tuple`](Vector2Tuple.md); `control2`: [`Vector2Tuple`](Vector2Tuple.md); `end`: [`Vector2Tuple`](Vector2Tuple.md); \})
+**ProfileSpan2** = `object` & (\{ `kind`: `"line"`; `start`: [`Vector2Data`](Vector2Data.md); `end`: [`Vector2Data`](Vector2Data.md); \} \| \{ `kind`: `"arc"`; `center`: [`Vector2Data`](Vector2Data.md); `radius`: `number`; `startAngle`: `number`; `sweepAngle`: `number`; \} \| \{ `kind`: `"cubic"`; `start`: [`Vector2Data`](Vector2Data.md); `control1`: [`Vector2Data`](Vector2Data.md); `control2`: [`Vector2Data`](Vector2Data.md); `end`: [`Vector2Data`](Vector2Data.md); \})
 
 
 
@@ -42,6 +42,10 @@ Optional span-local physical sampling over the family's resolution; exact interv
 ## Related APIs
 
 - [GeometryResolution](GeometryResolution.md)
-- [Vector2Tuple](Vector2Tuple.md)
+- [Vector2Data](Vector2Data.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -20,7 +20,7 @@ Selects an explicit corner profile; no analytic curve is inferred from its sampl
 
 
 
-`readonly` **profile**: readonly [`Vector2Tuple`](Vector2Tuple.md)[]
+`readonly` **profile**: readonly [`Vector2Data`](Vector2Data.md)[]
 
 
 
@@ -31,6 +31,6 @@ cap inset first, side setback second; planar corners use incoming then outgoing
 
 ## Related APIs
 
-- [Vector2Tuple](Vector2Tuple.md)
+- [Vector2Data](Vector2Data.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -110,4 +110,9 @@ Number of complete teeth represented by the segment.
 
 Normal module supplied by the caller, in millimetres.
 
-Package: `@metamesh/modeling@0.14.0`.
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -28,11 +28,11 @@ Dedendum clearance as a multiple of normal module; defaults to `0.25`.
 
 ***
 
-### helixAngleDegrees?
+### helixAngle?
 
 
 
-`readonly` `optional` **helixAngleDegrees?**: `number`
+`readonly` `optional` **helixAngle?**: `number`
 
 
 
@@ -52,11 +52,11 @@ Normal module in millimetres per tooth.
 
 ***
 
-### pressureAngleDegrees?
+### pressureAngle?
 
 
 
-`readonly` `optional` **pressureAngleDegrees?**: `number`
+`readonly` `optional` **pressureAngle?**: `number`
 
 
 
@@ -74,4 +74,9 @@ Normal pressure angle in degrees; defaults to 20 degrees.
 
 Number of complete rack teeth represented by the segment.
 
-Package: `@metamesh/modeling@0.14.0`.
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -1,62 +1,57 @@
 # RadialPatternOptions
 
-Options for repeating one solid around an axis through a center point.
+Degree rotations about a fixed world-space pivot; XY patterns use the implicit +Z axis.
 
-## Properties
+**RadialPatternOptions**\<`Dimension` *extends* `2` \| `3` = `3`\> = `object` & `Dimension` *extends* `2` ? `object` : `object`
 
-### count
-
-
-
-`readonly` **count**: `number`
 
 
+## Type Parameters
 
-Number of solids to return, including the original.
+### Dimension
 
-***
+`Dimension` *extends* `2` \| `3` = `3`
 
-### axis
+## Type Declaration
 
+### count
 
 
-`readonly` **axis**: [`Vector3Tuple`](Vector3Tuple.md)
 
+`readonly` **count**: `number`
 
 
-Axis of the right-handed rotation. Its magnitude is ignored.
 
-***
+Number of shapes to return, including the original.
 
-### angleDegrees
+### angle
 
 
 
-`readonly` **angleDegrees**: `number`
+`readonly` **angle**: `number`
 
 
 
 Signed rotation from one copy to the next, in degrees.
 
-***
-
-### center?
+### pivot?
 
 
 
-`readonly` `optional` **center?**: [`Vector3Tuple`](Vector3Tuple.md)
+`readonly` `optional` **pivot?**: `Dimension` *extends* `2` ? [`Vector2Input`](Vector2Input.md) : [`Vector3Input`](Vector3Input.md)
 
 
 
-Rotation center in world coordinates. Defaults to the origin.
+Fixed world-space rotation pivot; defaults to the coordinate origin.
 
 
 ## Related APIs
 
-- [Vector3Tuple](Vector3Tuple.md)
+- [Vector2Input](Vector2Input.md)
+- [Vector3Input](Vector3Input.md)
 
 ## Guides
 
 - [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/geometry/RadialSizing.md

@@ -4,4 +4,4 @@ Radial dimensions refer to polygon vertices or compensate faceting to meet polyg
 
 **RadialSizing** = `"vertex"` \| `"face"`
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -37,4 +37,4 @@ Vertex sizing is inscribed; face sizing circumscribes the nominal radius. Defaul
 - [RadialSizing](RadialSizing.md)
 - [RegularPolygonContourOptions](RegularPolygonContourOptions.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -12,7 +12,7 @@ Shared rectangle dimensions, origin and uniform or per-corner treatment.
 
 
 
-`readonly` **size**: `number` \| [`Vector2Tuple`](Vector2Tuple.md)
+`readonly` **size**: `number` \| [`Vector2Data`](Vector2Data.md)
 
 
 
@@ -61,6 +61,10 @@ Explicit sampling ceiling for the complete output profile.
 - [GeometrySamplingLimits](GeometrySamplingLimits.md)
 - [RectangleCornerTreatments](RectangleCornerTreatments.md)
 - [RectangleProfileOptions](RectangleProfileOptions.md)
-- [Vector2Tuple](Vector2Tuple.md)
+- [Vector2Data](Vector2Data.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.16.0`.

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

@@ -31,4 +31,8 @@ Leaves this corner untreated.
 
 - [EdgeTreatment](EdgeTreatment.md)
 
-Package: `@metamesh/modeling@0.14.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.16.0`.