@metamesh/modeling 0.12.0 → 0.13.0

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

@@ -0,0 +1,71 @@
+# SampleSideProfileOptions
+
+Physical scaling and bounded adaptive subdivision for an open profile.
+
+## Properties
+
+### radiusScale?
+
+
+
+`readonly` `optional` **radiusScale?**: `number`
+
+
+
+Positive radius scale; use the desired maximum radius for normalized coordinates. Defaults to 1.
+
+***
+
+### heightScale?
+
+
+
+`readonly` `optional` **heightScale?**: `number`
+
+
+
+Positive height scale; use the desired total height for normalized coordinates. Defaults to 1.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Shared physical policy, evaluated after scaling; exact circular counts do not affect curves.
+
+***
+
+### maximumVertices?
+
+
+
+`readonly` `optional` **maximumVertices?**: `number`
+
+
+
+Maximum output vertex count within maxProfilePoints. Defaults to the smaller of 4096 and that ceiling.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit profile and circular allocation ceilings.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,34 @@
+# SampledCurve2
+
+Immutable planar points and corresponding directed unit tangents.
+
+## Properties
+
+### points
+
+
+
+`readonly` **points**: readonly [`Vector2`](Vector2.md)[]
+
+
+
+Curves retain both endpoints, including full-circle seams; closed resampling omits its seam.
+
+***
+
+### tangents
+
+
+
+`readonly` **tangents**: readonly [`Vector2`](Vector2.md)[]
+
+
+
+Directed unit vectors; stationary derivatives use the nearest usable direction.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,34 @@
+# SampledCurve3
+
+Immutable spatial points and corresponding directed unit tangents.
+
+## Properties
+
+### points
+
+
+
+`readonly` **points**: readonly [`Vector3`](Vector3.md)[]
+
+
+
+Curves retain both endpoints, including full-circle seams; closed resampling omits its seam.
+
+***
+
+### tangents
+
+
+
+`readonly` **tangents**: readonly [`Vector3`](Vector3.md)[]
+
+
+
+Directed unit vectors; stationary derivatives use the nearest usable direction.
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,58 @@
+# SampledThreadHelices
+
+Sampled paths plus conventional pitch and lead measurements.
+
+## Properties
+
+### lead
+
+
+
+`readonly` **lead**: `number`
+
+
+
+Axial advance over one revolution, equal to `pitch * starts`.
+
+***
+
+### paths
+
+
+
+`readonly` **paths**: readonly [`Path3`](Path3.md)[]
+
+
+
+One immutable sampled path for each thread start.
+
+***
+
+### pitch
+
+
+
+`readonly` **pitch**: `number`
+
+
+
+Adjacent axial thread spacing in millimetres.
+
+***
+
+### turns
+
+
+
+`readonly` **turns**: `number`
+
+
+
+Number of revolutions represented by each path.
+
+
+## Related APIs
+
+- [Path3](Path3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,35 @@
+# SideProfileCurve
+
+An open radius/height outline; consumers own closure, mounting geometry, and wall policy.
+
+## Properties
+
+### start
+
+
+
+`readonly` **start**: [`SideProfilePoint`](SideProfilePoint.md)
+
+
+
+Initial radius/height anchor.
+
+***
+
+### segments
+
+
+
+`readonly` **segments**: readonly [`SideProfileSegment`](SideProfileSegment.md)[]
+
+
+
+Ordered chain of 1–31 straight or cubic segments.
+
+
+## Related APIs
+
+- [SideProfilePoint](SideProfilePoint.md)
+- [SideProfileSegment](SideProfileSegment.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,29 @@
+# SideProfilePoint
+
+Radius and upward height in millimetres, or in units converted by sampling scales.
+
+## Properties
+
+### radius
+
+
+
+`readonly` **radius**: `number`
+
+
+
+Nonnegative distance from the revolution axis.
+
+***
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Upward axial coordinate; anchors progress strictly upward.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,86 @@
+# SideProfileSegment
+
+One straight or cubic segment of an open, upward-progressing radius/height outline.
+
+**SideProfileSegment** = \{ `type`: `"line"`; `end`: [`SideProfilePoint`](SideProfilePoint.md); \} \| \{ `type`: `"cubic"`; `control1`: [`SideProfilePoint`](SideProfilePoint.md); `control2`: [`SideProfilePoint`](SideProfilePoint.md); `end`: [`SideProfilePoint`](SideProfilePoint.md); \}
+
+
+
+## Union Members
+
+### Type Literal
+
+\{ `type`: `"line"`; `end`: [`SideProfilePoint`](SideProfilePoint.md); \}
+
+#### type
+
+
+
+`readonly` **type**: `"line"`
+
+
+
+Straight segment discriminator.
+
+#### end
+
+
+
+`readonly` **end**: [`SideProfilePoint`](SideProfilePoint.md)
+
+
+
+Next strictly higher anchor.
+
+***
+
+### Type Literal
+
+\{ `type`: `"cubic"`; `control1`: [`SideProfilePoint`](SideProfilePoint.md); `control2`: [`SideProfilePoint`](SideProfilePoint.md); `end`: [`SideProfilePoint`](SideProfilePoint.md); \}
+
+#### type
+
+
+
+`readonly` **type**: `"cubic"`
+
+
+
+Cubic Bézier segment discriminator.
+
+#### control1
+
+
+
+`readonly` **control1**: [`SideProfilePoint`](SideProfilePoint.md)
+
+
+
+Outgoing control, with height between the start and second control.
+
+#### control2
+
+
+
+`readonly` **control2**: [`SideProfilePoint`](SideProfilePoint.md)
+
+
+
+Incoming control, with height between the first control and end.
+
+#### end
+
+
+
+`readonly` **end**: [`SideProfilePoint`](SideProfilePoint.md)
+
+
+
+Next strictly higher anchor.
+
+
+## Related APIs
+
+- [SideProfilePoint](SideProfilePoint.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,71 @@
+# SmoothEdgeTreatment
+
+A cubic corner transition with zero curvature at its straight tangent joins.
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"smooth"`
+
+
+
+Selects continuous-curvature cubic rounding, rather than a circular radius.
+
+***
+
+### distance
+
+
+
+`readonly` **distance**: `number` \| readonly \[`number`, `number`\]
+
+
+
+Millimetre setbacks, equal or [first, second]; zero or [0, 0] leaves the edge untreated, otherwise both must be positive.
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact cubic interval count, positive; overrides physical sampling.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Physical chord/edge-length sampling; circularSegments does not describe a cubic.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings, bounded by the host policy.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,34 @@
+# SolidMeshValidationOptions
+
+Bounded floating-point intersection and shell-orientation validation settings.
+
+## Properties
+
+### maximumTests?
+
+
+
+`readonly` `optional` **maximumTests?**: `number`
+
+
+
+Work ceiling for spatial comparisons and containment tests; defaults to 2,000,000 and may only lower it.
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Distance comparison policy in millimetres; near contacts reject conservatively.
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,15 @@
+# SphereOptions
+
+Exactly one radius or diameter, placement, and tessellation for an origin-centered sphere.
+
+**SphereOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`PrimitivePlacement`](PrimitivePlacement.md) & (\{ `radius`: `number`; `diameter?`: `never`; \} \| \{ `diameter`: `number`; `radius?`: `never`; \})
+
+
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [PrimitivePlacement](PrimitivePlacement.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,75 @@
+# SquareThreadProfileSpec
+
+Square profile with equal crest and root widths.
+
+## Extends
+
+- [`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md)
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"square"`
+
+
+
+Selects the square profile family.
+
+***
+
+### depth?
+
+
+
+`readonly` `optional` **depth?**: `number`
+
+
+
+Radial depth in millimetres.
+
+#### Default Value
+
+`pitch / 2`
+
+***
+
+### 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
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,7 @@
+# StrokePathCap
+
+End-cap treatment for an open stroked path.
+
+**StrokePathCap** = `"butt"` \| `"round"` \| `"square"`
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,7 @@
+# StrokePathJoin
+
+Join treatment where adjacent stroked path segments meet.
+
+**StrokePathJoin** = `"bevel"` \| `"miter"` \| `"round"`
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,85 @@
+# StrokePathRegionOptions
+
+Physical stroke and topology controls for strokePathRegion.
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit path, circular and expanded-profile allocation ceilings.
+
+***
+
+### closed?
+
+
+
+`readonly` `optional` **closed?**: `boolean`
+
+
+
+Treat the path as a closed non-duplicated loop. Default: `false`.
+
+***
+
+### cap?
+
+
+
+`readonly` `optional` **cap?**: [`StrokePathCap`](StrokePathCap.md)
+
+
+
+End-cap treatment for an open path. Ignored for closed paths. Default: `butt`.
+
+***
+
+### join?
+
+
+
+`readonly` `optional` **join?**: [`StrokePathJoin`](StrokePathJoin.md)
+
+
+
+Corner treatment; miters exceeding SVG's default limit of 4 become bevels. Default: `miter`.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Physical tessellation policy for round caps and joins.
+
+***
+
+### width
+
+
+
+`readonly` **width**: `number`
+
+
+
+Positive total stroke width in millimetres, centered on the sampled path.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [StrokePathCap](StrokePathCap.md)
+- [StrokePathJoin](StrokePathJoin.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,60 @@
+# SvgImportOptions
+
+Sampling controls for deterministic SVG-to-region conversion.
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit profile and circular allocation ceilings; bounded SVG source/work limits remain fixed.
+
+***
+
+### circularSegments?
+
+
+
+`readonly` `optional` **circularSegments?**: `number`
+
+
+
+Exact segments for a complete ellipse or round stroke feature.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical tessellation policy over the active model-wide policy.
+
+***
+
+### origin?
+
+
+
+`readonly` `optional` **origin?**: `"center"` \| `"document"`
+
+
+
+`"center"` places the viewport center at the origin. `"document"` places its converted
+lower-left corner at the origin. Default: `"center"`.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+Package: `@metamesh/modeling@0.13.0`.