@metamesh/modeling 0.18.0 → 0.19.0

package/dist/docs/reference/model/Frame3.md

@@ -1,63 +0,0 @@
-# Frame3
-
-A right-handed orthonormal coordinate frame expressed in world coordinates.
-
-## Properties
-
-### origin
-
-
-
-`readonly` **origin**: [`Vector3Data`](Vector3Data.md)
-
-
-
-World-space origin of the local frame.
-
-***
-
-### xAxis
-
-
-
-`readonly` **xAxis**: [`Vector3Data`](Vector3Data.md)
-
-
-
-Unit vector defining the local +X axis.
-
-***
-
-### yAxis
-
-
-
-`readonly` **yAxis**: [`Vector3Data`](Vector3Data.md)
-
-
-
-Unit vector defining the local +Y axis.
-
-***
-
-### zAxis
-
-
-
-`readonly` **zAxis**: [`Vector3Data`](Vector3Data.md)
-
-
-
-Unit vector defining the local +Z axis.
-
-
-## Related APIs
-
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,102 +0,0 @@
-# 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)
-
-## Guides
-
-- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,15 +0,0 @@
-# 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"`
-
-
-
-
-## Guides
-
-- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,35 +0,0 @@
-# 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`.
-
-
-## Guides
-
-- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,70 +0,0 @@
-# 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.
-
-***
-
-### maxSegments?
-
-
-
-`readonly` `optional` **maxSegments?**: `number`
-
-
-
-Upper safety bound for a full circle; defaults to the selected maxCircularSegments (512 by default).
-
-***
-
-### minSegments?
-
-
-
-`readonly` `optional` **minSegments?**: `number`
-
-
-
-Lower full-circle segment count; defaults to 16 or a lower selected circular ceiling.
-
-
-## Guides
-
-- [Coordinates, units, and resolution](../../guides/concepts.md#coordinates-units-and-resolution)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,62 +0,0 @@
-# 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.18.0`.

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

@@ -1,46 +0,0 @@
-# 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.
-
-
-## Guides
-
-- [Coordinates, units, and resolution](../../guides/concepts.md#coordinates-units-and-resolution)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,50 +0,0 @@
-# GridPatternOptions
-
-XY or XYZ grid with X varying fastest. The first item starts at the local origin. Dimension 2 restricts counts and spacing to XY; any frame must preserve the XY plane.
-
-**GridPatternOptions**\<`Dimension` *extends* `2` \| `3` = `3`\> = `object` & (\{ `count`: [`Vector2Data`](Vector2Data.md); `spacing`: [`Vector2Data`](Vector2Data.md); \} \| `Dimension` *extends* `3` ? `object` : `never`)
-
-
-
-## Type Parameters
-
-### Dimension
-
-`Dimension` *extends* `2` \| `3` = `3`
-
-## 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)
-- [Vector2Data](Vector2Data.md)
-- [Vector3Data](Vector3Data.md)
-
-## Guides
-
-- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
-- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,68 +0,0 @@
-# HeightfieldOptions
-
-A closed rectilinear heightfield above a flat base, with uniform or explicit XY samples in millimetres.
-
-**HeightfieldOptions** = `object` & (\{ `size`: [`Vector2Input`](Vector2Input.md); `segments`: readonly \[`x`: `number`, `y`: `number`\]; `origin?`: [`Vector2Input`](Vector2Input.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`: [`Vector2Data`](Vector2Data.md)) => `number`
-
-
-
-Absolute top Z at the supplied XY point. Every sample must be above baseZ.
-
-#### Parameters
-
-<a id="point"></a>
-
-**`point`** · [`Vector2Data`](Vector2Data.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
-
-- [Vector2Data](Vector2Data.md)
-- [Vector2Input](Vector2Input.md)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/ImmutableBuffer-type.md

@@ -1,108 +0,0 @@
-# ImmutableBuffer
-
-Owned immutable numeric data. Iterate without copying; use copy() for mutable storage.
-
-## Extends
-
-- `Iterable`\<`number`\>
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`NumericArray`](../geometry/NumericArray.md)
-
-## Properties
-
-### \[immutableBufferBrand\]
-
-
-
-`readonly` **\[immutableBufferBrand\]**: `T`
-
-
-
-Opaque element-storage brand; construct buffers with immutableBuffer().
-
-***
-
-### length
-
-
-
-`readonly` **length**: `number`
-
-
-
-Number of numeric elements, independent of their byte width.
-
-## Methods
-
-### at()
-
-
-
-**at**(`index`: `number`): `number` \| `undefined`
-
-
-
-Reads an integer offset; negative offsets count from the end. Invalid offsets return undefined.
-
-#### Parameters
-
-<a id="index"></a>
-
-**`index`** · `number` · Required
-
-
-
-#### Returns
-
-`number` \| `undefined`
-
-***
-
-### copy()
-
-
-
-**copy**(): `T`
-
-
-
-Returns a fresh mutable array of the original numeric type; never exposes cached storage.
-
-#### Returns
-
-`T`
-
-***
-
-### \[iterator\]()
-
-
-
-**\[iterator\]**(): `IterableIterator`\<`number`\>
-
-
-
-Returns an independent read-only iterator over the numeric elements without copying them.
-
-#### Returns
-
-`IterableIterator`\<`number`\>
-
-#### Overrides
-
-`Iterable.[iterator]`
-
-
-## Related APIs
-
-- [NumericArray](NumericArray.md)
-
-## Guides
-
-- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
-
-Package: `@metamesh/modeling@0.18.0`.

package/dist/docs/reference/model/ImmutableTriangleMesh.md

@@ -1,43 +0,0 @@
-# ImmutableTriangleMesh
-
-Immutable local XYZ positions and triangle indices, suitable for a computed value or part.
-
-## Extended by
-
-- [`GeometryResource`](../engine/GeometryResource.md)
-- [`ModelPart`](../engine/ModelPart.md)
-
-## Properties
-
-### positions
-
-
-
-`readonly` **positions**: [`ImmutableBuffer`](../geometry/ImmutableBuffer-type.md)\<`Float32Array`\<`ArrayBufferLike`\>\>
-
-
-
-Packed XYZ coordinates in millimetres.
-
-***
-
-### indices
-
-
-
-`readonly` **indices**: [`ImmutableBuffer`](../geometry/ImmutableBuffer-type.md)\<`Uint32Array`\<`ArrayBufferLike`\>\>
-
-
-
-Zero-based vertex indices, three per triangle.
-
-
-## Related APIs
-
-- [ImmutableBuffer](ImmutableBuffer-type.md)
-
-## Guides
-
-- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
-
-Package: `@metamesh/modeling@0.18.0`.