@metamesh/modeling 0.19.0 → 0.20.0

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

@@ -1,127 +0,0 @@
-# SweepOptions
-
-Controls shared by pure mesh construction and filled modeling sweeps.
-
-## Properties
-
-### closed?
-
-
-
-`readonly` `optional` **closed?**: `boolean`
-
-
-
-Raw point closure defaults to false; a Path3 supplies its closure and rejects conflicts.
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
-
-
-
-Explicit output and sampling allocation ceilings.
-
-***
-
-### orientation?
-
-
-
-`readonly` `optional` **orientation?**: [`SweepOrientation`](SweepOrientation.md)
-
-
-
-Explicit frame policy; default transport minimizes rotations, initially projecting +X then +Y then +Z.
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-
-
-
-Physical sampling of nonzero twist; inserted stations retain authored station controls.
-
-***
-
-### twist?
-
-
-
-`readonly` `optional` **twist?**: `number`
-
-
-
-Total additional profile rotation in degrees, with progression selected by twistBy.
-
-***
-
-### twistBy?
-
-
-
-`readonly` `optional` **twistBy?**: `"length"` \| `"stations"`
-
-
-
-Twist advances by physical path length (default), or normalized authored station position, including a closed seam gap.
-
-***
-
-### scale?
-
-
-
-`readonly` `optional` **scale?**: `number` \| [`Vector2Input`](Vector2Input.md) \| readonly [`Vector2Input`](Vector2Input.md)[]
-
-
-
-Positive uniform/XY scale, or one XY pair per path station. Defaults to one.
-
-***
-
-### seamProfileOffset?
-
-
-
-`readonly` `optional` **seamProfileOffset?**: `number`
-
-
-
-Corresponding point-index advance at a rotationally equivalent closed seam.
-
-
-## Related APIs
-
-- [GeometryResolution](GeometryResolution.md)
-- [ModelingLimits](ModelingLimits.md)
-- [SweepOrientation](SweepOrientation.md)
-- [Vector2Input](Vector2Input.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
-
-## Supported imports
-
-```ts
-import type { SweepOptions } from "@metamesh/modeling";
-```
-
-```ts
-import type { SweepOptions } from "@metamesh/modeling/geometry";
-```
-
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,127 +0,0 @@
-# SweepOrientation
-
-Explicit profile-X frame policy; all normals are directed, and selected singular policies reject.
-
-**SweepOrientation** = \{ `kind`: `"transport"`; `initialNormal?`: [`Vector3Input`](Vector3Input.md); \} \| \{ `kind`: `"fixed-normal"`; `normal`: [`Vector3Input`](Vector3Input.md); \} \| \{ `kind`: `"guide"`; `normal`: [`PathNormalGuide`](PathNormalGuide.md); \} \| \{ `kind`: `"frenet"`; \}
-
-
-
-## Union Members
-
-### Type Literal
-
-\{ `kind`: `"transport"`; `initialNormal?`: [`Vector3Input`](Vector3Input.md); \}
-
-#### kind
-
-
-
-`readonly` **kind**: `"transport"`
-
-
-
-Minimizes frame rotation by parallel transport.
-
-#### initialNormal?
-
-
-
-`readonly` `optional` **initialNormal?**: [`Vector3Input`](Vector3Input.md)
-
-
-
-Initial profile +X guide, projected perpendicular to the first tangent.
-
-***
-
-### Type Literal
-
-\{ `kind`: `"fixed-normal"`; `normal`: [`Vector3Input`](Vector3Input.md); \}
-
-#### kind
-
-
-
-`readonly` **kind**: `"fixed-normal"`
-
-
-
-Projects one fixed world-space normal at every path station.
-
-#### normal
-
-
-
-`readonly` **normal**: [`Vector3Input`](Vector3Input.md)
-
-
-
-Directed profile +X guide; must not be parallel to any local tangent.
-
-***
-
-### Type Literal
-
-\{ `kind`: `"guide"`; `normal`: [`PathNormalGuide`](PathNormalGuide.md); \}
-
-#### kind
-
-
-
-`readonly` **kind**: `"guide"`
-
-
-
-Uses an explicitly directed normal callback at each original normalized station.
-
-#### normal
-
-
-
-`readonly` **normal**: [`PathNormalGuide`](PathNormalGuide.md)
-
-
-
-Finite profile +X guide callback, evaluated once per original path station.
-
-***
-
-### Type Literal
-
-\{ `kind`: `"frenet"`; \}
-
-#### kind
-
-
-
-`readonly` **kind**: `"frenet"`
-
-
-
-Uses sampled curvature normals; zero-curvature stations reject.
-
-
-## Related APIs
-
-- [PathNormalGuide](PathNormalGuide.md)
-- [Vector3Input](Vector3Input.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
-
-## Supported imports
-
-```ts
-import type { SweepOrientation } from "@metamesh/modeling";
-```
-
-```ts
-import type { SweepOrientation } from "@metamesh/modeling/geometry";
-```
-
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,72 +0,0 @@
-# TubeOptions
-
-Dimensions, placement, and tessellation for a hollow Z-axis tube.
-
-**TubeOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`PrimitiveAttachment`](PrimitiveAttachment.md) & `object` & (\{ `innerRadius`: `number`; `outerRadius`: `number`; `innerDiameter?`: `never`; `outerDiameter?`: `never`; \} \| \{ `innerDiameter`: `number`; `outerDiameter`: `number`; `innerRadius?`: `never`; `outerRadius?`: `never`; \})
-
-
-
-## Type Declaration
-
-### center?
-
-
-
-`readonly` `optional` **center?**: `boolean`
-
-
-
-Centers the tube on the Z origin when `true`; otherwise its bottom is at `Z = 0`.
-
-#### Default Value
-
-`true`
-
-### height
-
-
-
-`readonly` **height**: `number`
-
-
-
-Total height along Z in millimetres.
-
-### innerSizing?
-
-
-
-`readonly` `optional` **innerSizing?**: [`RadialSizing`](RadialSizing.md)
-
-
-
-Inner nominal dimension meets polygon vertices or faces; defaults to vertex.
-
-### outerSizing?
-
-
-
-`readonly` `optional` **outerSizing?**: [`RadialSizing`](RadialSizing.md)
-
-
-
-Outer nominal dimension meets polygon vertices or faces; defaults to vertex.
-
-
-## Related APIs
-
-- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
-- [PrimitiveAttachment](PrimitiveAttachment.md)
-- [RadialSizing](RadialSizing.md)
-
-## Supported imports
-
-```ts
-import type { TubeOptions } from "@metamesh/modeling";
-```
-
-```ts
-import type { TubeOptions } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,43 +0,0 @@
-# add2
-
-Adds two finite XY vectors component-wise.
-
-`const` **add2**: (`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 { add2 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,49 +0,0 @@
-# add3
-
-Adds two finite XYZ vectors component-wise.
-
-`const` **add3**: (`a`: [`Vector3Data`](Vector3Data.md), `b`: [`Vector3Data`](Vector3Data.md)) => [`Vector3Data`](Vector3Data.md)
-
-
-
-## Example
-
-```ts
-add3([1, 2, 3], [4, 5, 6]); // [5, 7, 9]
-```
-
-## 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 { add3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,52 +0,0 @@
-# applyTransformDirection3
-
-Applies only the linear component of an affine transform to a direction.
-
-**applyTransformDirection3**(`transform`: [`Transform3Data`](Transform3Data.md), `direction`: [`Vector3Data`](Vector3Data.md)): [`Vector3Data`](Vector3Data.md)
-
-
-
-The result is not normalized, preserving scale information.
-
-## Parameters
-
-<a id="transform"></a>
-
-**`transform`** · [`Transform3Data`](Transform3Data.md) · Required
-
-Valid row-major affine transform.
-
-
-
-<a id="direction"></a>
-
-**`direction`** · [`Vector3Data`](Vector3Data.md) · Required
-
-Finite XYZ direction.
-
-
-
-## Returns
-
-[`Vector3Data`](Vector3Data.md)
-
-A fresh transformed direction.
-
-
-## 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 { applyTransformDirection3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,50 +0,0 @@
-# applyTransformPoint3
-
-Applies an affine transform to a point, including translation.
-
-**applyTransformPoint3**(`transform`: [`Transform3Data`](Transform3Data.md), `point`: [`Vector3Data`](Vector3Data.md)): [`Vector3Data`](Vector3Data.md)
-
-
-
-## Parameters
-
-<a id="transform"></a>
-
-**`transform`** · [`Transform3Data`](Transform3Data.md) · Required
-
-Valid row-major affine transform.
-
-
-
-<a id="point"></a>
-
-**`point`** · [`Vector3Data`](Vector3Data.md) · Required
-
-Finite XYZ point.
-
-
-
-## Returns
-
-[`Vector3Data`](Vector3Data.md)
-
-A fresh transformed point.
-
-
-## 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 { applyTransformPoint3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/geometry/categories/meshes.md

@@ -1,68 +0,0 @@
-# Triangle meshes and surfaces
-
-Data, options, and reports for triangle mesh construction and processing.
-
-Import mesh operations from `@metamesh/modeling/geometry/mesh` using `import * as mesh`. These contracts describe the inputs, limits, and reports accepted by that module.
-
-Manufacturing meshes use `Float32Array` XYZ positions and `Uint32Array` triangle indices. Mesh analysis accepts raw arrays or stable immutable buffers directly; signatures add quantized topology and a regression hash. Predictable constructors reject unsafe allocations before sampling.
-
-- **Construct:** `mesh.extrude`, `mesh.loft`, `mesh.sweep`, `mesh.revolve`, `mesh.threadRidge`, and `mesh.threadSolid` return `TriangleMesh` data without a host engine. `LoftOptions`, `SweepOptions`, and `ExtrudeMeshOptions` describe pure construction. Native `ExtrudeOptions` additionally accepts end treatments.
-- **Match lofts:** `mesh.loft` defaults to `direct` correspondence; select `reindex`, `fast-distance`, or `distance` explicitly when needed. Stations specify exactly one `z` or `frame`, retain original vertices, and interpolate slices in world coordinates. Profile association and sampling-grid work have explicit limits; fidelity isn't reduced to meet them.
-- **Validate:** closed oriented-edge checks do not establish freedom from self-intersections. `mesh.validateSolid` adds bounded floating-point intersection and nested-shell orientation checks, including cavity boundaries. Contacts within tolerance reject conservatively; exhausted work limits fail explicitly.
-- **Measure:** `mesh.centroid` returns the uniform-density volume centroid of consistently oriented closed geometry, including cavities.
-
-## Functions
-
-| API | Summary |
-| --- | --- |
-| [resolveExtrusionDivisions](../resolveExtrusionDivisions.md) | Resolves intermediate profile copies for linear extrusion from physical curve resolution. |
-| [immutableBuffer](../immutableBuffer.md) | Copies numeric data once into private storage. This pure helper needs no active generation. |
-
-## Interfaces
-
-| API | Summary |
-| --- | --- |
-| [HeightfieldPreflight](../HeightfieldPreflight.md) | Exact grid and mesh buffer allocation counts resolved without evaluating the height callback. |
-| [PlanarMeshOptimizationOptions](../PlanarMeshOptimizationOptions.md) | Options controlling bounded, connectivity-only optimization of planar triangle patches. |
-| [PlanarMeshOptimizationResult](../PlanarMeshOptimizationResult.md) | Outcome of bounded planar-patch optimization, including before/after diagnostics. |
-| [RevolveOptions](../RevolveOptions.md) | Circumferential sampling and degree sweep shared by pure and filled revolution. |
-| [SweepOptions](../SweepOptions.md) | Controls shared by pure mesh construction and filled modeling sweeps. |
-| [TriangleMesh](../TriangleMesh.md) | A topology-preserving indexed triangle mesh with mutable owned XYZ buffers. |
-| [TriangleMeshAnalysis](../TriangleMeshAnalysis.md) | Measurements and optional edge-connected topology from one validated mesh traversal. |
-| [TriangleMeshTopologyAnalysis](../TriangleMeshTopologyAnalysis.md) | Mesh measurements with the indexed surface-shell and edge counts requested by includeTopology. |
-| [TriangleMeshAnalysisOptions](../TriangleMeshAnalysisOptions.md) | Validation and optional connectivity controls for a shared mesh analysis. |
-| [TriangleMeshMeasurements](../TriangleMeshMeasurements.md) | Geometric measurements derived from a validated, non-empty triangle mesh. |
-| [TriangleMeshQualityOptions](../TriangleMeshQualityOptions.md) | Options controlling bounded triangle-mesh quality analysis. |
-| [TriangleMeshQualityReport](../TriangleMeshQualityReport.md) | Structural, topological, and planar-patch measurements for one indexed triangle mesh. |
-| [TriangleMeshSignature](../TriangleMeshSignature.md) | Immutable deterministic measurements for a closed, oriented triangle mesh. |
-| [TriangleMeshSignatureOptions](../TriangleMeshSignatureOptions.md) | Options controlling deterministic triangle-mesh regression signatures. |
-| [TriangleMeshSignatureTolerances](../TriangleMeshSignatureTolerances.md) | Absolute tolerances recorded in a triangle-mesh regression signature. |
-| [TriangleMeshValidationOptions](../TriangleMeshValidationOptions.md) | Options controlling structural and manufacturing validation of a mesh. |
-| [ExtrudeOptions](../ExtrudeOptions.md) | Native +Z extrusion with optional inward end treatments. |
-| [ExtrudeMeshOptions](../ExtrudeMeshOptions.md) | Dimensions and sampling for pure +Z mesh extrusion, without end treatments. |
-| [ExtrusionSamplingOptions](../ExtrusionSamplingOptions.md) | Shared sampling controls for a twisted or scaled linear extrusion. |
-| [LoftOptions](../LoftOptions.md) | Shared controls for native and pure lofts. Point data and arbitrary Sections default to direct correspondence. |
-| [PlanarPatchQuality](../PlanarPatchQuality.md) | Quality measurements for one edge-connected coplanar triangle patch. |
-| [SolidMeshValidationOptions](../SolidMeshValidationOptions.md) | Bounded floating-point intersection and shell-orientation validation settings. |
-| [ImmutableBuffer](../ImmutableBuffer-type.md) | Owned immutable numeric data. Iterate without copying; use copy() for mutable storage. |
-| [ImmutableTriangleMesh](../ImmutableTriangleMesh.md) | Immutable local XYZ positions and triangle indices, suitable for a memo result or part. |
-
-## Type aliases
-
-| API | Summary |
-| --- | --- |
-| [HeightfieldMeshLimits](../HeightfieldMeshLimits.md) | Trusted output ceilings for pure construction; omitted fields use engine defaults. |
-| [HeightfieldOptions](../HeightfieldOptions.md) | A closed rectilinear heightfield above a flat base, with uniform or explicit XY samples in millimetres. |
-| [LoftMeshStation](../LoftMeshStation.md) | One point-data profile at a height or explicit right-handed spatial frame. |
-| [PlanarMeshOptimizationFallbackReason](../PlanarMeshOptimizationFallbackReason.md) | Stable reason why planar optimization returned the original mesh unchanged. |
-| [SweepOrientation](../SweepOrientation.md) | Explicit profile-X frame policy; all normals are directed, and selected singular policies reject. |
-| [LoftCorrespondence](../LoftCorrespondence.md) | Associates ordered loft contours without inferring component identities or repairing topology. |
-| [LoftPlacement](../LoftPlacement.md) | A horizontal XY station height, or an explicit right-handed spatial frame, never both. |
-| [TriangleMeshInput](../TriangleMeshInput.md) | Raw construction buffers or immutable captured geometry accepted by mesh utilities. |
-| [NumericArray](../NumericArray.md) | Numeric storage supported by immutable generation buffers. |
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../../guides/resolution-and-inspection.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,51 +0,0 @@
-# composeTransform3
-
-Composes two affine transforms without mutating either matrix.
-
-**composeTransform3**(`after`: [`Transform3Data`](Transform3Data.md), `before`: [`Transform3Data`](Transform3Data.md)): [`Transform3Data`](Transform3Data.md)
-
-
-
-`composeTransform3(after, before)` applies `before` first and `after` second.
-
-## Parameters
-
-<a id="after"></a>
-
-**`after`** · [`Transform3Data`](Transform3Data.md) · Required
-
-Transform applied second.
-
-
-
-<a id="before"></a>
-
-**`before`** · [`Transform3Data`](Transform3Data.md) · Required
-
-Transform applied first.
-
-
-
-## Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-A new frozen transform equal to `after * before`.
-
-
-## 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 { composeTransform3 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.

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

@@ -1,43 +0,0 @@
-# cross2
-
-Returns the signed scalar cross product; positive means `b` is counter-clockwise from `a`.
-
-`const` **cross2**: (`a`: [`Vector2Data`](Vector2Data.md), `b`: [`Vector2Data`](Vector2Data.md)) => `number`
-
-
-
-## Parameters
-
-<a id="a"></a>
-
-**`a`** · [`Vector2Data`](Vector2Data.md) · Required
-
-
-
-<a id="b"></a>
-
-**`b`** · [`Vector2Data`](Vector2Data.md) · Required
-
-
-
-## Returns
-
-`number`
-
-
-## 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 { cross2 } from "@metamesh/modeling/geometry";
-```
-
-Package: `@metamesh/modeling@0.19.0`.