@metamesh/modeling 0.18.0 → 0.19.0

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

@@ -1,22 +0,0 @@
-# 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.18.0`.

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

@@ -1,27 +0,0 @@
-# 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.18.0`.

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

@@ -1,68 +0,0 @@
-# CurveSamplingOptions
-
-Explicit physical sampling and allocation policy for reusable curves.
-
-## Extended by
-
-- [`PathResamplingOptions`](PathResamplingOptions.md)
-
-## Properties
-
-### segments?
-
-
-
-`readonly` `optional` **segments?**: `number`
-
-
-
-Exact segment count overrides physical criteria; curve parameters are spaced uniformly.
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](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`](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
-
-- [Path queries and closure-preserving interchange](../../guides/concepts.md#query-paths-and-preserve-closure)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,78 +0,0 @@
-# CustomThreadProfileSpec
-
-Caller-defined periodic axial/radial profile in millimetres.
-
-## Extends
-
-- [`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md)
-
-## Properties
-
-### kind
-
-
-
-`readonly` **kind**: `"custom"`
-
-
-
-Selects a caller-defined periodic profile.
-
-***
-
-### points
-
-
-
-`readonly` **points**: readonly [`Vector2Data`](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`](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)
-- [Vector2Data](Vector2Data.md)
-
-## 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.18.0`.

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

@@ -1,58 +0,0 @@
-# CylinderOptions
-
-Dimensions, placement, independent end finishing, and tessellation for a Z-axis cylinder or frustum.
-
-**CylinderOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`RadialSizingOptions`](RadialSizingOptions.md) & [`PrimitiveAttachment`](PrimitiveAttachment.md) & `object` & (\{ `radius`: `number` \| readonly \[`bottom`: `number`, `top`: `number`\]; `diameter?`: `never`; \} \| \{ `diameter`: `number` \| readonly \[`bottom`: `number`, `top`: `number`\]; `radius?`: `never`; \})
-
-
-
-## Type Declaration
-
-### center?
-
-
-
-`readonly` `optional` **center?**: `boolean`
-
-
-
-Centers the solid on the Z origin when `true`; otherwise its bottom is at `Z = 0`.
-
-#### Default Value
-
-`true`
-
-### ends?
-
-
-
-`readonly` `optional` **ends?**: [`EndTreatments`](EndTreatments.md)
-
-
-
-Independent end treatments; first setback is cap inset and second follows the sloped side.
-
-### height
-
-
-
-`readonly` **height**: `number`
-
-
-
-Total height along +Z in millimetres.
-
-
-## Related APIs
-
-- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
-- [EndTreatments](EndTreatments.md)
-- [PrimitiveAttachment](PrimitiveAttachment.md)
-- [RadialSizingOptions](RadialSizingOptions.md)
-
-## Guides
-
-- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
-- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,22 +0,0 @@
-# EdgeTreatment
-
-Uniform finishing vocabulary shared by applicable solid edges and profile corners.
-
-**EdgeTreatment** = [`ChamferedEdgeTreatment`](ChamferedEdgeTreatment.md) \| [`RoundedEdgeTreatment`](RoundedEdgeTreatment.md) \| [`SmoothEdgeTreatment`](SmoothEdgeTreatment.md) \| [`ProfiledEdgeTreatment`](ProfiledEdgeTreatment.md)
-
-
-
-
-## Related APIs
-
-- [ChamferedEdgeTreatment](ChamferedEdgeTreatment.md)
-- [ProfiledEdgeTreatment](ProfiledEdgeTreatment.md)
-- [RoundedEdgeTreatment](RoundedEdgeTreatment.md)
-- [SmoothEdgeTreatment](SmoothEdgeTreatment.md)
-
-## Guides
-
-- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
-- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,21 +0,0 @@
-# EllipseContourOptions
-
-Ellipse dimensions with exactly one XY radii or full-size tuple and explicit sampling.
-
-**EllipseContourOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & (\{ `radius`: [`Vector2Input`](Vector2Input.md); `size?`: `never`; \} \| \{ `size`: [`Vector2Input`](Vector2Input.md); `radius?`: `never`; \})
-
-
-
-
-## Related APIs
-
-- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
-- [Vector2Input](Vector2Input.md)
-
-## Guides
-
-- [Section, hole, offset, and extrusion](../../guides/recipes.md#section-hole-offset-and-extrusion)
-- [SVG sections: fills and strokes are different inputs](../../guides/concepts.md#svg-sections-fills-and-strokes-are-different-inputs)
-- [Text and font variability](../../guides/concepts.md#text-and-font-variability)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,39 +0,0 @@
-# EndTreatments
-
-Independent inward finishing on primitive or straight convex extrusion ends. Zero amounts leave the end untreated, including when all ends are disabled.
-
-## Properties
-
-### bottom?
-
-
-
-`readonly` `optional` **bottom?**: [`EdgeTreatment`](EdgeTreatment.md)
-
-
-
-Bottom cap and adjoining side; omitted leaves the end untreated.
-
-***
-
-### top?
-
-
-
-`readonly` `optional` **top?**: [`EdgeTreatment`](EdgeTreatment.md)
-
-
-
-Top cap and adjoining side; omitted leaves the end untreated.
-
-
-## Related APIs
-
-- [EdgeTreatment](EdgeTreatment.md)
-
-## Guides
-
-- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
-- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,133 +0,0 @@
-# ExtrudeMeshOptions
-
-Dimensions and sampling for pure +Z mesh extrusion, without end treatments.
-
-## Extends
-
-- [`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md)
-
-## Extended by
-
-- [`ExtrudeOptions`](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`](ExtrusionSamplingOptions.md).[`divisions`](ExtrusionSamplingOptions.md#divisions)
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
-
-
-
-Explicit output and sampling allocation ceilings.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`limits`](ExtrusionSamplingOptions.md#limits)
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-
-
-
-Operation-level physical policy over the nearest model scope.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`resolution`](ExtrusionSamplingOptions.md#resolution)
-
-***
-
-### scaleTop?
-
-
-
-`readonly` `optional` **scaleTop?**: `number` \| [`Vector2Input`](Vector2Input.md)
-
-
-
-Finite uniform or XY scale of the top profile; defaults to one.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`scaleTop`](ExtrusionSamplingOptions.md#scaletop)
-
-***
-
-### twist?
-
-
-
-`readonly` `optional` **twist?**: `number`
-
-
-
-Finite rotation of the top profile about +Z, in degrees; defaults to zero.
-
-#### Inherited from
-
-[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`twist`](ExtrusionSamplingOptions.md#twist)
-
-
-## Related APIs
-
-- [ExtrudeOptions](ExtrudeOptions.md)
-- [ExtrusionSamplingOptions](ExtrusionSamplingOptions.md)
-- [GeometryResolution](GeometryResolution.md)
-- [ModelingLimits](ModelingLimits.md)
-- [Vector2Input](Vector2Input.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.18.0`.

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

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

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

@@ -1,84 +0,0 @@
-# ExtrusionSamplingOptions
-
-Shared sampling controls for a twisted or scaled linear extrusion.
-
-## Extended by
-
-- [`ExtrudeMeshOptions`](ExtrudeMeshOptions.md)
-
-## Properties
-
-### divisions?
-
-
-
-`readonly` `optional` **divisions?**: `number`
-
-
-
-Exact number of intermediate profiles, nonnegative; overrides physical sampling.
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
-
-
-
-Explicit output and sampling allocation ceilings.
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-
-
-
-Operation-level physical policy over the nearest model scope.
-
-***
-
-### scaleTop?
-
-
-
-`readonly` `optional` **scaleTop?**: `number` \| [`Vector2Input`](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
-
-- [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.18.0`.