@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,93 @@
+# ButtressThreadProfileSpec
+
+Asymmetric printable buttress profile with 7/45-degree flanks.
+
+## Extends
+
+- [`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md)
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"buttress"`
+
+
+
+Selects the asymmetric printable buttress profile family.
+
+***
+
+### depth?
+
+
+
+`readonly` `optional` **depth?**: `number`
+
+
+
+Radial depth in millimetres.
+
+#### Default Value
+
+`0.66271 * pitch`
+
+***
+
+### pressureFlankSide?
+
+
+
+`readonly` `optional` **pressureFlankSide?**: [`ButtressPressureFlankSide`](ButtressPressureFlankSide.md)
+
+
+
+Axial side of each tooth carrying the 7-degree pressure flank. The opposite side uses the
+45-degree clearance flank.
+
+#### Default Value
+
+`"positive"`
+
+***
+
+### pitch
+
+
+
+`readonly` **pitch**: `number`
+
+
+
+Adjacent axial thread spacing in millimetres.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`pitch`](ThreadProfileBaseSpec.md#pitch)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Optional numerical tolerance overrides.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`tolerance`](ThreadProfileBaseSpec.md#tolerance)
+
+
+## Related APIs
+
+- [ButtressPressureFlankSide](ButtressPressureFlankSide.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,29 @@
+# ChamferedEdgeTreatment
+
+A planar edge or corner chamfer with equal or independent surface setbacks.
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"chamfer"`
+
+
+
+Selects a straight bevel between adjoining surfaces.
+
+***
+
+### distance
+
+
+
+`readonly` **distance**: `number` \| readonly \[`number`, `number`\]
+
+
+
+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.13.0`.

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

@@ -0,0 +1,15 @@
+# CircleContourOptions
+
+Circular profile dimensions with exactly one radius or diameter and explicit sampling.
+
+**CircleContourOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`RadialSizingOptions`](RadialSizingOptions.md) & (\{ `radius`: `number`; `diameter?`: `never`; \} \| \{ `diameter`: `number`; `radius?`: `never`; \})
+
+
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [RadialSizingOptions](RadialSizingOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,59 @@
+# CircularPrimitiveOptions
+
+Tessellation controls shared by circular primitives across Geometry entry points.
+
+## Extended by
+
+- [`RevolveOptions`](RevolveOptions.md)
+- [`RoundedEdgeTreatment`](RoundedEdgeTreatment.md)
+- [`TubeOptions`](TubeOptions.md)
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings; bound modeling operations may only lower the host policy.
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact circumferential segment count from three through the configured safety limit.
+
+This local topology override takes precedence over [CircularPrimitiveOptions.resolution](#resolution)
+and any active model-wide resolution policy.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical tessellation policy over the active model-wide policy.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [RevolveOptions](RevolveOptions.md)
+- [RoundedEdgeTreatment](RoundedEdgeTreatment.md)
+- [TubeOptions](TubeOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,41 @@
+# ClearanceHoleDimensions
+
+Close, normal, and loose metric clearance-hole diameters in millimetres.
+
+## Properties
+
+### close
+
+
+
+`readonly` **close**: `number`
+
+
+
+Close-fit clearance-hole diameter.
+
+***
+
+### loose
+
+
+
+`readonly` **loose**: `number`
+
+
+
+Loose-fit clearance-hole diameter.
+
+***
+
+### normal
+
+
+
+`readonly` **normal**: `number`
+
+
+
+Normal-fit clearance-hole diameter.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,7 @@
+# ClearanceHoleFit
+
+Common clearance-hole fit categories, ordered from smallest to largest.
+
+**ClearanceHoleFit** = `"close"` \| `"normal"` \| `"loose"`
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,53 @@
+# CompensatedThreadDiameters
+
+Compensated major/minor envelopes and the policy values used.
+
+## Properties
+
+### axialBacklash
+
+
+
+`readonly` **axialBacklash**: `number`
+
+
+
+Axial backlash from the selected policy.
+
+***
+
+### majorDiameter
+
+
+
+`readonly` **majorDiameter**: `number`
+
+
+
+Compensated major diameter in millimetres.
+
+***
+
+### minorDiameter
+
+
+
+`readonly` **minorDiameter**: `number`
+
+
+
+Compensated minor diameter in millimetres.
+
+***
+
+### radialShift
+
+
+
+`readonly` **radialShift**: `number`
+
+
+
+Signed radial shift: negative for male inset, positive for female outset.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,17 @@
+# Contour
+
+A closed two-dimensional boundary whose first point is not repeated at the end.
+
+**Contour** = readonly [`Vector2`](Vector2.md)[]
+
+
+
+Polygon exteriors are counter-clockwise and holes are clockwise. Algorithms
+may reject duplicate adjacent points or fewer than three effective vertices.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,35 @@
+# ContourCurve
+
+One explicitly closed planar contour, independent of editor metadata and parameter contracts.
+
+## Properties
+
+### start
+
+
+
+`readonly` **start**: [`ContourPoint`](ContourPoint.md)
+
+
+
+Initial anchor; coordinates may be any finite value.
+
+***
+
+### segments
+
+
+
+`readonly` **segments**: readonly [`ContourSegment`](ContourSegment.md)[]
+
+
+
+Ordered chain of 2–32 segments; the final end must exactly match start.
+
+
+## Related APIs
+
+- [ContourPoint](ContourPoint.md)
+- [ContourSegment](ContourSegment.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,29 @@
+# ContourPoint
+
+Planar X and upward Y in millimetres, or in units converted by sampling scales.
+
+## Properties
+
+### x
+
+
+
+`readonly` **x**: `number`
+
+
+
+Horizontal coordinate; physical scaling does not center the contour.
+
+***
+
+### y
+
+
+
+`readonly` **y**: `number`
+
+
+
+Upward planar coordinate.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,86 @@
+# ContourSegment
+
+Straight or cubic Bézier segment in one closed planar contour.
+
+**ContourSegment** = \{ `type`: `"line"`; `end`: [`ContourPoint`](ContourPoint.md); \} \| \{ `type`: `"cubic"`; `control1`: [`ContourPoint`](ContourPoint.md); `control2`: [`ContourPoint`](ContourPoint.md); `end`: [`ContourPoint`](ContourPoint.md); \}
+
+
+
+## Union Members
+
+### Type Literal
+
+\{ `type`: `"line"`; `end`: [`ContourPoint`](ContourPoint.md); \}
+
+#### type
+
+
+
+`readonly` **type**: `"line"`
+
+
+
+Straight segment discriminator.
+
+#### end
+
+
+
+`readonly` **end**: [`ContourPoint`](ContourPoint.md)
+
+
+
+Next anchor; the final anchor repeats the curve start.
+
+***
+
+### Type Literal
+
+\{ `type`: `"cubic"`; `control1`: [`ContourPoint`](ContourPoint.md); `control2`: [`ContourPoint`](ContourPoint.md); `end`: [`ContourPoint`](ContourPoint.md); \}
+
+#### type
+
+
+
+`readonly` **type**: `"cubic"`
+
+
+
+Cubic Bézier segment discriminator.
+
+#### control1
+
+
+
+`readonly` **control1**: [`ContourPoint`](ContourPoint.md)
+
+
+
+Outgoing control from the previous anchor.
+
+#### control2
+
+
+
+`readonly` **control2**: [`ContourPoint`](ContourPoint.md)
+
+
+
+Incoming control at the next anchor.
+
+#### end
+
+
+
+`readonly` **end**: [`ContourPoint`](ContourPoint.md)
+
+
+
+Next anchor; the final anchor repeats the curve start.
+
+
+## Related APIs
+
+- [ContourPoint](ContourPoint.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,46 @@
+# CorrespondingComponent
+
+One sampled component retaining contour identities and logical point correspondence.
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Stable canonical lowercase identity; unique within the containing topology or output.
+
+***
+
+### outer
+
+
+
+`readonly` **outer**: [`CorrespondingContour`](CorrespondingContour.md)
+
+
+
+Counterclockwise outer contour.
+
+***
+
+### holes
+
+
+
+`readonly` **holes**: readonly [`CorrespondingContour`](CorrespondingContour.md)[]
+
+
+
+Clockwise hole contours belonging to this component.
+
+
+## Related APIs
+
+- [CorrespondingContour](CorrespondingContour.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,46 @@
+# CorrespondingContour
+
+A sampled contour retaining logical slots, including intentionally collapsed spans.
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Stable canonical lowercase identity; unique within the containing topology or output.
+
+***
+
+### points
+
+
+
+`readonly` **points**: [`Contour`](Contour.md)
+
+
+
+Ordered sampled points in millimetres; closing vertices are implicit.
+
+***
+
+### spans
+
+
+
+`readonly` **spans**: readonly `string`[]
+
+
+
+One span identity per point; indices correspond between every matched family member.
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,22 @@
+# CorrespondingProfile
+
+Shared logical contour sampling suitable for a loft or hollow sweep.
+
+## Properties
+
+### components
+
+
+
+`readonly` **components**: readonly [`CorrespondingComponent`](CorrespondingComponent.md)[]
+
+
+
+Ordered components with explicit contour identities.
+
+
+## Related APIs
+
+- [CorrespondingComponent](CorrespondingComponent.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,27 @@
+# CorrespondingProfileStation
+
+One already matched profile at an explicit height or right-handed spatial frame.
+
+**CorrespondingProfileStation** = [`LoftPlacement`](LoftPlacement.md) & `object`
+
+
+
+## Type Declaration
+
+### profile
+
+
+
+`readonly` **profile**: [`CorrespondingProfile`](CorrespondingProfile.md)
+
+
+
+Already corresponding filled contours with authoritative landmark slots.
+
+
+## Related APIs
+
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [LoftPlacement](LoftPlacement.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,70 @@
+# CubicBezierCurve2
+
+Planar cubic Bézier with explicit endpoint and control coordinates.
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"cubic"`
+
+
+
+Selects a cubic Bézier through two endpoints and two controls.
+
+***
+
+### start
+
+
+
+`readonly` **start**: [`Vector2`](Vector2.md)
+
+
+
+Initial XY point in millimetres.
+
+***
+
+### control1
+
+
+
+`readonly` **control1**: [`Vector2`](Vector2.md)
+
+
+
+First XY control point in millimetres.
+
+***
+
+### control2
+
+
+
+`readonly` **control2**: [`Vector2`](Vector2.md)
+
+
+
+Second XY control point in millimetres.
+
+***
+
+### end
+
+
+
+`readonly` **end**: [`Vector2`](Vector2.md)
+
+
+
+Final XY point in millimetres.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.