@metamesh/modeling 0.12.0 → 0.14.0

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

@@ -0,0 +1,29 @@
+# minimumCylindricalGearToothCountWithoutUndercut
+
+Returns the smallest unshifted full-depth external tooth count that avoids rack-cutter undercut.
+
+**minimumCylindricalGearToothCountWithoutUndercut**(`spec?`: `Readonly`\<`Pick`\<[`CylindricalGearSpec`](CylindricalGearSpec.md), `"helixAngleDegrees"` \| `"pressureAngleDegrees"`\>\>): `number`
+
+
+
+The normal-plane limit is `2 / sin²(alpha_n)`. Helical gears use the standard virtual tooth
+count `z_v = z / cos³(beta)`, so increasing helix angle can reduce the physical tooth count.
+
+## Parameters
+
+<a id="spec"></a>
+
+**`spec`** · `Readonly`\<`Pick`\<[`CylindricalGearSpec`](CylindricalGearSpec.md), `"helixAngleDegrees"` \| `"pressureAngleDegrees"`\>\> · Optional
+
+
+
+## Returns
+
+`number`
+
+
+## Related APIs
+
+- [CylindricalGearSpec](CylindricalGearSpec.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,36 @@
+# normalize2
+
+Returns a unit vector; `epsilon` is a finite, non-negative length threshold (default `1e-12`). Rejects invalid thresholds, nonfinite lengths, and lengths at or below the threshold with `INVALID_TOLERANCE`, `NON_FINITE_VALUE`, and `DEGENERATE_GEOMETRY` respectively.
+
+`const` **normalize2**: (`vector`: [`Vector2Tuple`](Vector2Tuple.md), `epsilon?`: `number`) => [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+## Parameters
+
+<a id="vector"></a>
+
+**`vector`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+
+
+
+<a id="epsilon"></a>
+
+**`epsilon`** · `number` · Optional
+
+
+
+## Returns
+
+[`Vector2Tuple`](Vector2Tuple.md)
+
+
+## Related APIs
+
+- [Vector2Tuple](Vector2Tuple.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,36 @@
+# normalize3
+
+Returns a unit vector; `epsilon` is a finite, non-negative length threshold (default `1e-12`). Rejects invalid thresholds, nonfinite lengths, and lengths at or below the threshold with `INVALID_TOLERANCE`, `NON_FINITE_VALUE`, and `DEGENERATE_GEOMETRY` respectively.
+
+`const` **normalize3**: (`vector`: [`Vector3Tuple`](Vector3Tuple.md), `epsilon?`: `number`) => [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+## Parameters
+
+<a id="vector"></a>
+
+**`vector`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
+
+
+
+<a id="epsilon"></a>
+
+**`epsilon`** · `number` · Optional
+
+
+
+## Returns
+
+[`Vector3Tuple`](Vector3Tuple.md)
+
+
+## Related APIs
+
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,45 @@
+# normalizeContour
+
+Cleans and validates one closed loop.
+
+**normalizeContour**(`input`: readonly [`Vector2Tuple`](Vector2Tuple.md)[], `counterClockwise`: `boolean`, `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Contour`](Contour.md)
+
+
+
+Adjacent duplicates and a repeated seam point are removed. Coordinates must
+be finite, the effective loop must contain at least three points, and the
+result must be simple and have non-zero area. Previously validated immutable results may be
+returned unchanged when their winding and tolerance policy match.
+
+## Parameters
+
+<a id="input"></a>
+
+**`input`** · readonly [`Vector2Tuple`](Vector2Tuple.md)[] · Required
+
+
+
+<a id="counterclockwise"></a>
+
+**`counterClockwise`** · `boolean` · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`Contour`](Contour.md)
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [Vector2Tuple](Vector2Tuple.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,37 @@
+# normalizePolygon
+
+Validates explicit polygon topology and normalizes its winding.
+
+**normalizePolygon**(`polygon`: [`PolygonData`](PolygonData.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`PolygonData`](PolygonData.md)
+
+
+
+Exteriors become CCW and holes clockwise. Every hole must lie strictly
+within its exterior and boundaries may not intersect. Previously validated immutable results
+may be returned unchanged under the same tolerance policy.
+
+## Parameters
+
+<a id="polygon"></a>
+
+**`polygon`** · [`PolygonData`](PolygonData.md) · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`PolygonData`](PolygonData.md)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [PolygonData](PolygonData.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,33 @@
+# normalizeRegion
+
+Validates a disjoint explicit region and returns immutable normalized data. Previously validated immutable results may be returned unchanged under the same tolerance policy.
+
+**normalizeRegion**(`region`: [`RegionData`](RegionData.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`RegionData`](RegionData.md)
+
+
+
+## Parameters
+
+<a id="region"></a>
+
+**`region`** · [`RegionData`](RegionData.md) · Required
+
+
+
+<a id="tolerance"></a>
+
+**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+
+
+## Returns
+
+[`RegionData`](RegionData.md)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [RegionData](RegionData.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,91 @@
+# optimizePlanarPatches
+
+Improves pathological planar triangulation with bounded legal diagonal flips.
+
+**optimizePlanarPatches**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`PlanarMeshOptimizationOptions`](PlanarMeshOptimizationOptions.md)): [`PlanarMeshOptimizationResult`](PlanarMeshOptimizationResult.md)
+
+
+
+The operation changes indices only: it never moves, adds, welds, or removes vertices; never
+crosses a coplanar-patch boundary; and never changes the face count. Each accepted flip improves
+a deterministic ordering of triangle angles, aspect ratio, diagonal locality, and local
+incidence/valence concentration. Unsupported input or a failed final integrity check returns the
+exact original mesh object. Malformed buffers and the configured analysis complexity limit throw.
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
+
+Closed, consistently wound indexed triangle mesh in arbitrary consistent units.
+
+
+
+<a id="options"></a>
+
+**`options`** · [`PlanarMeshOptimizationOptions`](PlanarMeshOptimizationOptions.md) · Optional
+
+Patch eligibility, numeric tolerance, and deterministic work bounds.
+
+- [`maximumFlipAttempts`](PlanarMeshOptimizationOptions.md#maximumflipattempts) · `number` · Optional
+
+  Maximum attempted edge evaluations. By default this is twenty times the initial candidate
+  edge count, capped at `1000000`.
+
+- [`maximumEdgeRevisits`](PlanarMeshOptimizationOptions.md#maximumedgerevisits) · `number` · Optional
+
+  Maximum times one edge may be reconsidered after neighbouring flips. Defaults to `12`.
+
+- [`maximumPatchTriangleCount`](PlanarMeshOptimizationOptions.md#maximumpatchtrianglecount) · `number` · Optional
+
+  Maximum triangles allowed in one selected patch. Defaults to `50000`.
+
+- [`maximumProcessedTriangleCount`](PlanarMeshOptimizationOptions.md#maximumprocessedtrianglecount) · `number` · Optional
+
+  Maximum cumulative triangles across selected patches. Defaults to `200000`.
+
+- [`minimumPatchTriangleCount`](PlanarMeshOptimizationOptions.md#minimumpatchtrianglecount) · `number` · Optional
+
+  Minimum triangles required before a planar patch is eligible. Defaults to `8`.
+
+- [`triggerMaximumAspectRatio`](PlanarMeshOptimizationOptions.md#triggermaximumaspectratio) · `number` · Optional
+
+  Select patches whose worst normalized aspect ratio exceeds this value. Defaults to `12`.
+
+- [`triggerMaximumFanRatio`](PlanarMeshOptimizationOptions.md#triggermaximumfanratio) · `number` · Optional
+
+  Select patches whose largest per-vertex triangle share exceeds this ratio. Defaults to `0.2`.
+
+- [`triggerMaximumVertexTriangleIncidence`](PlanarMeshOptimizationOptions.md#triggermaximumvertextriangleincidence) · `number` · Optional
+
+  Select patches whose largest vertex triangle incidence exceeds this value. Defaults to `16`.
+
+- [`triggerMinimumAngleDegrees`](PlanarMeshOptimizationOptions.md#triggerminimumangledegrees) · `number` · Optional
+
+  Select patches whose smallest interior angle is below this many degrees. Defaults to `8`.
+
+- [`maximumTriangleCount`](PlanarMeshOptimizationOptions.md#maximumtrianglecount) · `number` · Optional
+
+  Maximum number of triangles inspected. Defaults to `200000`.
+
+- [`tolerance`](PlanarMeshOptimizationOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Numeric comparison overrides; model coordinates are interpreted in their existing units.
+
+
+
+## Returns
+
+[`PlanarMeshOptimizationResult`](PlanarMeshOptimizationResult.md)
+
+Optimized connectivity and before/after diagnostics, or an unchanged safe fallback.
+
+
+## Related APIs
+
+- [PlanarMeshOptimizationOptions](PlanarMeshOptimizationOptions.md)
+- [PlanarMeshOptimizationResult](PlanarMeshOptimizationResult.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,33 @@
+# pathLength
+
+Returns total sampled 3D path length, or zero for an empty path.
+
+`const` **pathLength**: (`path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `limits?`: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>) => `number`
+
+
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
+
+
+
+<a id="limits"></a>
+
+**`limits`** · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+
+
+## Returns
+
+`number`
+
+
+## Related APIs
+
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,57 @@
+# pathPatternTransforms
+
+Equal physical arc-length placements along a sampled XYZ path. Tangent orientation maps +Z onto the local path tangent; fixed orientation only translates. Closed paths omit a repeated seam. Explicit sampling ceilings bound both input points and output placements.
+
+**pathPatternTransforms**(`path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `options`: [`PathPatternOptions`](PathPatternOptions.md), `limits?`: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>): readonly [`Transform3Matrix`](Transform3Matrix.md)[]
+
+
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`PathPatternOptions`](PathPatternOptions.md) · Required
+
+- [`count`](PathPatternOptions.md#count) · `number` · Required
+
+  Positive number of copies; open paths include both endpoints when greater than one.
+
+- [`closed`](PathPatternOptions.md#closed) · `boolean` · Optional
+
+  Include the closing edge without duplicating the seam; defaults to false.
+
+- [`orientation`](PathPatternOptions.md#orientation) · `"fixed"` \| `"tangent"` · Optional
+
+  Preserve the source orientation, or align its +Z to the path tangent; defaults to fixed.
+
+
+
+<a id="limits"></a>
+
+**`limits`** · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+
+
+## Returns
+
+readonly [`Transform3Matrix`](Transform3Matrix.md)[]
+
+
+## Related APIs
+
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [PathPatternOptions](PathPatternOptions.md)
+- [Transform3Matrix](Transform3Matrix.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,34 @@
+# preflightHeightfield
+
+Checks grid dimensions, coordinate precision, and allocation bounds before evaluating heights.
+
+**preflightHeightfield**(`options`: [`HeightfieldOptions`](HeightfieldOptions.md), `limits?`: `Partial`\<`Pick`\<[`ModelingLimits`](ModelingLimits.md), `"maxVertices"` \| `"maxTriangles"` \| `"maxBytes"`\>\>): [`HeightfieldPreflight`](HeightfieldPreflight.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`HeightfieldOptions`](HeightfieldOptions.md) · Required
+
+
+
+<a id="limits"></a>
+
+**`limits`** · `Partial`\<`Pick`\<[`ModelingLimits`](ModelingLimits.md), `"maxVertices"` \| `"maxTriangles"` \| `"maxBytes"`\>\> · Optional
+
+
+
+## Returns
+
+[`HeightfieldPreflight`](HeightfieldPreflight.md)
+
+
+## Related APIs
+
+- [HeightfieldOptions](HeightfieldOptions.md)
+- [HeightfieldPreflight](HeightfieldPreflight.md)
+- [ModelingLimits](ModelingLimits.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,96 @@
+# preflightHelicalThreadSolidMesh
+
+Validates a direct thread solid and returns its conservative allocation estimate without constructing vertex or index buffers.
+
+**preflightHelicalThreadSolidMesh**(`options`: [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md)): [`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md) · Required
+
+- [`length`](HelicalThreadSolidMeshOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`majorDiameter`](HelicalThreadSolidMeshOptions.md#majordiameter) · `number` · Required
+
+  Nominal major diameter before any caller-owned fit compensation.
+
+- [`profile`](HelicalThreadSolidMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`ends`](HelicalThreadSolidMeshOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](HelicalThreadSolidMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](HelicalThreadSolidMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](HelicalThreadSolidMeshOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](HelicalThreadSolidMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](HelicalThreadSolidMeshOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](HelicalThreadSolidMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`bevelBottom`](HelicalThreadSolidMeshOptions.md#bevelbottom) · `boolean` · Optional
+
+  Apply a 45-degree radial bevel at the lower target face.
+
+- [`bevelBottomSize`](HelicalThreadSolidMeshOptions.md#bevelbottomsize) · `number` · Optional
+
+  Lower bevel size override. Takes precedence over `bevelSize`.
+
+- [`bevelOffset`](HelicalThreadSolidMeshOptions.md#beveloffset) · `number` · Optional
+
+  Distance of each bevel target face inward from the corresponding mesh end.
+
+- [`bevelMode`](HelicalThreadSolidMeshOptions.md#bevelmode) · `"inset"` \| `"outset"` · Optional
+
+  `inset` trims an external rod; `outset` expands an internal cutter.
+
+- [`bevelSize`](HelicalThreadSolidMeshOptions.md#bevelsize) · `number` · Optional
+
+  Axial and radial bevel size. Defaults to the profile depth.
+
+- [`bevelTop`](HelicalThreadSolidMeshOptions.md#beveltop) · `boolean` · Optional
+
+  Apply a 45-degree radial bevel at the upper target face.
+
+- [`bevelTopSize`](HelicalThreadSolidMeshOptions.md#beveltopsize) · `number` · Optional
+
+  Upper bevel size override. Takes precedence over `bevelSize`.
+
+
+
+## Returns
+
+[`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+## Related APIs
+
+- [HelicalThreadSolidMeshOptions](HelicalThreadSolidMeshOptions.md)
+- [HelicalThreadSolidMeshPreflight](HelicalThreadSolidMeshPreflight.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,85 @@
+# preflightInternalThreadCutter
+
+Preflights the exact extended mesh used by the internal thread cutter constructor.
+
+**preflightInternalThreadCutter**(`options`: [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md)): [`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`InternalThreadCutterOptions`](InternalThreadCutterOptions.md) · Required
+
+- [`length`](InternalThreadCutterOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`profile`](InternalThreadCutterOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`nominalMajorDiameter`](InternalThreadCutterOptions.md#nominalmajordiameter) · `number` · Required
+
+  Nominal major diameter before female compensation and faceting correction.
+
+- [`ends`](InternalThreadCutterOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](InternalThreadCutterOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](InternalThreadCutterOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](InternalThreadCutterOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](InternalThreadCutterOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](InternalThreadCutterOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](InternalThreadCutterOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`fit`](InternalThreadCutterOptions.md#fit) · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
+
+  Printable fit or caller-calibrated allowances. Default: `normal`.
+
+- [`bevelBottom`](InternalThreadCutterOptions.md#bevelbottom) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=0.
+
+- [`bevelSize`](InternalThreadCutterOptions.md#bevelsize) · `number` · Optional
+
+  Axial bevel extent in millimetres. Active blunt ends default to one sixth of the compensated
+  male minor radius or female major radius; other ends default to the profile depth.
+
+- [`bevelTop`](InternalThreadCutterOptions.md#beveltop) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=length.
+
+
+
+## Returns
+
+[`HelicalThreadSolidMeshPreflight`](HelicalThreadSolidMeshPreflight.md)
+
+
+## Related APIs
+
+- [HelicalThreadSolidMeshPreflight](HelicalThreadSolidMeshPreflight.md)
+- [InternalThreadCutterOptions](InternalThreadCutterOptions.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,56 @@
+# preflightSvgRegion
+
+Preflights bounded SVG geometry without browser or Manifold dependencies.
+
+**preflightSvgRegion**(`svg`: `string`, `options?`: [`SvgImportOptions`](SvgImportOptions.md)): [`SvgRegionPreflight`](SvgRegionPreflight.md)
+
+
+
+## Parameters
+
+<a id="svg"></a>
+
+**`svg`** · `string` · Required
+
+Complete SVG XML source, limited to 256 KiB of UTF-8.
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SvgImportOptions`](SvgImportOptions.md) · Optional
+
+Physical flattening and viewport-origin controls.
+
+- [`limits`](SvgImportOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit profile and circular allocation ceilings; bounded SVG source/work limits remain fixed.
+
+- [`circularSegments`](SvgImportOptions.md#circularsegments) · `number` · Optional
+
+  Exact segments for a complete ellipse or round stroke feature.
+
+- [`resolution`](SvgImportOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+- [`origin`](SvgImportOptions.md#origin) · `"center"` \| `"document"` · Optional
+
+  `"center"` places the viewport center at the origin. `"document"` places its converted
+  lower-left corner at the origin. Default: `"center"`.
+
+
+
+## Returns
+
+[`SvgRegionPreflight`](SvgRegionPreflight.md)
+
+The canonical normalized region plus bounded source, topology, and safe-repair facts.
+
+
+## Related APIs
+
+- [SvgImportOptions](SvgImportOptions.md)
+- [SvgRegionPreflight](SvgRegionPreflight.md)
+
+Package: `@metamesh/modeling@0.14.0`.