@metamesh/modeling 0.12.0 → 0.13.0

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

@@ -0,0 +1,97 @@
+# GeometryError
+
+Error raised when a geometry precondition or invariant is not satisfied.
+
+Callers may use `code` for coarse recovery decisions. Human-facing details
+remain in `message`; messages are descriptive but are not a stable API.
+
+## Example
+
+```ts
+const error = new GeometryError("INVALID_ARGUMENT", "Radius must be positive.", {
+  operation: "example",
+  details: { radius: 0 },
+});
+```
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+
+
+**new GeometryError**(`code`: [`GeometryErrorCode`](GeometryErrorCode.md), `message`: `string`, `context?`: [`GeometryErrorContext`](GeometryErrorContext.md)): `GeometryError`
+
+
+
+Creates a geometry error with a stable category, operation, and descriptive message.
+
+#### Parameters
+
+<a id="code"></a>
+
+**`code`** · [`GeometryErrorCode`](GeometryErrorCode.md) · Required
+
+Machine-readable failure category.
+
+
+
+<a id="message"></a>
+
+**`message`** · `string` · Required
+
+Human-readable diagnostic message.
+
+
+
+<a id="context"></a>
+
+**`context`** · [`GeometryErrorContext`](GeometryErrorContext.md) · Optional
+
+Operation and optional scalar facts. Defaults to `{ operation: "geometry" }`.
+
+
+
+#### Returns
+
+`GeometryError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### code
+
+
+
+`readonly` **code**: [`GeometryErrorCode`](GeometryErrorCode.md)
+
+
+
+Machine-readable failure category.
+
+***
+
+### context
+
+
+
+`readonly` **context**: [`GeometryErrorContext`](GeometryErrorContext.md)
+
+
+
+Operation and scalar facts associated with the failure.
+
+
+## Related APIs
+
+- [GeometryErrorCode](GeometryErrorCode.md)
+- [GeometryErrorContext](GeometryErrorContext.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,7 @@
+# GeometryErrorCode
+
+Stable categories for invalid inputs, topology, allocation, and runtime failures.
+
+**GeometryErrorCode** = `"COMPLEXITY_LIMIT"` \| `"DEGENERATE_GEOMETRY"` \| `"INVALID_ARGUMENT"` \| `"INVALID_MESH"` \| `"INVALID_TOPOLOGY"` \| `"INVALID_TOLERANCE"` \| `"NON_FINITE_VALUE"` \| `"SELF_INTERSECTION"` \| `"SINGULAR_TRANSFORM"` \| `"UNSUPPORTED_RUNTIME"`
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,29 @@
+# GeometryErrorContext
+
+Serializable context attached to a geometry failure.
+
+## Properties
+
+### details?
+
+
+
+`readonly` `optional` **details?**: `Readonly`\<`Record`\<`string`, `string` \| `number` \| `boolean`\>\>
+
+
+
+Optional scalar facts useful for diagnostics without parsing the message.
+
+***
+
+### operation
+
+
+
+`readonly` **operation**: `string`
+
+
+
+Stable operation name, such as `normalizeContour` or `extrude`.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,65 @@
+# GeometryResolution
+
+Tessellation policy for sampled geometry measured in millimetres.
+
+## Properties
+
+### circularSegments?
+
+
+
+`readonly` `optional` **circularSegments?**: `number`
+
+
+
+Optional exact full-circle segment count, of at least three, bounded by the selected circular ceiling.
+
+***
+
+### maxChordError?
+
+
+
+`readonly` `optional` **maxChordError?**: `number`
+
+
+
+Maximum radial chord error in millimetres; defaults to 0.05.
+
+***
+
+### maxSegmentLength?
+
+
+
+`readonly` `optional` **maxSegmentLength?**: `number`
+
+
+
+Optional maximum sampled edge length in millimetres.
+
+***
+
+### maximumSegments?
+
+
+
+`readonly` `optional` **maximumSegments?**: `number`
+
+
+
+Upper safety bound for a full circle; defaults to the selected maxCircularSegments (512 by default).
+
+***
+
+### minimumSegments?
+
+
+
+`readonly` `optional` **minimumSegments?**: `number`
+
+
+
+Lower full-circle segment count; defaults to 16 or a lower selected circular ceiling.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,62 @@
+# GeometrySamplingLimits
+
+Explicit allocation ceilings for pure sampling and host-owned modeling operations.
+
+## Extended by
+
+- [`ModelingLimits`](ModelingLimits.md)
+
+## Properties
+
+### maxPathPoints
+
+
+
+`readonly` **maxPathPoints**: `number`
+
+
+
+Maximum points in one sampled path or placement/frame result.
+
+***
+
+### maxProfilePoints
+
+
+
+`readonly` **maxProfilePoints**: `number`
+
+
+
+Maximum aggregate points in one sampled profile or Section.
+
+***
+
+### maxSweepProfilePoints
+
+
+
+`readonly` **maxSweepProfilePoints**: `number`
+
+
+
+Maximum points in one profile swept along a path.
+
+***
+
+### maxCircularSegments
+
+
+
+`readonly` **maxCircularSegments**: `number`
+
+
+
+Maximum segments around one complete circle.
+
+
+## Related APIs
+
+- [ModelingLimits](ModelingLimits.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,41 @@
+# GeometryToleranceOptions
+
+Optional overrides for MetaMesh's geometry comparison policy.
+
+## Properties
+
+### absolute?
+
+
+
+`readonly` `optional` **absolute?**: `number`
+
+
+
+Absolute distance floor in model units. Must be finite and greater than zero.
+
+***
+
+### angular?
+
+
+
+`readonly` `optional` **angular?**: `number`
+
+
+
+Angular comparison threshold in radians. Must be finite and greater than zero.
+
+***
+
+### relative?
+
+
+
+`readonly` `optional` **relative?**: `number`
+
+
+
+Dimensionless scale multiplier. Must be finite and non-negative.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,42 @@
+# GridPatternOptions
+
+XY or XYZ grid with X varying fastest. The first item starts at the local origin.
+
+**GridPatternOptions** = `object` & (\{ `count`: [`Vector2`](Vector2.md); `spacing`: [`Vector2`](Vector2.md); \} \| \{ `count`: [`Vector3`](Vector3.md); `spacing`: [`Vector3`](Vector3.md); \})
+
+
+
+## Type Declaration
+
+### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
+
+Center the complete distribution around its local origin; defaults to false.
+
+### frame?
+
+
+
+`readonly` `optional` **frame?**: [`Frame3`](Frame3.md)
+
+
+
+Optional right-handed local axes and origin for the grid.
+
+
+## Related APIs
+
+- [Frame3](Frame3.md)
+- [Vector2](Vector2.md)
+- [Vector3](Vector3.md)
+
+## Guides
+
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,14 @@
+# HeightfieldMeshLimits
+
+Trusted output ceilings for pure construction; omitted fields use engine defaults.
+
+**HeightfieldMeshLimits** = `Partial`\<`Pick`\<[`ModelingLimits`](ModelingLimits.md), `"maxVertices"` \| `"maxTriangles"` \| `"maxBytes"`\>\>
+
+
+
+
+## Related APIs
+
+- [ModelingLimits](ModelingLimits.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,67 @@
+# HeightfieldOptions
+
+A closed rectilinear heightfield above a flat base, with uniform or explicit XY samples in millimetres.
+
+**HeightfieldOptions** = `object` & (\{ `size`: [`Vector2`](Vector2.md); `segments`: readonly \[`x`: `number`, `y`: `number`\]; `origin?`: [`Vector2`](Vector2.md); `coordinates?`: `never`; \} \| \{ `coordinates`: \{ `x`: readonly `number`[]; `y`: readonly `number`[]; \}; `size?`: `never`; `segments?`: `never`; `origin?`: `never`; \})
+
+
+
+Uniform sampling requires positive `size: [width, depth]` and positive integer `segments: [x, y]`.
+Optional `origin` sets the lower-left XY corner; omitting it centres the footprint on XY.
+Alternatively, supply `coordinates: { x, y }` with at least two strictly increasing finite
+absolute samples per axis, distinct in Float32. This infers the footprint and interval counts;
+`size`, `segments`, and `origin` cannot be combined with explicit coordinates.
+
+## Type Declaration
+
+### height
+
+
+
+`readonly` **height**: (`point`: [`Vector2`](Vector2.md)) => `number`
+
+
+
+Absolute top Z at the supplied XY point. Every sample must be above baseZ.
+
+#### Parameters
+
+<a id="point"></a>
+
+**`point`** · [`Vector2`](Vector2.md) · Required
+
+
+
+#### Returns
+
+`number`
+
+### baseZ?
+
+
+
+`readonly` `optional` **baseZ?**: `number`
+
+
+
+Flat bottom Z. Defaults to zero.
+
+### triangulation?
+
+
+
+`readonly` `optional` **triangulation?**: `"fixed"` \| `"min-edge"` \| `"center-error"`
+
+
+
+Top-cell diagonal policy. Defaults to fixed (lower-left to upper-right).
+min-edge selects the shorter 3D diagonal; center-error selects the diagonal whose endpoint
+average is closest to one extra height sample at the physical cell centre. Ties use fixed.
+All policies retain two triangles per cell; neither estimates error elsewhere in the cell.
+
+
+## Related APIs
+
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,53 @@
+# HeightfieldPreflight
+
+Predictable rectilinear-grid allocation facts; this does not evaluate the height callback.
+
+## Properties
+
+### sampleCount
+
+
+
+`readonly` **sampleCount**: `number`
+
+
+
+Number of top grid points; center-error also evaluates one height per cell.
+
+***
+
+### vertexCount
+
+
+
+`readonly` **vertexCount**: `number`
+
+
+
+Number of allocated XYZ vertices.
+
+***
+
+### triangleCount
+
+
+
+`readonly` **triangleCount**: `number`
+
+
+
+Number of allocated indexed triangles.
+
+***
+
+### byteCount
+
+
+
+`readonly` **byteCount**: `number`
+
+
+
+Total bytes of Float32 positions and Uint32 indices.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,141 @@
+# HelicalThreadRidgeMeshOptions
+
+Runtime-neutral options for the dedicated helical ridge mesher.
+
+## Extended by
+
+- [`HelicalThreadSolidMeshOptions`](HelicalThreadSolidMeshOptions.md)
+
+## Properties
+
+### ends?
+
+
+
+`readonly` `optional` **ends?**: [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md)
+
+
+
+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?
+
+
+
+`readonly` `optional` **handedness?**: [`ThreadHandedness`](ThreadHandedness.md)
+
+
+
+Helix direction. Default: `right`.
+
+***
+
+### length
+
+
+
+`readonly` **length**: `number`
+
+
+
+Total threaded axial length in millimetres.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
+
+
+
+Explicit output and circular allocation ceilings.
+
+***
+
+### majorDiameter
+
+
+
+`readonly` **majorDiameter**: `number`
+
+
+
+Nominal major diameter before any caller-owned fit compensation.
+
+***
+
+### phaseDegrees?
+
+
+
+`readonly` `optional` **phaseDegrees?**: `number`
+
+
+
+Angular offset of the first start in degrees. Default: `0`.
+
+***
+
+### profile
+
+
+
+`readonly` **profile**: [`ThreadProfile`](ThreadProfile.md)
+
+
+
+Validated periodic profile repeated around the shaft.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Optional circular-resolution policy.
+
+***
+
+### starts?
+
+
+
+`readonly` `optional` **starts?**: `number`
+
+
+
+Number of evenly phased starts. Default: `1`.
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Optional numerical tolerance overrides.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [HelicalThreadSolidMeshOptions](HelicalThreadSolidMeshOptions.md)
+- [ModelingLimits](ModelingLimits.md)
+- [ThreadEndTreatmentOptions](ThreadEndTreatmentOptions.md)
+- [ThreadHandedness](ThreadHandedness.md)
+- [ThreadProfile](ThreadProfile.md)
+
+Package: `@metamesh/modeling@0.13.0`.