@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,34 @@
+# PathPlacement
+
+Position and unit tangent for one path-distributed item.
+
+## Properties
+
+### position
+
+
+
+`readonly` **position**: [`Vector3`](Vector3.md)
+
+
+
+Interpolated point on the sampled path.
+
+***
+
+### tangent
+
+
+
+`readonly` **tangent**: [`Vector3`](Vector3.md)
+
+
+
+Unit tangent of the path segment containing the placement.
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,7 @@
+# PlanarMeshOptimizationFallbackReason
+
+Stable reason why planar optimization returned the original mesh unchanged.
+
+**PlanarMeshOptimizationFallbackReason** = `"candidate-boundary-changed"` \| `"candidate-measurements-changed"` \| `"candidate-not-closed-oriented-manifold"` \| `"candidate-quality-regressed"` \| `"input-not-closed-oriented-manifold"`
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,156 @@
+# PlanarMeshOptimizationOptions
+
+Options controlling bounded, connectivity-only optimization of planar triangle patches.
+
+## Extends
+
+- [`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md)
+
+## Properties
+
+### maximumFlipAttempts?
+
+
+
+`readonly` `optional` **maximumFlipAttempts?**: `number`
+
+
+
+Maximum attempted edge evaluations. By default this is twenty times the initial candidate
+edge count, capped at `1000000`.
+
+***
+
+### maximumEdgeRevisits?
+
+
+
+`readonly` `optional` **maximumEdgeRevisits?**: `number`
+
+
+
+Maximum times one edge may be reconsidered after neighbouring flips. Defaults to `12`.
+
+***
+
+### maximumPatchTriangleCount?
+
+
+
+`readonly` `optional` **maximumPatchTriangleCount?**: `number`
+
+
+
+Maximum triangles allowed in one selected patch. Defaults to `50000`.
+
+***
+
+### maximumProcessedTriangleCount?
+
+
+
+`readonly` `optional` **maximumProcessedTriangleCount?**: `number`
+
+
+
+Maximum cumulative triangles across selected patches. Defaults to `200000`.
+
+***
+
+### minimumPatchTriangleCount?
+
+
+
+`readonly` `optional` **minimumPatchTriangleCount?**: `number`
+
+
+
+Minimum triangles required before a planar patch is eligible. Defaults to `8`.
+
+***
+
+### triggerMaximumAspectRatio?
+
+
+
+`readonly` `optional` **triggerMaximumAspectRatio?**: `number`
+
+
+
+Select patches whose worst normalized aspect ratio exceeds this value. Defaults to `12`.
+
+***
+
+### triggerMaximumFanRatio?
+
+
+
+`readonly` `optional` **triggerMaximumFanRatio?**: `number`
+
+
+
+Select patches whose largest per-vertex triangle share exceeds this ratio. Defaults to `0.2`.
+
+***
+
+### triggerMaximumVertexTriangleIncidence?
+
+
+
+`readonly` `optional` **triggerMaximumVertexTriangleIncidence?**: `number`
+
+
+
+Select patches whose largest vertex triangle incidence exceeds this value. Defaults to `16`.
+
+***
+
+### triggerMinimumAngleDegrees?
+
+
+
+`readonly` `optional` **triggerMinimumAngleDegrees?**: `number`
+
+
+
+Select patches whose smallest interior angle is below this many degrees. Defaults to `8`.
+
+***
+
+### maximumTriangleCount?
+
+
+
+`readonly` `optional` **maximumTriangleCount?**: `number`
+
+
+
+Maximum number of triangles inspected. Defaults to `200000`.
+
+#### Inherited from
+
+[`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md).[`maximumTriangleCount`](TriangleMeshQualityOptions.md#maximumtrianglecount)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Numeric comparison overrides; model coordinates are interpreted in their existing units.
+
+#### Inherited from
+
+[`TriangleMeshQualityOptions`](TriangleMeshQualityOptions.md).[`tolerance`](TriangleMeshQualityOptions.md#tolerance)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [TriangleMeshQualityOptions](TriangleMeshQualityOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,120 @@
+# PlanarMeshOptimizationResult
+
+Outcome of bounded planar-patch optimization, including before/after diagnostics.
+
+## Properties
+
+### after
+
+
+
+`readonly` **after**: [`TriangleMeshQualityReport`](TriangleMeshQualityReport.md)
+
+
+
+Quality report for the returned mesh; equal to `before` on unchanged or fallback results.
+
+***
+
+### before
+
+
+
+`readonly` **before**: [`TriangleMeshQualityReport`](TriangleMeshQualityReport.md)
+
+
+
+Quality report for the supplied mesh.
+
+***
+
+### budgetExhausted
+
+
+
+`readonly` **budgetExhausted**: `boolean`
+
+
+
+Whether a work bound stopped evaluation while eligible work remained.
+
+***
+
+### changed
+
+
+
+`readonly` **changed**: `boolean`
+
+
+
+Whether the returned mesh has different triangle connectivity.
+
+***
+
+### fallbackReason?
+
+
+
+`readonly` `optional` **fallbackReason?**: [`PlanarMeshOptimizationFallbackReason`](PlanarMeshOptimizationFallbackReason.md)
+
+
+
+Safety reason when candidate validation rejected optimization or input topology was unsupported.
+
+***
+
+### flipCount
+
+
+
+`readonly` **flipCount**: `number`
+
+
+
+Number of accepted legal diagonal flips.
+
+***
+
+### mesh
+
+
+
+`readonly` **mesh**: [`TriangleMesh`](TriangleMesh.md)
+
+
+
+Returned mesh; unchanged results preserve the exact input object.
+
+***
+
+### optimizedPatchCount
+
+
+
+`readonly` **optimizedPatchCount**: `number`
+
+
+
+Number of planar patches in which at least one edge was flipped.
+
+***
+
+### skippedPatchCount
+
+
+
+`readonly` **skippedPatchCount**: `number`
+
+
+
+Number of triggered patches omitted because a configured triangle bound would be exceeded.
+
+
+## Related APIs
+
+- [PlanarMeshOptimizationFallbackReason](PlanarMeshOptimizationFallbackReason.md)
+- [TriangleMesh](TriangleMesh.md)
+- [TriangleMeshQualityReport](TriangleMeshQualityReport.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,190 @@
+# PlanarPatchQuality
+
+Quality measurements for one edge-connected coplanar triangle patch.
+
+## Properties
+
+### boundaryEdgeCount
+
+
+
+`readonly` **boundaryEdgeCount**: `number`
+
+
+
+Number of edges separating this patch from another plane or the mesh boundary.
+
+***
+
+### boundaryLoopCount
+
+
+
+`readonly` **boundaryLoopCount**: `number`
+
+
+
+Number of connected boundary loops; holes contribute additional loops.
+
+***
+
+### fanRatio
+
+
+
+`readonly` **fanRatio**: `number`
+
+
+
+Maximum ratio of one vertex's incident patch triangles to the patch triangle count.
+
+***
+
+### firstTriangleIndex
+
+
+
+`readonly` **firstTriangleIndex**: `number`
+
+
+
+Lowest source triangle index in this deterministic patch.
+
+***
+
+### id
+
+
+
+`readonly` **id**: `number`
+
+
+
+Stable zero-based patch identifier in first-triangle order.
+
+***
+
+### internalEdgeCount
+
+
+
+`readonly` **internalEdgeCount**: `number`
+
+
+
+Number of edges shared by two triangles within this patch.
+
+***
+
+### maximumTriangleAspectRatio
+
+
+
+`readonly` **maximumTriangleAspectRatio**: `number`
+
+
+
+Largest normalized triangle aspect ratio; an equilateral triangle has ratio `1`.
+
+***
+
+### maximumVertexTriangleIncidence
+
+
+
+`readonly` **maximumVertexTriangleIncidence**: `number`
+
+
+
+Largest number of patch triangles incident to one vertex.
+
+***
+
+### maximumVertexValence
+
+
+
+`readonly` **maximumVertexValence**: `number`
+
+
+
+Largest number of distinct patch neighbours connected to one vertex.
+
+***
+
+### minimumTriangleAngleDegrees
+
+
+
+`readonly` **minimumTriangleAngleDegrees**: `number`
+
+
+
+Smallest interior triangle angle in degrees.
+
+***
+
+### normal
+
+
+
+`readonly` **normal**: [`Vector3`](Vector3.md)
+
+
+
+Consistently wound unit normal for the patch plane.
+
+***
+
+### planeOffset
+
+
+
+`readonly` **planeOffset**: `number`
+
+
+
+Plane offset in `dot(normal, position) = planeOffset` form, in model units.
+
+***
+
+### surfaceArea
+
+
+
+`readonly` **surfaceArea**: `number`
+
+
+
+Total patch area in squared model units.
+
+***
+
+### triangleCount
+
+
+
+`readonly` **triangleCount**: `number`
+
+
+
+Number of triangles in this patch.
+
+***
+
+### vertexCount
+
+
+
+`readonly` **vertexCount**: `number`
+
+
+
+Number of distinct indexed vertices referenced by this patch.
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,38 @@
+# Polygon
+
+One bounded two-dimensional polygon.
+
+`outer` is counter-clockwise and each hole is clockwise. Boundary arrays omit
+their duplicated closing point. Holes must lie inside `outer` and must not
+intersect each other or the exterior.
+
+## Properties
+
+### holes
+
+
+
+`readonly` **holes**: readonly [`Contour`](Contour.md)[]
+
+
+
+Clockwise interior boundaries, each omitting its duplicated closing point.
+
+***
+
+### outer
+
+
+
+`readonly` **outer**: [`Contour`](Contour.md)
+
+
+
+Counter-clockwise exterior boundary, omitting its duplicated closing point.
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,92 @@
+# PolylineResamplingOptions
+
+Equal arc-length sampling of an open path or an implicitly closed loop.
+
+## Extends
+
+- [`CurveSamplingOptions`](CurveSamplingOptions.md)
+
+## Properties
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Millimetre sampling policy; circularSegments applies only to arcs.
+
+#### Inherited from
+
+[`CurveSamplingOptions`](CurveSamplingOptions.md).[`resolution`](CurveSamplingOptions.md#resolution)
+
+***
+
+### maximumVertices?
+
+
+
+`readonly` `optional` **maximumVertices?**: `number`
+
+
+
+Output vertex ceiling of at least two; may only lower limits.maxPathPoints.
+
+#### Inherited from
+
+[`CurveSamplingOptions`](CurveSamplingOptions.md).[`maximumVertices`](CurveSamplingOptions.md#maximumvertices)
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings; omitted values use package defaults without ambient state.
+
+#### Inherited from
+
+[`CurveSamplingOptions`](CurveSamplingOptions.md).[`limits`](CurveSamplingOptions.md#limits)
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact equal arc-length intervals; closed paths require at least three.
+
+#### Overrides
+
+[`CurveSamplingOptions`](CurveSamplingOptions.md).[`segments`](CurveSamplingOptions.md#segments)
+
+***
+
+### closed?
+
+
+
+`readonly` `optional` **closed?**: `boolean`
+
+
+
+Includes the closing edge without repeating the first output point; defaults to false.
+
+
+## Related APIs
+
+- [CurveSamplingOptions](CurveSamplingOptions.md)
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,31 @@
+# PrimitivePlacement
+
+Placement shared by solid and filled-section factories.
+
+## Extended by
+
+- [`BoxOptions`](BoxOptions.md)
+- [`TorusOptions`](TorusOptions.md)
+- [`TubeOptions`](TubeOptions.md)
+
+## Properties
+
+### placement?
+
+
+
+`readonly` `optional` **placement?**: [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md)
+
+
+
+Applied after local construction; Section placement must preserve the XY plane.
+
+
+## Related APIs
+
+- [BoxOptions](BoxOptions.md)
+- [PrimitivePlacementOptions](PrimitivePlacementOptions.md)
+- [TorusOptions](TorusOptions.md)
+- [TubeOptions](TubeOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.