@metamesh/modeling 0.19.0 → 0.20.0

package/dist/docs/reference/mesh/LoftMeshStation.md

@@ -0,0 +1,32 @@
+# LoftMeshStation
+
+One point-data profile at a horizontal height or explicit affine transform.
+
+**LoftMeshStation** = [`LoftPlacement`](../geometry/LoftPlacement.md) & `object`
+
+
+
+## Type Declaration
+
+### profile
+
+
+
+`readonly` **profile**: [`Path2Input`](../geometry/Path2Input.md)
+
+
+
+Closed Path2 or ordered finite XY boundary points with an implicit closing edge.
+
+
+## Guides
+
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+
+## Import
+
+```ts
+import type { LoftMeshStation } from "@metamesh/modeling/geometry/mesh";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/MeshRenderOptions.md

@@ -19,10 +19,10 @@ Maximum angle between averaged face normals, in degrees. Defaults to `20`; `0` i
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
+import type { MeshRenderOptions } from "@metamesh/modeling/geometry/mesh";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/PlanarMeshOptimizationFallbackReason.md

@@ -1,6 +1,6 @@
 # PlanarMeshOptimizationFallbackReason
 
-Stable reason why planar optimization returned the original mesh unchanged.
+Stable reason why planar optimization preserved the original connectivity.
 
 **PlanarMeshOptimizationFallbackReason** = `"candidate-boundary-changed"` \| `"candidate-measurements-changed"` \| `"candidate-not-closed-oriented-manifold"` \| `"candidate-quality-regressed"` \| `"input-not-closed-oriented-manifold"`
 
@@ -11,14 +11,10 @@ Stable reason why planar optimization returned the original mesh unchanged.
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { PlanarMeshOptimizationFallbackReason } from "@metamesh/modeling/geometry";
+import type { PlanarMeshOptimizationFallbackReason } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/PlanarMeshOptimizationOptions.md

@@ -137,7 +137,7 @@ Maximum number of triangles inspected. Defaults to `200000`.
 
 
 
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
 
 
 
@@ -150,21 +150,16 @@ Numeric comparison overrides; model coordinates are interpreted in their existin
 
 ## Related APIs
 
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [TriangleMeshQualityOptions](TriangleMeshQualityOptions.md)
 
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { PlanarMeshOptimizationOptions } from "@metamesh/modeling/geometry";
+import type { PlanarMeshOptimizationOptions } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/PlanarMeshOptimizationResult.md

@@ -84,7 +84,7 @@ Number of accepted legal diagonal flips.
 
 
 
-Returned mesh; unchanged results preserve the exact input object.
+Returned mesh; unchanged raw inputs retain their identity, while immutable inputs produce owned buffers.
 
 ***
 
@@ -121,14 +121,10 @@ Number of triggered patches omitted because a configured triangle bound would be
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { PlanarMeshOptimizationResult } from "@metamesh/modeling/geometry";
+import type { PlanarMeshOptimizationResult } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/PlanarPatchQuality.md

@@ -128,7 +128,7 @@ Smallest interior triangle angle in degrees.
 
 
 
-`readonly` **normal**: [`Vector3Data`](Vector3Data.md)
+`readonly` **normal**: [`Vector3Data`](../geometry/Vector3Data.md)
 
 
 
@@ -183,22 +183,14 @@ Number of triangles in this patch.
 Number of distinct indexed vertices referenced by this patch.
 
 
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
-
-```ts
-import type { PlanarPatchQuality } from "@metamesh/modeling/geometry";
-```
+## Import
 
 ```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
+import type { PlanarPatchQuality } from "@metamesh/modeling/geometry/mesh";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/mesh/RenderMesh.md

@@ -4,65 +4,65 @@ Owned indexed render buffers with unit vertex normals and positions in millimetr
 
 ## Extends
 
-- [`TriangleMesh`](../geometry/TriangleMesh.md)
+- [`TriangleMesh`](TriangleMesh.md)
 
 ## Properties
 
-### indices
-
-
+### normals
 
-`readonly` **indices**: `Uint32Array`
 
 
+`readonly` **normals**: `Float32Array`
 
-Three unsigned vertex indices per triangle.
 
-#### Inherited from
 
-[`TriangleMesh`](../geometry/TriangleMesh.md).[`indices`](../geometry/TriangleMesh.md#indices)
+XYZ unit normals, one for each render vertex. Vertices split at shading discontinuities.
 
 ***
 
-### positions
+### indices
 
 
 
-`readonly` **positions**: `Float32Array`
+`readonly` **indices**: `Uint32Array`
 
 
 
-Flat XYZ coordinates in millimetres.
+Three unsigned vertex indices per triangle.
 
 #### Inherited from
 
-[`TriangleMesh`](../geometry/TriangleMesh.md).[`positions`](../geometry/TriangleMesh.md#positions)
+[`TriangleMesh`](TriangleMesh.md).[`indices`](TriangleMesh.md#indices)
 
 ***
 
-### normals
+### positions
 
 
 
-`readonly` **normals**: `Float32Array`
+`readonly` **positions**: `Float32Array`
 
 
 
-XYZ unit normals, one for each render vertex. Vertices split at shading discontinuities.
+Flat XYZ coordinates in millimetres.
+
+#### Inherited from
+
+[`TriangleMesh`](TriangleMesh.md).[`positions`](TriangleMesh.md#positions)
 
 
 ## Related APIs
 
-- [TriangleMesh](../geometry/TriangleMesh.md)
+- [TriangleMesh](TriangleMesh.md)
 
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
+import type { RenderMesh } from "@metamesh/modeling/geometry/mesh";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/SolidMeshValidationOptions.md

@@ -20,29 +20,21 @@ Work ceiling for spatial comparisons and containment tests; defaults to 2,000,00
 
 
 
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
 
 
 
 Distance comparison policy in millimetres; near contacts reject conservatively.
 
 
-## Related APIs
-
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
-
-```ts
-import type { SolidMeshValidationOptions } from "@metamesh/modeling/geometry";
-```
+## Import
 
 ```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
+import type { SolidMeshValidationOptions } from "@metamesh/modeling/geometry/mesh";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMesh.md

@@ -4,7 +4,7 @@ A topology-preserving indexed triangle mesh with mutable owned XYZ buffers.
 
 ## Extended by
 
-- [`RenderMesh`](../mesh/RenderMesh.md)
+- [`RenderMesh`](RenderMesh.md)
 
 ## Properties
 
@@ -31,22 +31,18 @@ Three unsigned vertex indices per triangle.
 Flat XYZ coordinates in millimetres.
 
 
-## Guides
+## Related APIs
 
-- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+- [RenderMesh](RenderMesh.md)
 
-## Supported imports
+## Guides
 
-```ts
-import type { TriangleMesh } from "@metamesh/modeling";
-```
+- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-```ts
-import type { TriangleMesh } from "@metamesh/modeling/geometry";
-```
+## Import
 
 ```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
+import type { TriangleMesh } from "@metamesh/modeling/geometry/mesh";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshAnalysis.md

@@ -41,7 +41,7 @@ Number of distinct indexed undirected edges when `includeTopology` is requested.
 
 
 
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
+`readonly` **bounds**: [`Bounds3Data`](../geometry/Bounds3Data.md)
 
 
 
@@ -61,7 +61,7 @@ Axis-aligned bounds.
 
 
 
-Signed enclosed volume; positive values correspond to outward winding.
+Signed enclosed volume in cubic model units; positive values correspond to outward winding.
 
 #### Inherited from
 
@@ -118,7 +118,6 @@ Number of distinct entries in the position buffer.
 
 ## Related APIs
 
-- [Bounds3Data](Bounds3Data.md)
 - [TriangleMeshMeasurements](TriangleMeshMeasurements.md)
 - [TriangleMeshTopologyAnalysis](TriangleMeshTopologyAnalysis.md)
 
@@ -126,18 +125,10 @@ Number of distinct entries in the position buffer.
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshAnalysis } from "@metamesh/modeling";
+import type { TriangleMeshAnalysis } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import type { TriangleMeshAnalysis } from "@metamesh/modeling/geometry";
-```
-
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshAnalysisOptions.md

@@ -56,7 +56,7 @@ Require two oppositely wound faces per edge; geometric self-intersections are no
 
 
 
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
 
 
 
@@ -69,21 +69,16 @@ Numeric comparison overrides used for zero-area triangle detection.
 
 ## Related APIs
 
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [TriangleMeshValidationOptions](TriangleMeshValidationOptions.md)
 
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshAnalysisOptions } from "@metamesh/modeling/geometry";
+import type { TriangleMeshAnalysisOptions } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshInput.md

@@ -16,14 +16,10 @@ Raw construction buffers or immutable captured geometry accepted by mesh utiliti
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshInput } from "@metamesh/modeling/geometry";
+import type { TriangleMeshInput } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshMeasurements.md

@@ -12,7 +12,7 @@ Geometric measurements derived from a validated, non-empty triangle mesh.
 
 
 
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
+`readonly` **bounds**: [`Bounds3Data`](../geometry/Bounds3Data.md)
 
 
 
@@ -28,7 +28,7 @@ Axis-aligned bounds.
 
 
 
-Signed enclosed volume; positive values correspond to outward winding.
+Signed enclosed volume in cubic model units; positive values correspond to outward winding.
 
 ***
 
@@ -69,25 +69,16 @@ Number of distinct entries in the position buffer.
 
 ## Related APIs
 
-- [Bounds3Data](Bounds3Data.md)
 - [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
 
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshMeasurements } from "@metamesh/modeling";
+import type { TriangleMeshMeasurements } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import type { TriangleMeshMeasurements } from "@metamesh/modeling/geometry";
-```
-
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshQualityOptions.md

@@ -24,7 +24,7 @@ Maximum number of triangles inspected. Defaults to `200000`.
 
 
 
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
 
 
 
@@ -33,21 +33,16 @@ Numeric comparison overrides; model coordinates are interpreted in their existin
 
 ## Related APIs
 
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
 - [PlanarMeshOptimizationOptions](PlanarMeshOptimizationOptions.md)
 
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshQualityOptions } from "@metamesh/modeling/geometry";
+import type { TriangleMeshQualityOptions } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshQualityReport.md

@@ -191,14 +191,10 @@ Number of entries in the position buffer.
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshQualityReport } from "@metamesh/modeling/geometry";
+import type { TriangleMeshQualityReport } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshSignature.md

@@ -8,7 +8,7 @@ Immutable deterministic measurements for a closed, oriented triangle mesh.
 
 
 
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
+`readonly` **bounds**: [`Bounds3Data`](../geometry/Bounds3Data.md)
 
 
 
@@ -101,21 +101,16 @@ Number of referenced position-buffer vertices.
 
 ## Related APIs
 
-- [Bounds3Data](Bounds3Data.md)
 - [TriangleMeshSignatureTolerances](TriangleMeshSignatureTolerances.md)
 
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshSignature } from "@metamesh/modeling/geometry";
+import type { TriangleMeshSignature } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshSignatureOptions.md

@@ -43,14 +43,10 @@ Signed-volume quantization in cubic model units. Defaults to `1e-4`.
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshSignatureOptions } from "@metamesh/modeling/geometry";
+import type { TriangleMeshSignatureOptions } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshSignatureTolerances.md

@@ -31,14 +31,10 @@ Signed-volume quantization in cubic model units.
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshSignatureTolerances } from "@metamesh/modeling/geometry";
+import type { TriangleMeshSignatureTolerances } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

package/dist/docs/reference/{geometry → mesh}/TriangleMeshTopologyAnalysis.md

@@ -12,7 +12,7 @@ Mesh measurements with the indexed surface-shell and edge counts requested by in
 
 
 
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
+`readonly` **bounds**: [`Bounds3Data`](../geometry/Bounds3Data.md)
 
 
 
@@ -32,7 +32,7 @@ Axis-aligned bounds.
 
 
 
-Signed enclosed volume; positive values correspond to outward winding.
+Signed enclosed volume in cubic model units; positive values correspond to outward winding.
 
 #### Inherited from
 
@@ -121,25 +121,16 @@ Number of distinct indexed undirected edges.
 
 ## Related APIs
 
-- [Bounds3Data](Bounds3Data.md)
 - [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
 
 ## Guides
 
 - [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
 
-## Supported imports
+## Import
 
 ```ts
-import type { TriangleMeshTopologyAnalysis } from "@metamesh/modeling";
+import type { TriangleMeshTopologyAnalysis } from "@metamesh/modeling/geometry/mesh";
 ```
 
-```ts
-import type { TriangleMeshTopologyAnalysis } from "@metamesh/modeling/geometry";
-```
-
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.