@metamesh/modeling 0.15.0 → 0.17.0

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

@@ -0,0 +1,127 @@
+# Bounds3
+
+Immutable finite XYZ bounds in millimetres, with tuple coordinates for data interoperability.
+
+## Extends
+
+- [`Bounds3Data`](Bounds3Data.md)
+
+## Properties
+
+### max
+
+
+
+`readonly` **max**: [`Vector3Data`](Vector3Data.md)
+
+
+
+Inclusive maximum X/Y/Z coordinates.
+
+#### Inherited from
+
+[`Bounds3Data`](Bounds3Data.md).[`max`](Bounds3Data.md#max)
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector3Data`](Vector3Data.md)
+
+
+
+Inclusive minimum X/Y/Z coordinates.
+
+#### Inherited from
+
+[`Bounds3Data`](Bounds3Data.md).[`min`](Bounds3Data.md#min)
+
+## Methods
+
+### size()
+
+
+
+**size**(): [`Vector3`](Vector3-type.md)
+
+
+
+Returns nonnegative X/Y/Z dimensions in millimetres, including zero extents.
+
+#### Returns
+
+[`Vector3`](Vector3-type.md)
+
+***
+
+### center()
+
+
+
+**center**(): [`Vector3`](Vector3-type.md)
+
+
+
+Returns the midpoint in millimetres.
+
+#### Returns
+
+[`Vector3`](Vector3-type.md)
+
+***
+
+### containsBounds()
+
+
+
+**containsBounds**(`other`: [`Bounds3Input`](Bounds3Input.md)): `boolean`
+
+
+
+Tests positioned XYZ containment, including touching boundaries.
+
+#### Parameters
+
+<a id="other"></a>
+
+**`other`** · [`Bounds3Input`](Bounds3Input.md) · Required
+
+
+
+#### Returns
+
+`boolean`
+
+***
+
+### toData()
+
+
+
+**toData**(): [`Bounds3Data`](Bounds3Data.md)
+
+
+
+Returns this value's frozen plain record; repeated calls do not allocate.
+
+#### Returns
+
+[`Bounds3Data`](Bounds3Data.md)
+
+
+## Related APIs
+
+- [Bounds3Data](Bounds3Data.md)
+- [Bounds3Input](Bounds3Input.md)
+- [Vector3](Vector3-type.md)
+- [Vector3Data](Vector3Data.md)
+
+## Guides
+
+- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -0,0 +1,45 @@
+# Bounds3Data
+
+Plain axis-aligned XYZ bounds for interchange; use bounds3 for immutable measurement methods.
+
+## Extended by
+
+- [`Bounds3`](Bounds3-type.md)
+
+## Properties
+
+### max
+
+
+
+`readonly` **max**: [`Vector3Data`](Vector3Data.md)
+
+
+
+Inclusive maximum X/Y/Z coordinates.
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector3Data`](Vector3Data.md)
+
+
+
+Inclusive minimum X/Y/Z coordinates.
+
+
+## Related APIs
+
+- [Bounds3](Bounds3-type.md)
+- [Vector3Data](Vector3Data.md)
+
+## Guides
+
+- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -0,0 +1,21 @@
+# Bounds3Input
+
+An immutable XYZ bounds value or its plain min/max representation.
+
+**Bounds3Input** = [`Bounds3`](Bounds3-type.md) \| [`Bounds3Data`](Bounds3Data.md)
+
+
+
+
+## Related APIs
+
+- [Bounds3](Bounds3-type.md)
+- [Bounds3Data](Bounds3Data.md)
+
+## Guides
+
+- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -0,0 +1,72 @@
+# Bounds3Options
+
+XYZ bounds construction from existing extrema or nonnegative dimensions, never both.
+
+**Bounds3Options** = [`Bounds3Input`](Bounds3Input.md) & `object` \| \{ `size`: [`Vector3Data`](Vector3Data.md); `center?`: `boolean`; `min?`: `never`; `max?`: `never`; \}
+
+
+
+## Union Members
+
+[`Bounds3Input`](Bounds3Input.md) & `object`
+
+***
+
+### Type Literal
+
+\{ `size`: [`Vector3Data`](Vector3Data.md); `center?`: `boolean`; `min?`: `never`; `max?`: `never`; \}
+
+#### size
+
+
+
+`readonly` **size**: [`Vector3Data`](Vector3Data.md)
+
+
+
+Nonnegative XYZ dimensions in millimetres.
+
+#### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
+
+Center on the origin; false starts at the origin. Defaults to true.
+
+#### min?
+
+
+
+`readonly` `optional` **min?**: `never`
+
+
+
+Minimum coordinates are unavailable when size is supplied.
+
+#### max?
+
+
+
+`readonly` `optional` **max?**: `never`
+
+
+
+Maximum coordinates are unavailable when size is supplied.
+
+
+## Related APIs
+
+- [Bounds3](Bounds3-type.md)
+- [Bounds3Input](Bounds3Input.md)
+- [Vector3Data](Vector3Data.md)
+
+## Guides
+
+- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
+- [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -20,7 +20,7 @@ Positive uniform scale.
 
 
 
-`readonly` **position**: [`Vector2Tuple`](Vector2Tuple.md)
+`readonly` **position**: [`Vector2Data`](Vector2Data.md)
 
 
 
@@ -32,7 +32,7 @@ Millimetre translation applied after scaling around the origin.
 
 
 
-`readonly` **bounds**: [`Bounds2`](Bounds2.md)
+`readonly` **bounds**: [`Bounds2Data`](Bounds2Data.md)
 
 
 
@@ -41,12 +41,13 @@ Bounds after scaling and translation.
 
 ## Related APIs
 
-- [Bounds2](Bounds2.md)
-- [Vector2Tuple](Vector2Tuple.md)
+- [Bounds2Data](Bounds2Data.md)
+- [Vector2Data](Vector2Data.md)
 
 ## Guides
 
+- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
 - [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
 - [Solid inspection](../../guides/recipes.md#solid-inspection)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -20,7 +20,7 @@ Positive uniform scale.
 
 
 
-`readonly` **position**: [`Vector3Tuple`](Vector3Tuple.md)
+`readonly` **position**: [`Vector3Data`](Vector3Data.md)
 
 
 
@@ -32,7 +32,7 @@ Millimetre translation applied after scaling around the origin.
 
 
 
-`readonly` **bounds**: [`Bounds3`](Bounds3.md)
+`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
 
 
 
@@ -41,12 +41,13 @@ Bounds after scaling and translation.
 
 ## Related APIs
 
-- [Bounds3](Bounds3.md)
-- [Vector3Tuple](Vector3Tuple.md)
+- [Bounds3Data](Bounds3Data.md)
+- [Vector3Data](Vector3Data.md)
 
 ## Guides
 
+- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
 - [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
 - [Solid inspection](../../guides/recipes.md#solid-inspection)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -17,7 +17,8 @@ Positive upper scale limit; use 1 to prevent enlargement. Omitted permits enlarg
 
 ## Guides
 
+- [Measure and compare bounds](../../guides/concepts.md#measure-and-compare-bounds)
 - [Text from a Font parameter](../../guides/recipes.md#text-from-a-font-parameter)
 - [Solid inspection](../../guides/recipes.md#solid-inspection)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -10,5 +10,6 @@ Named face on an axis-aligned box.
 ## Guides
 
 - [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+- [Fluent values and tuple kernels](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -8,7 +8,7 @@ Box dimensions and construction origin for one named face anchor.
 
 
 
-`readonly` **size**: `number` \| [`Vector3Tuple`](Vector3Tuple.md)
+`readonly` **size**: `number` \| [`Vector3Data`](Vector3Data.md)
 
 
 
@@ -44,7 +44,7 @@ Centers the box around its construction origin; defaults to true, matching box()
 
 
 
-`readonly` `optional` **origin?**: [`Vector3Tuple`](Vector3Tuple.md)
+`readonly` `optional` **origin?**: [`Vector3Data`](Vector3Data.md)
 
 
 
@@ -54,10 +54,11 @@ Construction origin; centered-box center or noncentered minimum corner. Defaults
 ## Related APIs
 
 - [BoxAnchorFace](BoxAnchorFace.md)
-- [Vector3Tuple](Vector3Tuple.md)
+- [Vector3Data](Vector3Data.md)
 
 ## Guides
 
 - [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+- [Fluent values and tuple kernels](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -4,4 +4,4 @@ Box edges use +Z top, +Y front and +X right; vertical names list front/back firs
 
 **BoxEdge** = `"top-front"` \| `"top-back"` \| `"top-left"` \| `"top-right"` \| `"bottom-front"` \| `"bottom-back"` \| `"bottom-left"` \| `"bottom-right"` \| `"front-left"` \| `"front-right"` \| `"back-left"` \| `"back-right"`
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -11,4 +11,4 @@ Named individual edges or top/bottom rims and all four vertical edges.
 
 - [BoxEdge](BoxEdge.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -12,4 +12,4 @@ Independent treatments for disjoint named edge selections; overlapping selection
 - [BoxEdgeSelection](BoxEdgeSelection.md)
 - [EdgeTreatment](EdgeTreatment.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -40,7 +40,7 @@ Centers the box on the XYZ origin when `true`; otherwise its minimum corner is a
 
 
 
-`readonly` **size**: `number` \| [`Vector3Tuple`](Vector3Tuple.md)
+`readonly` **size**: `number` \| [`Vector3Data`](Vector3Data.md)
 
 
 
@@ -82,6 +82,6 @@ Applied after local construction; Section attachment must preserve the XY plane.
 - [GeometrySamplingLimits](GeometrySamplingLimits.md)
 - [PrimitiveAttachment](PrimitiveAttachment.md)
 - [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
-- [Vector3Tuple](Vector3Tuple.md)
+- [Vector3Data](Vector3Data.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -4,4 +4,11 @@ Axial side carrying the near-normal pressure flank of a buttress thread.
 
 **ButtressPressureFlankSide** = `"negative"` \| `"positive"`
 
-Package: `@metamesh/modeling@0.15.0`.
+
+
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -90,4 +90,8 @@ Optional numerical tolerance overrides.
 - [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -26,4 +26,4 @@ Selects a straight bevel between adjoining surfaces.
 
 Millimetre setbacks, equal or [first surface, second surface]. Zero or [0, 0] leaves the edge untreated; otherwise both must be positive and fit without overlap.
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -12,4 +12,8 @@ Circular profile dimensions with exactly one radius or diameter and explicit sam
 - [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
 - [RadialSizingOptions](RadialSizingOptions.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -56,4 +56,4 @@ Operation-level physical tessellation policy over the active model-wide policy.
 - [RoundedEdgeTreatment](RoundedEdgeTreatment.md)
 - [TubeOptions](TubeOptions.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -104,4 +104,4 @@ Lower full-circle segment count; defaults to 16 or a lower selected circular cei
 - [GeometryResolution](GeometryResolution.md)
 - [RadialSizing](RadialSizing.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -0,0 +1,41 @@
+# CircularSampling
+
+Full-circle count and radial envelopes of its regular sampled polygon, in millimetres.
+
+## Properties
+
+### segments
+
+
+
+`readonly` **segments**: `number`
+
+
+
+Exact resolved full-circle segment count.
+
+***
+
+### vertexRadius
+
+
+
+`readonly` **vertexRadius**: `number`
+
+
+
+Distance from the origin to every sampled vertex.
+
+***
+
+### faceRadius
+
+
+
+`readonly` **faceRadius**: `number`
+
+
+
+Minimum distance from the origin to each straight sampled edge.
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -0,0 +1,14 @@
+# CircularSamplingOptions
+
+Nominal circle size and explicit physical sampling; supply exactly one radius or diameter.
+
+**CircularSamplingOptions** = [`CircleContourOptions`](CircleContourOptions.md)
+
+
+
+
+## Related APIs
+
+- [CircleContourOptions](CircleContourOptions.md)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -38,4 +38,9 @@ Loose-fit clearance-hole diameter.
 
 Normal-fit clearance-hole diameter.
 
-Package: `@metamesh/modeling@0.15.0`.
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -4,4 +4,11 @@ Common clearance-hole fit categories, ordered from smallest to largest.
 
 **ClearanceHoleFit** = `"close"` \| `"normal"` \| `"loose"`
 
-Package: `@metamesh/modeling@0.15.0`.
+
+
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -50,4 +50,9 @@ Compensated minor diameter in millimetres.
 
 Signed radial shift: negative for male inset, positive for female outset.
 
-Package: `@metamesh/modeling@0.15.0`.
+
+## Guides
+
+- [Conservative estimates and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,17 +1,23 @@
 # Contour
 
-A closed two-dimensional boundary whose first point is not repeated at the end.
+A sampled closed two-dimensional boundary whose first point is not repeated at the end.
 
-**Contour** = readonly [`Vector2Tuple`](Vector2Tuple.md)[]
+**Contour** = readonly [`Vector2Data`](Vector2Data.md)[]
 
 
 
 Polygon exteriors are counter-clockwise and holes are clockwise. Algorithms
 may reject duplicate adjacent points or fewer than three effective vertices.
+Use PolygonData to assign an exterior and its holes, or ProfileContour2 for identified curve spans.
 
 
 ## Related APIs
 
-- [Vector2Tuple](Vector2Tuple.md)
+- [Vector2Data](Vector2Data.md)
+- [PolygonData](PolygonData.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -32,4 +32,8 @@ Ordered chain of 2–32 segments; the final end must exactly match start.
 - [ContourPoint](ContourPoint.md)
 - [ContourSegment](ContourSegment.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -26,4 +26,9 @@ Horizontal coordinate; physical scaling does not center the contour.
 
 Upward planar coordinate.
 
-Package: `@metamesh/modeling@0.15.0`.
+
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -83,4 +83,8 @@ Next anchor; the final anchor repeats the curve start.
 
 - [ContourPoint](ContourPoint.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.17.0`.

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

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

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

@@ -43,4 +43,8 @@ One span identity per point; indices correspond between every matched family mem
 
 - [Contour](Contour.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.17.0`.

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

@@ -19,4 +19,8 @@ Ordered components with explicit contour identities.
 
 - [CorrespondingComponent](CorrespondingComponent.md)
 
-Package: `@metamesh/modeling@0.15.0`.
+## Guides
+
+- [Choose a geometry representation](../../guides/concepts.md#geometry-vocabulary)
+
+Package: `@metamesh/modeling@0.17.0`.