@metamesh/modeling 0.18.0 → 0.19.0

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

@@ -1,43 +0,0 @@
-# Bounds2Data
-
-Plain axis-aligned XY bounds for interchange; use bounds2 for immutable measurement methods.
-
-## Extended by
-
-- [`Bounds2`](../geometry/Bounds2-type.md)
-
-## Properties
-
-### max
-
-
-
-`readonly` **max**: [`Vector2Data`](../geometry/Vector2Data.md)
-
-
-
-Inclusive maximum X/Y coordinates.
-
-***
-
-### min
-
-
-
-`readonly` **min**: [`Vector2Data`](../geometry/Vector2Data.md)
-
-
-
-Inclusive minimum X/Y coordinates.
-
-
-## Related APIs
-
-- [Bounds2](Bounds2.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/Bounds2Input.md

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

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

@@ -1,125 +0,0 @@
-# Bounds3
-
-Immutable finite XYZ bounds in millimetres, with tuple coordinates for data interoperability.
-
-## Extends
-
-- [`Bounds3Data`](../geometry/Bounds3Data.md)
-
-## Properties
-
-### max
-
-
-
-`readonly` **max**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-Inclusive maximum X/Y/Z coordinates.
-
-#### Inherited from
-
-[`Bounds3Data`](../geometry/Bounds3Data.md).[`max`](../geometry/Bounds3Data.md#max)
-
-***
-
-### min
-
-
-
-`readonly` **min**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-Inclusive minimum X/Y/Z coordinates.
-
-#### Inherited from
-
-[`Bounds3Data`](../geometry/Bounds3Data.md).[`min`](../geometry/Bounds3Data.md#min)
-
-## Methods
-
-### size()
-
-
-
-**size**(): [`Vector3`](../geometry/Vector3-type.md)
-
-
-
-Returns nonnegative X/Y/Z dimensions in millimetres, including zero extents.
-
-#### Returns
-
-[`Vector3`](../geometry/Vector3-type.md)
-
-***
-
-### center()
-
-
-
-**center**(): [`Vector3`](../geometry/Vector3-type.md)
-
-
-
-Returns the midpoint in millimetres.
-
-#### Returns
-
-[`Vector3`](../geometry/Vector3-type.md)
-
-***
-
-### containsBounds()
-
-
-
-**containsBounds**(`other`: [`Bounds3Input`](../geometry/Bounds3Input.md)): `boolean`
-
-
-
-Tests positioned XYZ containment, including touching boundaries.
-
-#### Parameters
-
-<a id="other"></a>
-
-**`other`** · [`Bounds3Input`](../geometry/Bounds3Input.md) · Required
-
-
-
-#### Returns
-
-`boolean`
-
-***
-
-### toData()
-
-
-
-**toData**(): [`Bounds3Data`](../geometry/Bounds3Data.md)
-
-
-
-Returns this value's frozen plain record; repeated calls do not allocate.
-
-#### Returns
-
-[`Bounds3Data`](../geometry/Bounds3Data.md)
-
-
-## Related APIs
-
-- [Bounds3Data](Bounds3Data.md)
-- [Bounds3Input](Bounds3Input.md)
-- [Vector3](Vector3.md)
-- [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/Bounds3Data.md

@@ -1,43 +0,0 @@
-# Bounds3Data
-
-Plain axis-aligned XYZ bounds for interchange; use bounds3 for immutable measurement methods.
-
-## Extended by
-
-- [`Bounds3`](../geometry/Bounds3-type.md)
-
-## Properties
-
-### max
-
-
-
-`readonly` **max**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-Inclusive maximum X/Y/Z coordinates.
-
-***
-
-### min
-
-
-
-`readonly` **min**: [`Vector3Data`](../geometry/Vector3Data.md)
-
-
-
-Inclusive minimum X/Y/Z coordinates.
-
-
-## Related APIs
-
-- [Bounds3](Bounds3.md)
-- [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/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/ExtrudeMeshOptions.md

@@ -1,129 +0,0 @@
-# ExtrudeMeshOptions
-
-Dimensions and sampling for pure +Z mesh extrusion, without end treatments.
-
-## Extends
-
-- [`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md)
-
-## Extended by
-
-- [`ExtrudeOptions`](../geometry/ExtrudeOptions.md)
-
-## Properties
-
-### height
-
-
-
-`readonly` **height**: `number`
-
-
-
-Positive extrusion height in millimetres.
-
-***
-
-### center?
-
-
-
-`readonly` `optional` **center?**: `boolean`
-
-
-
-Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
-
-***
-
-### divisions?
-
-
-
-`readonly` `optional` **divisions?**: `number`
-
-
-
-Exact number of intermediate profiles, nonnegative; overrides physical sampling.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`divisions`](../geometry/ExtrusionSamplingOptions.md#divisions)
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\>
-
-
-
-Explicit output and sampling allocation ceilings.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`limits`](../geometry/ExtrusionSamplingOptions.md#limits)
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](../geometry/GeometryResolution.md)
-
-
-
-Operation-level physical policy over the nearest model scope.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`resolution`](../geometry/ExtrusionSamplingOptions.md#resolution)
-
-***
-
-### scaleTop?
-
-
-
-`readonly` `optional` **scaleTop?**: `number` \| [`Vector2Input`](../geometry/Vector2Input.md)
-
-
-
-Finite uniform or XY scale of the top profile; defaults to one.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`scaleTop`](../geometry/ExtrusionSamplingOptions.md#scaletop)
-
-***
-
-### twist?
-
-
-
-`readonly` `optional` **twist?**: `number`
-
-
-
-Finite rotation of the top profile about +Z, in degrees; defaults to zero.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](../geometry/ExtrusionSamplingOptions.md).[`twist`](../geometry/ExtrusionSamplingOptions.md#twist)
-
-
-## Related APIs
-
-- [ExtrusionSamplingOptions](ExtrusionSamplingOptions.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`.