@metamesh/modeling 0.19.0 → 0.20.0

package/dist/docs/reference/geometry/rotate2.md

@@ -1,43 +0,0 @@
-# rotate2
-
-Rotates a finite vector counter-clockwise in XY by `degrees` about the origin. Throws `NON_FINITE_VALUE` for nonfinite coordinates, angles, or derived coordinates.
-
-`const` **rotate2**: (`vector`: [`Vector2Data`](Vector2Data.md), `degrees`: `number`) => [`Vector2Data`](Vector2Data.md)
-
-
-
-## Parameters
-
-<a id="vector"></a>
-
-**`vector`** · [`Vector2Data`](Vector2Data.md) · Required
-
-
-
-<a id="degrees"></a>
-
-**`degrees`** · `number` · Required
-
-
-
-## Returns
-
-[`Vector2Data`](Vector2Data.md)
-
-
-## Related APIs
-
-- [Vector2Data](Vector2Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { rotate2 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/rotationTransform3.md

@@ -1,60 +0,0 @@
-# rotationTransform3
-
-Creates a right-handed axis-angle rotation transform.
-
-**rotationTransform3**(`axis`: [`Vector3Data`](Vector3Data.md), `angle`: [`AxisAngleRotation3`](AxisAngleRotation3.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Transform3Data`](Transform3Data.md)
-
-
-
-## Parameters
-
-<a id="axis"></a>
-
-**`axis`** · [`Vector3Data`](Vector3Data.md) · Required
-
-Rotation axis; normalization is performed internally.
-
-
-
-<a id="angle"></a>
-
-**`angle`** · [`AxisAngleRotation3`](AxisAngleRotation3.md) · Required
-
-Finite right-handed angle with exactly one explicit unit.
-
-
-
-<a id="tolerance"></a>
-
-**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-Optional zero-length comparison overrides.
-
-
-
-## Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-A frozen row-major transform.
-
-
-## Related APIs
-
-- [AxisAngleRotation3](AxisAngleRotation3.md)
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [Transform3Data](Transform3Data.md)
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { rotationTransform3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/scale2.md

@@ -1,43 +0,0 @@
-# scale2
-
-Multiplies a vector by a dimensionless scalar.
-
-`const` **scale2**: (`vector`: [`Vector2Data`](Vector2Data.md), `scale`: `number`) => [`Vector2Data`](Vector2Data.md)
-
-
-
-## Parameters
-
-<a id="vector"></a>
-
-**`vector`** · [`Vector2Data`](Vector2Data.md) · Required
-
-
-
-<a id="scale"></a>
-
-**`scale`** · `number` · Required
-
-
-
-## Returns
-
-[`Vector2Data`](Vector2Data.md)
-
-
-## Related APIs
-
-- [Vector2Data](Vector2Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { scale2 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/scale3.md

@@ -1,49 +0,0 @@
-# scale3
-
-Multiplies a vector by a dimensionless scalar.
-
-`const` **scale3**: (`vector`: [`Vector3Data`](Vector3Data.md), `scale`: `number`) => [`Vector3Data`](Vector3Data.md)
-
-
-
-## Example
-
-```ts
-scale3([1, 2, 3], 2); // [2, 4, 6]
-```
-
-## Parameters
-
-<a id="vector"></a>
-
-**`vector`** · [`Vector3Data`](Vector3Data.md) · Required
-
-
-
-<a id="scale"></a>
-
-**`scale`** · `number` · Required
-
-
-
-## Returns
-
-[`Vector3Data`](Vector3Data.md)
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { scale3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/scaleTransform3.md

@@ -1,45 +0,0 @@
-# scaleTransform3
-
-Creates an immutable axis-aligned scale transform.
-
-**scaleTransform3**(`factors`: [`Vector3Data`](Vector3Data.md)): [`Transform3Data`](Transform3Data.md)
-
-
-
-Negative components are reflections. Zero components are rejected because
-they collapse volume and cannot be inverted.
-
-## Parameters
-
-<a id="factors"></a>
-
-**`factors`** · [`Vector3Data`](Vector3Data.md) · Required
-
-Finite, non-zero XYZ scale factors.
-
-
-
-## Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-A frozen row-major transform.
-
-
-## Related APIs
-
-- [Transform3Data](Transform3Data.md)
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { scaleTransform3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/subtract2.md

@@ -1,43 +0,0 @@
-# subtract2
-
-Subtracts `b` from `a` component-wise.
-
-`const` **subtract2**: (`a`: [`Vector2Data`](Vector2Data.md), `b`: [`Vector2Data`](Vector2Data.md)) => [`Vector2Data`](Vector2Data.md)
-
-
-
-## Parameters
-
-<a id="a"></a>
-
-**`a`** · [`Vector2Data`](Vector2Data.md) · Required
-
-
-
-<a id="b"></a>
-
-**`b`** · [`Vector2Data`](Vector2Data.md) · Required
-
-
-
-## Returns
-
-[`Vector2Data`](Vector2Data.md)
-
-
-## Related APIs
-
-- [Vector2Data](Vector2Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { subtract2 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/subtract3.md

@@ -1,49 +0,0 @@
-# subtract3
-
-Subtracts `b` from `a`.
-
-`const` **subtract3**: (`a`: [`Vector3Data`](Vector3Data.md), `b`: [`Vector3Data`](Vector3Data.md)) => [`Vector3Data`](Vector3Data.md)
-
-
-
-## Example
-
-```ts
-subtract3([4, 5, 6], [1, 2, 3]); // [3, 3, 3]
-```
-
-## Parameters
-
-<a id="a"></a>
-
-**`a`** · [`Vector3Data`](Vector3Data.md) · Required
-
-
-
-<a id="b"></a>
-
-**`b`** · [`Vector3Data`](Vector3Data.md) · Required
-
-
-
-## Returns
-
-[`Vector3Data`](Vector3Data.md)
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { subtract3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/transformDeterminant3.md

@@ -1,43 +0,0 @@
-# transformDeterminant3
-
-Returns the determinant of a transform's linear 3x3 component.
-
-**transformDeterminant3**(`transform`: [`Transform3Data`](Transform3Data.md)): `number`
-
-
-
-A negative result identifies a reflection; zero is rejected as singular.
-
-## Parameters
-
-<a id="transform"></a>
-
-**`transform`** · [`Transform3Data`](Transform3Data.md) · Required
-
-Valid affine transform.
-
-
-
-## Returns
-
-`number`
-
-Signed linear determinant.
-
-
-## Related APIs
-
-- [Transform3Data](Transform3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { transformDeterminant3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/translationTransform3.md

@@ -1,42 +0,0 @@
-# translationTransform3
-
-Creates an immutable translation transform.
-
-**translationTransform3**(`offset`: [`Vector3Data`](Vector3Data.md)): [`Transform3Data`](Transform3Data.md)
-
-
-
-## Parameters
-
-<a id="offset"></a>
-
-**`offset`** · [`Vector3Data`](Vector3Data.md) · Required
-
-Finite XYZ translation in model units.
-
-
-
-## Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-A frozen row-major transform.
-
-
-## Related APIs
-
-- [Transform3Data](Transform3Data.md)
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { translationTransform3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/validateRigidTransform3.md

@@ -1,41 +0,0 @@
-# validateRigidTransform3
-
-Validates a proper rigid transform: finite translation and a right-handed orthonormal rotation. Scale, shear, reflection, and perspective are rejected within the default angular tolerance. Returns the original row-major 4x4 matrix without copying or normalizing it.
-
-**validateRigidTransform3**(`transform`: [`Transform3Data`](Transform3Data.md)): [`Transform3Data`](Transform3Data.md)
-
-
-
-## Parameters
-
-<a id="transform"></a>
-
-**`transform`** · [`Transform3Data`](Transform3Data.md) · Required
-
-
-
-## Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-
-## Throws
-
-- GeometryError For a malformed, non-finite, or non-rigid matrix.
-
-## Related APIs
-
-- [Transform3Data](Transform3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { validateRigidTransform3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/validateTransform3.md

@@ -1,54 +0,0 @@
-# validateTransform3
-
-Validates that a transform is finite, affine, and non-singular.
-
-**validateTransform3**(`transform`: [`Transform3Data`](Transform3Data.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Transform3Data`](Transform3Data.md)
-
-
-
-## Parameters
-
-<a id="transform"></a>
-
-**`transform`** · [`Transform3Data`](Transform3Data.md) · Required
-
-Row-major matrix to validate.
-
-
-
-<a id="tolerance"></a>
-
-**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-Optional comparison overrides.
-
-
-
-## Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-The original transform after successful validation.
-
-
-## Throws
-
-- GeometryError For non-finite, non-affine, or singular matrices.
-
-## Related APIs
-
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [Transform3Data](Transform3Data.md)
-
-## Guides
-
-- [Reusable transforms and vector math](../../guides/transforms-and-placement.md#reuse-a-transform-across-shapes-and-coordinates)
-- [Fluent values and tuple kernels](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
-
-## Supported imports
-
-```ts
-import { validateTransform3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,30 +0,0 @@
-# Profile
-
-An explicit component/contour/span topology, before shared family sampling with matchProfiles. Component, contour and span identities establish correspondence across a loft or sweep family.
-
-## Properties
-
-### components
-
-
-
-`readonly` **components**: readonly [`ProfileComponent2`](../geometry/ProfileComponent2.md)[]
-
-
-
-Ordered components with explicit contour identities.
-
-
-## Related APIs
-
-- [ProfileComponent2](../geometry/ProfileComponent2.md)
-- [CorrespondingProfile](../geometry/CorrespondingProfile.md)
-- [matchProfiles](matchProfiles.md)
-
-## Supported imports
-
-```ts
-import type { Profile } from "@metamesh/modeling";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/model/categories/explicit-profiles.md

@@ -1,21 +0,0 @@
-# Explicit matching profiles
-
-Build hollow or multicomponent lofts and sweeps using stable landmarks.
-
-`Contour` is point data with an implicit closing edge. `Profile` specifies stable component, contour, and span IDs for a family; it is distinct from a filled `Section`.
-
-Call `matchProfiles` once over the complete family to produce `CorrespondingProfile` values. Paired spans share a physical sampling grid, including logical slots for collapsed corners. `loft` and `sweep` use that correspondence without guessing topology or rematching.
-
-## Functions
-
-| API | Summary |
-| --- | --- |
-| [matchProfiles](../matchProfiles.md) | Matches a profile family using operation settings over host resolution and limits. Requires active synchronous model execution. Use Geometry's matchProfiles for standalone preparation. |
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [Profile](../Profile.md) | An explicit component/contour/span topology, before shared family sampling with matchProfiles. Component, contour and span identities establish correspondence across a loft or sweep family. |
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,48 +0,0 @@
-# matchProfiles
-
-Matches a profile family using operation settings over host resolution and limits. Requires active synchronous model execution. Use Geometry's matchProfiles for standalone preparation.
-
-**matchProfiles**(`profiles`: readonly [`Profile`](Profile.md)[], `options?`: [`MatchProfilesOptions`](../geometry/MatchProfilesOptions.md)): readonly [`CorrespondingProfile`](../geometry/CorrespondingProfile.md)[]
-
-
-
-## Parameters
-
-<a id="profiles"></a>
-
-**`profiles`** · readonly [`Profile`](Profile.md)[] · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`MatchProfilesOptions`](../geometry/MatchProfilesOptions.md) · Optional
-
-- [`resolution`](../geometry/MatchProfilesOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
-
-  Local physical sampling policy; exact interval counts take precedence.
-
-- [`limits`](../geometry/MatchProfilesOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](../geometry/GeometrySamplingLimits.md)\> · Optional
-
-  Explicit per-profile and circular ceilings; the family also has a one-million-slot work bound.
-
-
-
-## Returns
-
-readonly [`CorrespondingProfile`](../geometry/CorrespondingProfile.md)[]
-
-
-## Related APIs
-
-- [CorrespondingProfile](../geometry/CorrespondingProfile.md)
-- [MatchProfilesOptions](../geometry/MatchProfilesOptions.md)
-- [Profile](Profile.md)
-
-## Supported imports
-
-```ts
-import { matchProfiles } from "@metamesh/modeling";
-```
-
-Package: `@metamesh/modeling@0.19.0`.