@metamesh/modeling 0.18.0 → 0.20.0

package/dist/docs/reference/model/Transform2-type.md

@@ -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

@@ -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`.

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

@@ -1,21 +0,0 @@
-# Transform2Input
-
-An immutable XY transform or its canonical row-major matrix for interchange.
-
-**Transform2Input** = [`Transform2`](Transform2-type.md) \| [`Transform2Data`](Transform2Data.md)
-
-
-
-
-## Related APIs
-
-- [Transform2](Transform2-type.md)
-- [Transform2Data](Transform2Data.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/Transform3-type.md

@@ -1,297 +0,0 @@
-# Transform3
-
-Immutable reusable XYZ placement. Methods apply in written order; angles are degrees.
-
-## Methods
-
-### translate()
-
-
-
-**translate**(`offset`: [`Vector3Input`](Vector3Input.md)): `Transform3`
-
-
-
-Applies a translation in model units after this placement.
-
-#### Parameters
-
-<a id="offset"></a>
-
-**`offset`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### rotate()
-
-
-
-**rotate**(`degrees`: [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
-
-
-
-Rotates about global X, then Y, then Z in degrees, about an optional world-space pivot.
-
-#### Parameters
-
-<a id="degrees"></a>
-
-**`degrees`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
-
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
-
-  World-space point left fixed by rotation or scaling.
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### rotateAxis()
-
-
-
-**rotateAxis**(`axis`: [`Vector3Input`](Vector3Input.md), `degrees`: `number`, `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
-
-
-
-Rotates right-handed in degrees about a nonzero axis and optional world-space pivot.
-
-#### Parameters
-
-<a id="axis"></a>
-
-**`axis`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="degrees-1"></a>
-
-**`degrees`** · `number` · Required
-
-
-
-<a id="options-1"></a>
-
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
-
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
-
-  World-space point left fixed by rotation or scaling.
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### scale()
-
-
-
-**scale**(`factors`: `number` \| [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
-
-
-
-Scales about an optional world-space pivot; finite nonzero factors may reflect.
-
-#### Parameters
-
-<a id="factors"></a>
-
-**`factors`** · `number` \| [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="options-2"></a>
-
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
-
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
-
-  World-space point left fixed by rotation or scaling.
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### andThen()
-
-
-
-**andThen**(`next`: [`Transform3Input`](Transform3Input.md)): `Transform3`
-
-
-
-Applies this placement first, then `next`; equivalent to composeTransform3(next, current).
-
-#### Parameters
-
-<a id="next"></a>
-
-**`next`** · [`Transform3Input`](Transform3Input.md) · Required
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### inverse()
-
-
-
-**inverse**(): `Transform3`
-
-
-
-Returns the inverse; singular and numerically unstable transforms throw GeometryError.
-
-#### Returns
-
-`Transform3`
-
-***
-
-### applyPoint()
-
-
-
-**applyPoint**(`point`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
-
-
-
-Transforms a finite point, including translation. Returns a fresh immutable vector.
-
-#### Parameters
-
-<a id="point"></a>
-
-**`point`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-[`Vector3`](Vector3-type.md)
-
-***
-
-### applyDirection()
-
-
-
-**applyDirection**(`direction`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
-
-
-
-Transforms a finite direction, excluding translation and retaining scale. This is not a normal transform.
-
-#### Parameters
-
-<a id="direction"></a>
-
-**`direction`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-[`Vector3`](Vector3-type.md)
-
-***
-
-### applyNormal()
-
-
-
-**applyNormal**(`normal`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
-
-
-
-Applies the inverse transpose and normalizes. Ignores translation; rejects zero normals.
-
-#### Parameters
-
-<a id="normal"></a>
-
-**`normal`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-[`Vector3`](Vector3-type.md)
-
-***
-
-### toData()
-
-
-
-**toData**(): [`Transform3Data`](Transform3Data.md)
-
-
-
-Returns the frozen canonical row-major 4x4 matrix for interchange.
-
-#### Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-***
-
-### to2D()
-
-
-
-**to2D**(): [`Transform2`](Transform2-type.md)
-
-
-
-Restricts to XY; throws GeometryError for a plane change or singular XY restriction.
-
-#### Returns
-
-[`Transform2`](Transform2-type.md)
-
-
-## Related APIs
-
-- [Pivot3Options](Pivot3Options.md)
-- [Transform2](Transform2-type.md)
-- [Transform3Data](Transform3Data.md)
-- [Transform3Input](Transform3Input.md)
-- [Vector3](Vector3-type.md)
-- [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.18.0`.

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

@@ -1,19 +0,0 @@
-# Transform3Data
-
-A row-major affine 4x4 matrix applied to column vectors.
-
-**Transform3Data** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m03`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m13`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`, `m23`: `number`, `m30`: `number`, `m31`: `number`, `m32`: `number`, `m33`: `number`\]
-
-
-
-Translation occupies indices 3, 7, and 11. The final row must be
-`[0, 0, 0, 1]` within the active geometry tolerance.
-
-
-## 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/Transform3Input.md

@@ -1,21 +0,0 @@
-# Transform3Input
-
-An immutable XYZ transform or its canonical row-major matrix for interchange.
-
-**Transform3Input** = [`Transform3`](Transform3-type.md) \| [`Transform3Data`](Transform3Data.md)
-
-
-
-
-## Related APIs
-
-- [Transform3](Transform3-type.md)
-- [Transform3Data](Transform3Data.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/TrapezoidalThreadProfileSpec.md

@@ -1,97 +0,0 @@
-# TrapezoidalThreadProfileSpec
-
-Trapezoidal thread profile with a configurable included angle.
-
-## Extends
-
-- [`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md)
-
-## Properties
-
-### 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)
-
-***
-
-### kind
-
-
-
-`readonly` **kind**: `"trapezoidal"`
-
-
-
-Selects the trapezoidal profile family.
-
-***
-
-### depth?
-
-
-
-`readonly` `optional` **depth?**: `number`
-
-
-
-Radial depth in millimetres.
-
-#### Default Value
-
-`pitch / 2`
-
-***
-
-### includedAngle?
-
-
-
-`readonly` `optional` **includedAngle?**: `number`
-
-
-
-Full angle between the flanks in degrees, from `0` inclusive to `180` exclusive.
-Each flank uses half this angle from the radial direction; `90` gives 45-degree slopes.
-
-#### Default Value
-
-`30`
-
-
-## Related APIs
-
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.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`.