@metamesh/modeling 0.18.0 → 0.20.0

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

@@ -1,19 +0,0 @@
-# Bounds3Input
-
-An immutable XYZ bounds value or its plain min/max representation.
-
-**Bounds3Input** = [`Bounds3`](../geometry/Bounds3-type.md) \| [`Bounds3Data`](../geometry/Bounds3Data.md)
-
-
-
-
-## Related APIs
-
-- [Bounds3](Bounds3.md)
-- [Bounds3Data](Bounds3Data.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,14 +0,0 @@
-# ButtressPressureFlankSide
-
-Axial side carrying the near-normal pressure flank of a buttress thread.
-
-**ButtressPressureFlankSide** = `"negative"` \| `"positive"`
-
-
-
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,97 +0,0 @@
-# ButtressThreadProfileSpec
-
-Asymmetric printable buttress profile with 7/45-degree flanks.
-
-## Extends
-
-- [`ThreadProfileBaseSpec`](../geometry/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`](../geometry/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`](../geometry/ThreadProfileBaseSpec.md).[`pitch`](../geometry/ThreadProfileBaseSpec.md#pitch)
-
-***
-
-### tolerance?
-
-
-
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
-
-
-
-Optional numerical tolerance overrides.
-
-#### Inherited from
-
-[`ThreadProfileBaseSpec`](../geometry/ThreadProfileBaseSpec.md).[`tolerance`](../geometry/ThreadProfileBaseSpec.md#tolerance)
-
-
-## Related APIs
-
-- [ButtressPressureFlankSide](ButtressPressureFlankSide.md)
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,60 +0,0 @@
-# CircularPrimitiveOptions
-
-Tessellation controls shared by circular primitives across Geometry entry points.
-
-## Extended by
-
-- [`RevolveOptions`](../geometry/RevolveOptions.md)
-- [`RoundedEdgeTreatment`](../geometry/RoundedEdgeTreatment.md)
-
-## Properties
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](../geometry/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`](../geometry/GeometryResolution.md)
-
-
-
-Operation-level physical tessellation policy over the active model-wide policy.
-
-
-## Related APIs
-
-- [GeometryResolution](GeometryResolution.md)
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [RevolveOptions](RevolveOptions.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/mesh/CurveSamplingOptions.md

@@ -1,69 +0,0 @@
-# CurveSamplingOptions
-
-Explicit physical sampling and allocation policy for reusable curves.
-
-## Extended by
-
-- [`PathResamplingOptions`](../geometry/PathResamplingOptions.md)
-- [`PolylineResamplingOptions`](../geometry/PolylineResamplingOptions.md)
-
-## Properties
-
-### segments?
-
-
-
-`readonly` `optional` **segments?**: `number`
-
-
-
-Exact segment count overrides physical criteria; curve parameters are spaced uniformly.
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](../geometry/GeometryResolution.md)
-
-
-
-Millimetre sampling policy; circularSegments applies only to arcs.
-
-***
-
-### maxVertices?
-
-
-
-`readonly` `optional` **maxVertices?**: `number`
-
-
-
-Output vertex ceiling of at least two; may only lower limits.maxPathPoints.
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\>
-
-
-
-Explicit sampling ceilings; omitted values use package defaults without ambient state.
-
-
-## Related APIs
-
-- [GeometryResolution](GeometryResolution.md)
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [PathResamplingOptions](PathResamplingOptions.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/mesh/CustomThreadProfileSpec.md

@@ -1,77 +0,0 @@
-# CustomThreadProfileSpec
-
-Caller-defined periodic axial/radial profile in millimetres.
-
-## Extends
-
-- [`ThreadProfileBaseSpec`](../geometry/ThreadProfileBaseSpec.md)
-
-## Properties
-
-### kind
-
-
-
-`readonly` **kind**: `"custom"`
-
-
-
-Selects a caller-defined periodic profile.
-
-***
-
-### points
-
-
-
-`readonly` **points**: readonly [`Vector2Data`](../geometry/Vector2Data.md)[]
-
-
-
-Open path spanning exactly `[-pitch/2, pitch/2]`, with both endpoints on the minor envelope,
-one connected ridge, one contiguous crest, and radial zero at the major envelope.
-
-***
-
-### pitch
-
-
-
-`readonly` **pitch**: `number`
-
-
-
-Adjacent axial thread spacing in millimetres.
-
-#### Inherited from
-
-[`ThreadProfileBaseSpec`](../geometry/ThreadProfileBaseSpec.md).[`pitch`](../geometry/ThreadProfileBaseSpec.md#pitch)
-
-***
-
-### tolerance?
-
-
-
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
-
-
-
-Optional numerical tolerance overrides.
-
-#### Inherited from
-
-[`ThreadProfileBaseSpec`](../geometry/ThreadProfileBaseSpec.md).[`tolerance`](../geometry/ThreadProfileBaseSpec.md#tolerance)
-
-
-## Related APIs
-
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
-- [Vector2Data](Vector2Data.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/mesh/ExtrusionSamplingOptions.md

@@ -1,81 +0,0 @@
-# ExtrusionSamplingOptions
-
-Shared sampling controls for a twisted or scaled linear extrusion.
-
-## Extended by
-
-- [`ExtrudeMeshOptions`](../geometry/ExtrudeMeshOptions.md)
-
-## Properties
-
-### divisions?
-
-
-
-`readonly` `optional` **divisions?**: `number`
-
-
-
-Exact number of intermediate profiles, nonnegative; overrides physical sampling.
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\>
-
-
-
-Explicit output and sampling allocation ceilings.
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](../geometry/GeometryResolution.md)
-
-
-
-Operation-level physical policy over the nearest model scope.
-
-***
-
-### scaleTop?
-
-
-
-`readonly` `optional` **scaleTop?**: `number` \| [`Vector2Input`](../geometry/Vector2Input.md)
-
-
-
-Finite uniform or XY scale of the top profile; defaults to one.
-
-***
-
-### twist?
-
-
-
-`readonly` `optional` **twist?**: `number`
-
-
-
-Finite rotation of the top profile about +Z, in degrees; defaults to zero.
-
-
-## Related APIs
-
-- [ExtrudeMeshOptions](ExtrudeMeshOptions.md)
-- [GeometryResolution](GeometryResolution.md)
-- [ModelingLimits](ModelingLimits.md)
-- [Vector2Input](Vector2Input.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/mesh/Frame3.md

@@ -1,62 +0,0 @@
-# Frame3
-
-A right-handed orthonormal coordinate frame expressed in world coordinates.
-
-## Properties
-
-### origin
-
-
-
-`readonly` **origin**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-World-space origin of the local frame.
-
-***
-
-### xAxis
-
-
-
-`readonly` **xAxis**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-Unit vector defining the local +X axis.
-
-***
-
-### yAxis
-
-
-
-`readonly` **yAxis**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-Unit vector defining the local +Y axis.
-
-***
-
-### zAxis
-
-
-
-`readonly` **zAxis**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-Unit vector defining the local +Z axis.
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/mesh/GeometryResolution.md

@@ -1,74 +0,0 @@
-# GeometryResolution
-
-Tessellation policy for sampled geometry measured in millimetres.
-
-## Extended by
-
-- [`CircularResolutionOptions`](../geometry/CircularResolutionOptions.md)
-
-## Properties
-
-### circularSegments?
-
-
-
-`readonly` `optional` **circularSegments?**: `number`
-
-
-
-Optional exact full-circle segment count, of at least three, bounded by the selected circular ceiling.
-
-***
-
-### maxChordError?
-
-
-
-`readonly` `optional` **maxChordError?**: `number`
-
-
-
-Maximum radial chord error in millimetres; defaults to 0.05.
-
-***
-
-### maxSegmentLength?
-
-
-
-`readonly` `optional` **maxSegmentLength?**: `number`
-
-
-
-Optional maximum sampled edge length in millimetres.
-
-***
-
-### maxSegments?
-
-
-
-`readonly` `optional` **maxSegments?**: `number`
-
-
-
-Upper safety bound for a full circle; defaults to the selected maxCircularSegments (512 by default).
-
-***
-
-### minSegments?
-
-
-
-`readonly` `optional` **minSegments?**: `number`
-
-
-
-Lower full-circle segment count; defaults to 16 or a lower selected circular ceiling.
-
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/mesh/GeometrySamplingLimits.md

@@ -1,66 +0,0 @@
-# GeometrySamplingLimits
-
-Explicit allocation ceilings for pure sampling and host-owned modeling operations.
-
-## Extended by
-
-- [`ModelingLimits`](../geometry/ModelingLimits.md)
-
-## Properties
-
-### maxPathPoints
-
-
-
-`readonly` **maxPathPoints**: `number`
-
-
-
-Maximum points in one sampled path or placement/frame result.
-
-***
-
-### maxProfilePoints
-
-
-
-`readonly` **maxProfilePoints**: `number`
-
-
-
-Maximum aggregate points in one sampled profile or Section.
-
-***
-
-### maxSweepProfilePoints
-
-
-
-`readonly` **maxSweepProfilePoints**: `number`
-
-
-
-Maximum points in one profile swept along a path.
-
-***
-
-### maxCircularSegments
-
-
-
-`readonly` **maxCircularSegments**: `number`
-
-
-
-Maximum segments around one complete circle.
-
-
-## Related APIs
-
-- [ModelingLimits](ModelingLimits.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/mesh/GeometryToleranceOptions.md

@@ -1,46 +0,0 @@
-# GeometryToleranceOptions
-
-Optional overrides for MetaMesh's geometry comparison policy.
-
-## Properties
-
-### absolute?
-
-
-
-`readonly` `optional` **absolute?**: `number`
-
-
-
-Absolute distance floor in model units. Must be finite and greater than zero.
-
-***
-
-### angular?
-
-
-
-`readonly` `optional` **angular?**: `number`
-
-
-
-Angular comparison threshold in radians. Must be finite and greater than zero.
-
-***
-
-### relative?
-
-
-
-`readonly` `optional` **relative?**: `number`
-
-
-
-Dimensionless scale multiplier. Must be finite and non-negative.
-
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.