@metamesh/modeling 0.17.0 → 0.19.0

package/dist/docs/reference/model/Path3Data.md

@@ -1,50 +0,0 @@
-# Path3Data
-
-Complete plain XYZ path representation, including topology and empty-path dimensional identity.
-
-## Properties
-
-### dimension
-
-
-
-`readonly` **dimension**: `3`
-
-
-
-Coordinate dimension, retained even when points is empty.
-
-***
-
-### points
-
-
-
-`readonly` **points**: readonly [`Vector3Data`](Vector3Data.md)[]
-
-
-
-Frozen or caller-owned XYZ coordinates; closed paths omit a duplicated seam.
-
-***
-
-### closed
-
-
-
-`readonly` **closed**: `boolean`
-
-
-
-Whether traversal includes the last-to-first edge.
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/Path3Input.md

@@ -1,20 +0,0 @@
-# Path3Input
-
-A matching path value, complete plain path data, or a collection of vectors.
-
-**Path3Input** = [`Path3`](Path3-type.md) \| [`Path3Data`](Path3Data.md) \| readonly [`Vector3Input`](Vector3Input.md)[]
-
-
-
-
-## Related APIs
-
-- [Path3](Path3-type.md)
-- [Path3Data](Path3Data.md)
-- [Vector3Input](Vector3Input.md)
-
-## Guides
-
-- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PathLocation.md

@@ -1,69 +0,0 @@
-# PathLocation
-
-Nearest location on a sampled boundary, rather than inside a filled shape or on an analytic curve.
-
-## Type Parameters
-
-### Point
-
-`Point` *extends* [`Vector2`](Vector2-type.md) \| [`Vector3`](Vector3-type.md)
-
-## Properties
-
-### point
-
-
-
-`readonly` **point**: `Point`
-
-
-
-Immutable position on the selected edge.
-
-***
-
-### distance
-
-
-
-`readonly` **distance**: `number`
-
-
-
-Euclidean distance from the query in model units.
-
-***
-
-### edgeIndex
-
-
-
-`readonly` **edgeIndex**: `number`
-
-
-
-Starting vertex of the selected edge; ties keep the first edge in traversal order.
-
-***
-
-### fraction
-
-
-
-`readonly` **fraction**: `number`
-
-
-
-Clamped fraction along that edge, not the whole path's normalized arc length.
-
-
-## Related APIs
-
-- [Vector2](Vector2-type.md)
-- [Vector3](Vector3-type.md)
-
-## Guides
-
-- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PathNormalGuide.md

@@ -1,46 +0,0 @@
-# PathNormalGuide
-
-Supplies a profile-X orientation guide for each original normalized sweep station.
-
-**PathNormalGuide** = (`point`: [`Vector3Data`](Vector3Data.md), `index`: `number`) => [`Vector3Input`](Vector3Input.md)
-
-
-
-## Parameters
-
-<a id="point"></a>
-
-**`point`** · [`Vector3Data`](Vector3Data.md) · Required
-
-Current XYZ path point in model units.
-
-
-
-<a id="index"></a>
-
-**`index`** · `number` · Required
-
-Zero-based index of `point` in the normalized authored sweep path.
-
-
-
-## Returns
-
-[`Vector3Input`](Vector3Input.md)
-
-A finite guide vector that is not parallel to the local path tangent.
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-- [Vector3Input](Vector3Input.md)
-
-## Guides
-
-- [Revolve a radial profile](../../guides/recipes.md#revolve-a-radial-profile)
-- [Rotation-minimizing path sweep](../../guides/recipes.md#rotation-minimizing-path-sweep)
-- [Matched-section loft](../../guides/recipes.md#matched-section-loft)
-- [Choose a modeling path](../../guides/concepts.md#choose-a-modeling-path)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PathOptions.md

@@ -1,38 +0,0 @@
-# PathOptions
-
-Topology and allocation ceiling for an immutable sampled path.
-
-## Properties
-
-### closed?
-
-
-
-`readonly` `optional` **closed?**: `boolean`
-
-
-
-Connects the last vertex to the first; closed paths omit the repeated seam. Defaults to false.
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
-
-
-
-Construction point ceiling; defaults to package sampling limits. Later sampling has its own options.
-
-
-## Related APIs
-
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-
-## Guides
-
-- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PathPatternOptions.md

@@ -1,48 +0,0 @@
-# PathPatternOptions
-
-Equal physical arc-length placements along an open or implicitly closed sampled path.
-
-## Properties
-
-### count
-
-
-
-`readonly` **count**: `number`
-
-
-
-Positive number of copies; open paths include both endpoints when greater than one.
-
-***
-
-### closed?
-
-
-
-`readonly` `optional` **closed?**: `boolean`
-
-
-
-Raw point closure defaults to false; a path value supplies closure and rejects conflicts.
-
-***
-
-### orientation?
-
-
-
-`readonly` `optional` **orientation?**: `"fixed"` \| `"tangent"`
-
-
-
-Preserve orientation, or align local +X for Sections / +Z for Solids to the tangent. Defaults to fixed.
-
-
-## Guides
-
-- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
-- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PathResamplingOptions.md

@@ -1,83 +0,0 @@
-# PathResamplingOptions
-
-Equal arc-length sampling; the path itself owns whether its closing edge is included.
-
-## Extends
-
-- `CurveSamplingOptions`
-
-## Properties
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-
-
-
-Millimetre sampling policy; circularSegments applies only to arcs.
-
-#### Inherited from
-
-`CurveSamplingOptions.resolution`
-
-***
-
-### maxVertices?
-
-
-
-`readonly` `optional` **maxVertices?**: `number`
-
-
-
-Output vertex ceiling of at least two; may only lower limits.maxPathPoints.
-
-#### Inherited from
-
-`CurveSamplingOptions.maxVertices`
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
-
-
-
-Explicit sampling ceilings; omitted values use package defaults without ambient state.
-
-#### Inherited from
-
-`CurveSamplingOptions.limits`
-
-***
-
-### segments?
-
-
-
-`readonly` `optional` **segments?**: `number`
-
-
-
-Exact arc-length intervals; closed paths need at least three. Otherwise physical resolution or the effective source edge count controls sampling.
-
-#### Overrides
-
-`CurveSamplingOptions.segments`
-
-
-## Related APIs
-
-- [GeometryResolution](GeometryResolution.md)
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-
-## Guides
-
-- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/Pivot2Options.md

@@ -1,28 +0,0 @@
-# Pivot2Options
-
-A fixed XY point in world coordinates; omitted pivots use the coordinate origin.
-
-## Properties
-
-### pivot?
-
-
-
-`readonly` `optional` **pivot?**: [`Vector2Input`](Vector2Input.md)
-
-
-
-World-space point left fixed by rotation or scaling.
-
-
-## Related APIs
-
-- [Vector2Input](Vector2Input.md)
-
-## Guides
-
-- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
-- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/Pivot3Options.md

@@ -1,28 +0,0 @@
-# Pivot3Options
-
-A fixed XYZ point in world coordinates; omitted pivots use the coordinate origin.
-
-## Properties
-
-### pivot?
-
-
-
-`readonly` `optional` **pivot?**: [`Vector3Input`](Vector3Input.md)
-
-
-
-World-space point left fixed by rotation or scaling.
-
-
-## Related APIs
-
-- [Vector3Input](Vector3Input.md)
-
-## Guides
-
-- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
-- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PolygonData.md

@@ -1,44 +0,0 @@
-# PolygonData
-
-One filled two-dimensional polygon with an exterior and optional holes.
-
-`outer` is counter-clockwise and each hole is clockwise. Boundary arrays omit
-their duplicated closing point. Holes must lie inside `outer` and must not
-intersect each other or the exterior.
-
-## Properties
-
-### holes
-
-
-
-`readonly` **holes**: readonly [`Contour`](Contour.md)[]
-
-
-
-Clockwise interior boundaries, each omitting its duplicated closing point.
-
-***
-
-### outer
-
-
-
-`readonly` **outer**: [`Contour`](Contour.md)
-
-
-
-Counter-clockwise exterior boundary, omitting its duplicated closing point.
-
-
-## Related APIs
-
-- [Contour](Contour.md)
-- [RegionData](RegionData.md)
-
-## Guides
-
-- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PrimitiveAttachment.md

@@ -1,41 +0,0 @@
-# PrimitiveAttachment
-
-Anchor attachment shared by solid and filled-section factories.
-
-## Extended by
-
-- [`BoxOptions`](BoxOptions.md)
-- [`RectangleOptions`](RectangleOptions.md)
-- [`StarOptions`](StarOptions.md)
-- [`TorusOptions`](TorusOptions.md)
-- [`TubeOptions`](TubeOptions.md)
-
-## Properties
-
-### attachment?
-
-
-
-`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
-
-
-
-Applied after local construction; Section attachment must preserve the XY plane.
-
-
-## Related APIs
-
-- [BoxOptions](BoxOptions.md)
-- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
-- [RectangleOptions](RectangleOptions.md)
-- [StarOptions](StarOptions.md)
-- [TorusOptions](TorusOptions.md)
-- [TubeOptions](TubeOptions.md)
-
-## Guides
-
-- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
-- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PrimitiveAttachmentOptions.md

@@ -1,110 +0,0 @@
-# PrimitiveAttachmentOptions
-
-Maps an explicit or named shape-local attachment anchor onto a world-space anchor.
-
-## Extends
-
-- [`AttachOptions`](AttachOptions.md)
-
-## Properties
-
-### alignment?
-
-
-
-`readonly` `optional` **alignment?**: `"opposed"` \| `"same"`
-
-
-
-Align outward directions face-to-face (`opposed`) or in parallel (`same`).
-
-#### Inherited from
-
-[`AttachOptions`](AttachOptions.md).[`alignment`](AttachOptions.md#alignment)
-
-***
-
-### gap?
-
-
-
-`readonly` `optional` **gap?**: `number`
-
-
-
-Separation along the target anchor's outward direction in model units.
-
-#### Inherited from
-
-[`AttachOptions`](AttachOptions.md).[`gap`](AttachOptions.md#gap)
-
-***
-
-### spin?
-
-
-
-`readonly` `optional` **spin?**: `number`
-
-
-
-Additional right-handed roll about the attached direction, in degrees.
-
-#### Inherited from
-
-[`AttachOptions`](AttachOptions.md).[`spin`](AttachOptions.md#spin)
-
-***
-
-### tolerance?
-
-
-
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
-
-
-
-Optional numeric comparison overrides.
-
-#### Inherited from
-
-[`AttachOptions`](AttachOptions.md).[`tolerance`](AttachOptions.md#tolerance)
-
-***
-
-### source
-
-
-
-`readonly` **source**: `string` \| [`Anchor3`](Anchor3.md)
-
-
-
-Shape-local source frame or a named primitive anchor such as bottom.
-
-***
-
-### target
-
-
-
-`readonly` **target**: [`Anchor3`](Anchor3.md)
-
-
-
-World-space target frame in millimetres.
-
-
-## Related APIs
-
-- [Anchor3](Anchor3.md)
-- [AttachOptions](AttachOptions.md)
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-
-## Guides
-
-- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
-- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PrintableThreadFit.md

@@ -1,15 +0,0 @@
-# PrintableThreadFit
-
-Named baseline fit policies for calibrated FDM-style printed threads.
-
-**PrintableThreadFit** = `"tight"` \| `"normal"` \| `"loose"`
-
-
-
-
-## Guides
-
-- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
-- [Preflight guarantees and host settings](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.

package/dist/docs/reference/model/PrintableThreadFitPolicy.md

@@ -1,51 +0,0 @@
-# PrintableThreadFitPolicy
-
-Explicit radial and axial allowances for a mating printed thread pair.
-
-Male and female radial values are applied independently, so their sum is the
-assembled radial clearance. Values are millimetres and intentionally do not
-encode printer, material, or process calibration.
-
-## Properties
-
-### axialBacklash
-
-
-
-`readonly` **axialBacklash**: `number`
-
-
-
-Nominal axial backlash available between opposing flanks.
-
-***
-
-### femaleRadialOutset
-
-
-
-`readonly` **femaleRadialOutset**: `number`
-
-
-
-Radial increase applied to an internal thread envelope.
-
-***
-
-### maleRadialInset
-
-
-
-`readonly` **maleRadialInset**: `number`
-
-
-
-Radial reduction applied to an external thread envelope.
-
-
-## Guides
-
-- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
-- [Preflight guarantees and host settings](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.17.0`.