@metamesh/modeling 0.18.0 → 0.20.0

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

@@ -1,194 +0,0 @@
-# TriangleMeshQualityReport
-
-Structural, topological, and planar-patch measurements for one indexed triangle mesh.
-
-## Properties
-
-### duplicateTriangleCount
-
-
-
-`readonly` **duplicateTriangleCount**: `number`
-
-
-
-Number of duplicate triangles beyond their first unordered occurrence.
-
-***
-
-### inconsistentWindingEdgeCount
-
-
-
-`readonly` **inconsistentWindingEdgeCount**: `number`
-
-
-
-Number of two-face edges whose incident triangles use the same direction.
-
-***
-
-### isClosedOrientedManifold
-
-
-
-`readonly` **isClosedOrientedManifold**: `boolean`
-
-
-
-Whether the mesh has valid faces and exactly two oppositely wound faces at every edge.
-
-***
-
-### maximumTriangleAspectRatio
-
-
-
-`readonly` **maximumTriangleAspectRatio**: `number`
-
-
-
-Largest normalized triangle aspect ratio; an equilateral triangle has ratio `1`.
-
-***
-
-### maximumVertexTriangleIncidence
-
-
-
-`readonly` **maximumVertexTriangleIncidence**: `number`
-
-
-
-Largest number of triangles incident to one indexed vertex.
-
-***
-
-### maximumVertexValence
-
-
-
-`readonly` **maximumVertexValence**: `number`
-
-
-
-Largest number of distinct neighbours connected to one indexed vertex.
-
-***
-
-### minimumTriangleAngleDegrees
-
-
-
-`readonly` **minimumTriangleAngleDegrees**: `number`
-
-
-
-Smallest interior triangle angle in degrees.
-
-***
-
-### nearZeroAreaTriangleCount
-
-
-
-`readonly` **nearZeroAreaTriangleCount**: `number`
-
-
-
-Number of triangles at or below the scale-aware zero-area threshold.
-
-***
-
-### nonManifoldEdgeCount
-
-
-
-`readonly` **nonManifoldEdgeCount**: `number`
-
-
-
-Number of edges with more than two incident triangles.
-
-***
-
-### openEdgeCount
-
-
-
-`readonly` **openEdgeCount**: `number`
-
-
-
-Number of edges with exactly one incident triangle.
-
-***
-
-### planarPatches
-
-
-
-`readonly` **planarPatches**: readonly [`PlanarPatchQuality`](PlanarPatchQuality.md)[]
-
-
-
-Edge-connected coplanar patches in deterministic first-triangle order.
-
-***
-
-### signedVolume
-
-
-
-`readonly` **signedVolume**: `number`
-
-
-
-Signed enclosed volume in cubic model units; positive values indicate outward winding.
-
-***
-
-### surfaceArea
-
-
-
-`readonly` **surfaceArea**: `number`
-
-
-
-Total triangle area in squared model units.
-
-***
-
-### triangleCount
-
-
-
-`readonly` **triangleCount**: `number`
-
-
-
-Number of indexed triangles.
-
-***
-
-### vertexCount
-
-
-
-`readonly` **vertexCount**: `number`
-
-
-
-Number of entries in the position buffer.
-
-
-## Related APIs
-
-- [PlanarPatchQuality](PlanarPatchQuality.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,111 +0,0 @@
-# TriangleMeshSignature
-
-Immutable deterministic measurements for a closed, oriented triangle mesh.
-
-## Properties
-
-### bounds
-
-
-
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
-
-
-
-Axis-aligned bounds quantized by `tolerances.position`.
-
-***
-
-### shellCount
-
-
-
-`readonly` **shellCount**: `number`
-
-
-
-Number of edge-connected closed boundary shells; cavities count separately.
-
-***
-
-### genus
-
-
-
-`readonly` **genus**: `number`
-
-
-
-Total orientable genus across all connected components.
-
-***
-
-### fingerprint
-
-
-
-`readonly` **fingerprint**: `string`
-
-
-
-Order-independent hash of quantized vertices and oriented triangles.
-
-***
-
-### signedVolume
-
-
-
-`readonly` **signedVolume**: `number`
-
-
-
-Signed enclosed volume quantized by `tolerances.signedVolume`.
-
-***
-
-### tolerances
-
-
-
-`readonly` **tolerances**: [`TriangleMeshSignatureTolerances`](TriangleMeshSignatureTolerances.md)
-
-
-
-Quantization used to make the signature stable across insignificant numeric drift.
-
-***
-
-### triangleCount
-
-
-
-`readonly` **triangleCount**: `number`
-
-
-
-Number of indexed triangles.
-
-***
-
-### vertexCount
-
-
-
-`readonly` **vertexCount**: `number`
-
-
-
-Number of referenced position-buffer vertices.
-
-
-## Related APIs
-
-- [Bounds3Data](Bounds3Data.md)
-- [TriangleMeshSignatureTolerances](TriangleMeshSignatureTolerances.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,46 +0,0 @@
-# TriangleMeshSignatureOptions
-
-Options controlling deterministic triangle-mesh regression signatures.
-
-## Properties
-
-### maxTriangles?
-
-
-
-`readonly` `optional` **maxTriangles?**: `number`
-
-
-
-Maximum accepted triangle count. Defaults to 200,000.
-
-***
-
-### positionTolerance?
-
-
-
-`readonly` `optional` **positionTolerance?**: `number`
-
-
-
-Position and bounds quantization in model units. Defaults to `1e-5`.
-
-***
-
-### volumeTolerance?
-
-
-
-`readonly` `optional` **volumeTolerance?**: `number`
-
-
-
-Signed-volume quantization in cubic model units. Defaults to `1e-4`.
-
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,34 +0,0 @@
-# TriangleMeshSignatureTolerances
-
-Absolute tolerances recorded in a triangle-mesh regression signature.
-
-## Properties
-
-### position
-
-
-
-`readonly` **position**: `number`
-
-
-
-Position and bounds quantization in model units.
-
-***
-
-### signedVolume
-
-
-
-`readonly` **signedVolume**: `number`
-
-
-
-Signed-volume quantization in cubic model units.
-
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,131 +0,0 @@
-# TriangleMeshTopologyAnalysis
-
-Mesh measurements with the indexed surface-shell and edge counts requested by includeTopology.
-
-## Extends
-
-- [`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
-
-## Properties
-
-### bounds
-
-
-
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
-
-
-
-Axis-aligned bounds.
-
-#### Inherited from
-
-[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md).[`bounds`](TriangleMeshAnalysis.md#bounds)
-
-***
-
-### signedVolume
-
-
-
-`readonly` **signedVolume**: `number`
-
-
-
-Signed enclosed volume; positive values correspond to outward winding.
-
-#### Inherited from
-
-[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md).[`signedVolume`](TriangleMeshAnalysis.md#signedvolume)
-
-***
-
-### surfaceArea
-
-
-
-`readonly` **surfaceArea**: `number`
-
-
-
-Sum of all triangle areas in squared model units.
-
-#### Inherited from
-
-[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md).[`surfaceArea`](TriangleMeshAnalysis.md#surfacearea)
-
-***
-
-### triangleCount
-
-
-
-`readonly` **triangleCount**: `number`
-
-
-
-Number of indexed triangles.
-
-#### Inherited from
-
-[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md).[`triangleCount`](TriangleMeshAnalysis.md#trianglecount)
-
-***
-
-### vertexCount
-
-
-
-`readonly` **vertexCount**: `number`
-
-
-
-Number of distinct entries in the position buffer.
-
-#### Inherited from
-
-[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md).[`vertexCount`](TriangleMeshAnalysis.md#vertexcount)
-
-***
-
-### shellCount
-
-
-
-`readonly` **shellCount**: `number`
-
-
-
-Number of surface shells connected by shared indexed edges; cavities count separately.
-
-#### Overrides
-
-[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md).[`shellCount`](TriangleMeshAnalysis.md#shellcount)
-
-***
-
-### edgeCount
-
-
-
-`readonly` **edgeCount**: `number`
-
-
-
-Number of distinct indexed undirected edges.
-
-#### Overrides
-
-[`TriangleMeshAnalysis`](TriangleMeshAnalysis.md).[`edgeCount`](TriangleMeshAnalysis.md#edgecount)
-
-
-## Related APIs
-
-- [Bounds3Data](Bounds3Data.md)
-- [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,55 +0,0 @@
-# TriangleMeshValidationOptions
-
-Options controlling structural and manufacturing validation of a mesh.
-
-## Extended by
-
-- [`TriangleMeshAnalysisOptions`](TriangleMeshAnalysisOptions.md)
-
-## Properties
-
-### allowEmpty?
-
-
-
-`readonly` `optional` **allowEmpty?**: `boolean`
-
-
-
-Permit an empty position and index buffer. Defaults to `false`.
-
-***
-
-### requireClosed?
-
-
-
-`readonly` `optional` **requireClosed?**: `boolean`
-
-
-
-Require two oppositely wound faces per edge; geometric self-intersections are not detected.
-
-***
-
-### tolerance?
-
-
-
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
-
-
-
-Numeric comparison overrides used for zero-area triangle detection.
-
-
-## Related APIs
-
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [TriangleMeshAnalysisOptions](TriangleMeshAnalysisOptions.md)
-
-## Guides
-
-- [Exact counts and preflight guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,62 +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)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,58 +0,0 @@
-# VectorTextArcBaseline
-
-A circular baseline centered at the XY origin, with rigid shaped glyph groups.
-
-## Properties
-
-### kind
-
-
-
-`readonly` **kind**: `"arc"`
-
-
-
-Selects a circular baseline; glyph outlines rotate without bending or stretching.
-
-***
-
-### radius
-
-
-
-`readonly` **radius**: `number`
-
-
-
-Baseline radius in millimetres, greater than zero and at most 10000.
-
-***
-
-### centerAngle?
-
-
-
-`readonly` `optional` **centerAngle?**: `number`
-
-
-
-Alignment datum in degrees counterclockwise from +X; defaults to 90.
-
-***
-
-### direction?
-
-
-
-`readonly` `optional` **direction?**: `"clockwise"` \| `"counterclockwise"`
-
-
-
-Reading direction around the circle; defaults to clockwise.
-
-
-## Guides
-
-- [SVG preflight work and guarantees](../../guides/concepts.md#check-preflight-guarantees)
-
-Package: `@metamesh/modeling@0.18.0`.