npm - @metamesh/modeling - Versions diffs - 0.18.0 → 0.19.0 - Mend

@metamesh/modeling 0.18.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (843) hide show

package/dist/docs/reference/model/ThreadedNutPreflight.md DELETED Viewed

@@ -1,111 +0,0 @@
-# ThreadedNutPreflight
-Resolved body and end-face dimensions plus conservative allocation estimates for the thread cutter.
-## Properties
-### bodySegments
-`readonly` **bodySegments**: `number`
-Polygon segment count used by the nut body.
-***
-### innerBevel
-`readonly` **innerBevel**: readonly \[`number`, `number`\]
-Resolved opening bevel sizes in millimetres, [bottom, top].
-***
-### outerBevel
-`readonly` **outerBevel**: readonly \[`number`, `number`\]
-Resolved body bevel sizes in millimetres, [bottom, top].
-***
-### cutterFaceRadius
-`readonly` **cutterFaceRadius**: `number`
-Maximum compensated cutter radius at either requested face.
-***
-### minimumBodyFaceInradius
-`readonly` **minimumBodyFaceInradius**: `number`
-Minimum nut-body inradius across the requested top and bottom faces.
-***
-### minimumFaceWall
-`readonly` **minimumFaceWall**: `number`
-Smallest radial wall left between the body and cutter at either requested face.
-***
-### thread
-`readonly` **thread**: [`ThreadSolidPreflight`](ThreadSolidPreflight.md)
-Conservative allocation estimates for the extended cutter; excludes the body and Boolean result.
-***
-### threadCircularSegments
-`readonly` **threadCircularSegments**: `number`
-Start-aligned circular facet count used by the compensated thread cutter.
-## Related APIs
-- [ThreadSolidPreflight](ThreadSolidPreflight.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/ThreadedNutShape.md DELETED Viewed

@@ -1,15 +0,0 @@
-# ThreadedNutShape
-Supported printable nut body shapes.
-**ThreadedNutShape** = `"hex"` \| `"round"` \| `"square"`
-## 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/ThreadedRodOptions.md DELETED Viewed

@@ -1,216 +0,0 @@
-# ThreadedRodOptions
-Options for a compensated external threaded rod along +Z.
-## Extends
-- `Omit`\<[`ThreadRidgeOptions`](ThreadRidgeOptions.md), `"majorDiameter"`\>
-- [`ThreadBevelOptions`](ThreadBevelOptions.md)
-## Properties
-### bevel?
-`readonly` `optional` **bevel?**: [`Bevel`](Bevel.md)
-Bottom/top sizes in millimetres. Omitted disables both. Auto uses profile depth for standard/tapered ends,
-or one sixth of the compensated male minor/female major radius for blunt ends.
-#### Inherited from
-[`ThreadBevelOptions`](ThreadBevelOptions.md).[`bevel`](ThreadBevelOptions.md#bevel)
-***
-### fit?
-`readonly` `optional` **fit?**: [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md)
-Printable fit or caller-calibrated allowances. Default: `normal`.
-***
-### nominalMajorDiameter
-`readonly` **nominalMajorDiameter**: `number`
-Nominal major diameter before male compensation.
-***
-### ends?
-`readonly` `optional` **ends?**: [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md)
-Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
-BOSL2-style non-cut lead-in scaling is available on complete thread solids.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`ends`](ThreadRidgeOptions.md#ends)
-***
-### handedness?
-`readonly` `optional` **handedness?**: [`ThreadHandedness`](ThreadHandedness.md)
-Helix direction. Default: `right`.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`handedness`](ThreadRidgeOptions.md#handedness)
-***
-### length
-`readonly` **length**: `number`
-Total threaded axial length in millimetres.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`length`](ThreadRidgeOptions.md#length)
-***
-### limits?
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
-Explicit output and circular allocation ceilings.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`limits`](ThreadRidgeOptions.md#limits)
-***
-### phase?
-`readonly` `optional` **phase?**: `number`
-Angular offset of the first start in degrees. Default: `0`.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`phase`](ThreadRidgeOptions.md#phase)
-***
-### profile
-`readonly` **profile**: [`ThreadProfile`](ThreadProfile.md)
-Validated periodic profile repeated around the shaft.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`profile`](ThreadRidgeOptions.md#profile)
-***
-### resolution?
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-Optional circular-resolution policy.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`resolution`](ThreadRidgeOptions.md#resolution)
-***
-### starts?
-`readonly` `optional` **starts?**: `number`
-Number of evenly phased starts. Default: `1`.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`starts`](ThreadRidgeOptions.md#starts)
-***
-### tolerance?
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
-Optional numerical tolerance overrides.
-#### Inherited from
-[`ThreadRidgeOptions`](ThreadRidgeOptions.md).[`tolerance`](ThreadRidgeOptions.md#tolerance)
-## Related APIs
-- [Bevel](Bevel.md)
-- [GeometryResolution](GeometryResolution.md)
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [ModelingLimits](ModelingLimits.md)
-- [PrintableThreadFit](PrintableThreadFit.md)
-- [PrintableThreadFitPolicy](PrintableThreadFitPolicy.md)
-- [ThreadBevelOptions](ThreadBevelOptions.md)
-- [ThreadEndTreatmentOptions](ThreadEndTreatmentOptions.md)
-- [ThreadHandedness](ThreadHandedness.md)
-- [ThreadProfile](ThreadProfile.md)
-- [ThreadRidgeOptions](ThreadRidgeOptions.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/TorusOptions.md DELETED Viewed

@@ -1,110 +0,0 @@
-# TorusOptions
-Dimensions and independent ring/profile tessellation for a torus around the Z axis.
-## Extends
-- [`PrimitiveAttachment`](PrimitiveAttachment.md)
-## Properties
-### attachment?
-`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
-Applied after local construction; Section attachment must preserve the XY plane.
-#### Inherited from
-[`PrimitiveAttachment`](PrimitiveAttachment.md).[`attachment`](PrimitiveAttachment.md#attachment)
-***
-### limits?
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
-Explicit sampling ceilings, bounded by the host policy.
-***
-### majorRadius
-`readonly` **majorRadius**: `number`
-Radius from the Z axis to the profile center, in millimetres; greater than `minorRadius`.
-***
-### majorSegments?
-`readonly` `optional` **majorSegments?**: `number`
-Exact segment count around the Z axis; omitted uses adaptive resolution.
-***
-### minorRadius
-`readonly` **minorRadius**: `number`
-Radius of the swept circular profile in millimetres.
-***
-### minorSegments?
-`readonly` `optional` **minorSegments?**: `number`
-Exact segment count around the swept profile; omitted uses adaptive resolution.
-***
-### resolution?
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-Operation-level physical tessellation policy over the active model-wide policy.
-## Related APIs
-- [GeometryResolution](GeometryResolution.md)
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [PrimitiveAttachment](PrimitiveAttachment.md)
-- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.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/Transform2-type.md DELETED Viewed

@@ -1,257 +0,0 @@
-# Transform2
-Immutable reusable XY placement. Methods apply in written order; angles are degrees.
-## Methods
-### translate()
-**translate**(`offset`: [`Vector2Input`](Vector2Input.md)): `Transform2`
-Applies a translation in model units after this placement.
-#### Parameters
-<a id="offset"></a>
-**`offset`** · [`Vector2Input`](Vector2Input.md) · Required
-#### Returns
-`Transform2`
-***
-### rotate()
-**rotate**(`degrees`: `number`, `options?`: [`Pivot2Options`](Pivot2Options.md)): `Transform2`
-Rotates counterclockwise in degrees about an optional world-space pivot (default origin).
-#### Parameters
-<a id="degrees"></a>
-**`degrees`** · `number` · Required
-<a id="options"></a>
-**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
-- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
-  World-space point left fixed by rotation or scaling.
-#### Returns
-`Transform2`
-***
-### scale()
-**scale**(`factors`: `number` \| [`Vector2Input`](Vector2Input.md), `options?`: [`Pivot2Options`](Pivot2Options.md)): `Transform2`
-Scales about an optional world-space pivot; finite nonzero factors may reflect.
-#### Parameters
-<a id="factors"></a>
-**`factors`** · `number` \| [`Vector2Input`](Vector2Input.md) · Required
-<a id="options-1"></a>
-**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
-- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
-  World-space point left fixed by rotation or scaling.
-#### Returns
-`Transform2`
-***
-### andThen()
-**andThen**(`next`: [`Transform2Input`](Transform2Input.md)): `Transform2`
-Applies this placement first, then `next`; neither operand is mutated.
-#### Parameters
-<a id="next"></a>
-**`next`** · [`Transform2Input`](Transform2Input.md) · Required
-#### Returns
-`Transform2`
-***
-### inverse()
-**inverse**(): `Transform2`
-Returns the inverse; singular and numerically unstable transforms throw GeometryError.
-#### Returns
-`Transform2`
-***
-### applyPoint()
-**applyPoint**(`point`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
-Transforms a finite point, including translation. Returns a fresh immutable vector.
-#### Parameters
-<a id="point"></a>
-**`point`** · [`Vector2Input`](Vector2Input.md) · Required
-#### Returns
-[`Vector2`](Vector2-type.md)
-***
-### applyDirection()
-**applyDirection**(`direction`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
-Transforms a finite direction, excluding translation and retaining scale. This is not a normal transform.
-#### Parameters
-<a id="direction"></a>
-**`direction`** · [`Vector2Input`](Vector2Input.md) · Required
-#### Returns
-[`Vector2`](Vector2-type.md)
-***
-### applyNormal()
-**applyNormal**(`normal`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
-Applies the inverse transpose and normalizes. Ignores translation; rejects zero normals.
-#### Parameters
-<a id="normal"></a>
-**`normal`** · [`Vector2Input`](Vector2Input.md) · Required
-#### Returns
-[`Vector2`](Vector2-type.md)
-***
-### toData()
-**toData**(): [`Transform2Data`](Transform2Data.md)
-Returns the frozen canonical row-major 3x3 matrix for interchange.
-#### Returns
-[`Transform2Data`](Transform2Data.md)
-***
-### to3D()
-**to3D**(): [`Transform3`](Transform3-type.md)
-Embeds this placement in XYZ, leaving Z unchanged, for solids and 3D paths.
-#### Returns
-[`Transform3`](Transform3-type.md)
-## Related APIs
-- [Pivot2Options](Pivot2Options.md)
-- [Transform2Data](Transform2Data.md)
-- [Transform2Input](Transform2Input.md)
-- [Transform3](Transform3-type.md)
-- [Vector2](Vector2-type.md)
-- [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.18.0`.

package/dist/docs/reference/model/Transform2Data.md DELETED Viewed

@@ -1,16 +0,0 @@
-# Transform2Data
-A row-major affine 3x3 XY matrix applied to column vectors. Translation occupies indices 2 and 5; the final row is `[0, 0, 1]`.
-**Transform2Data** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`\]
-## 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.18.0`.