@metamesh/modeling 0.11.0 → 0.13.0

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

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

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

@@ -0,0 +1,37 @@
+# GenerateCallback
+
+Pure synchronous callback returning one declared part or an array; caches are optional.
+
+**GenerateCallback**\<`P`, `S` = `Record`\<`never`, `never`\>\> = (`context`: [`GenerateContext`](GenerateContext.md)\<`P`, `S`\>) => [`GeneratedPart`](GeneratedPart.md) \| readonly [`GeneratedPart`](GeneratedPart.md)[]
+
+
+
+## Type Parameters
+
+### P
+
+`P`
+
+### S
+
+`S` = `Record`\<`never`, `never`\>
+
+## Parameters
+
+<a id="context"></a>
+
+**`context`** · [`GenerateContext`](GenerateContext.md)\<`P`, `S`\> · Required
+
+
+
+## Returns
+
+[`GeneratedPart`](GeneratedPart.md) \| readonly [`GeneratedPart`](GeneratedPart.md)[]
+
+
+## Related APIs
+
+- [GenerateContext](GenerateContext.md)
+- [GeneratedPart](GeneratedPart.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,277 @@
+# GenerateContext
+
+The sole synchronous authoring context, supplied independently of Studio.
+
+## Type Parameters
+
+### P
+
+`P`
+
+### S
+
+`S` = `Record`\<`never`, `never`\>
+
+## Properties
+
+### params
+
+
+
+`readonly` **params**: `Readonly`\<`P`\>
+
+
+
+Frozen ordinary parameter values; synchronous top-level reads are tracked.
+
+***
+
+### services
+
+
+
+`readonly` **services**: `Readonly`\<`S`\>
+
+
+
+Host-prepared readonly synchronous capabilities, fixed for the session.
+
+***
+
+### computed
+
+
+
+`readonly` **computed**: \<`T`\>(`id`: `string`, `callback`: () => `T`, `dependencies?`: readonly `unknown`[]) => [`Computed`](Computed.md)\<`T`\>
+
+
+
+Registers a lazy pure calculation and automatically tracks parameter and computed-reader reads.
+Optional dependencies add changing outer captures; entries compare with Object.is. Objects and
+arrays must be deeply immutable. An empty list still tracks reads inside the callback.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+<a id="id"></a>
+
+**`id`** · `string` · Required
+
+
+
+##### callback
+
+() => `T`
+
+<a id="dependencies"></a>
+
+**`dependencies`** · readonly `unknown`[] · Optional
+
+
+
+#### Returns
+
+[`Computed`](Computed.md)\<`T`\>
+
+***
+
+### part
+
+
+
+`readonly` **part**: \{(`id`: `string`, `geometry`: [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\>): [`GeneratedPart`](GeneratedPart.md); (`id`: `string`, `options`: [`PartOptions`](PartOptions.md)): [`GeneratedPart`](GeneratedPart.md); \}
+
+
+
+Declares a semantic part with identity placement, or explicit placement and appearance.
+
+#### Call Signature
+
+
+
+(`id`: `string`, `geometry`: [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\>): [`GeneratedPart`](GeneratedPart.md)
+
+
+
+##### Parameters
+
+<a id="id-1"></a>
+
+**`id`** · `string` · Required
+
+
+
+<a id="geometry"></a>
+
+**`geometry`** · [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\> · Required
+
+
+
+##### Returns
+
+[`GeneratedPart`](GeneratedPart.md)
+
+#### Call Signature
+
+
+
+(`id`: `string`, `options`: [`PartOptions`](PartOptions.md)): [`GeneratedPart`](GeneratedPart.md)
+
+
+
+##### Parameters
+
+<a id="id-2"></a>
+
+**`id`** · `string` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`PartOptions`](PartOptions.md) · Required
+
+- [`geometry`](PartOptions.md#geometry) · [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\> · Required
+
+  Local geometry or a lazy reader; native objects never cross a revision.
+
+- [`position`](PartOptions.md#position) · [`ComputedValue`](ComputedValue.md)\<[`Vector3`](Vector3.md)\> · Optional
+
+  XYZ translation in millimetres, applied after rotation; defaults to zero.
+
+- [`rotation`](PartOptions.md#rotation) · [`ComputedValue`](ComputedValue.md)\<[`Vector3`](Vector3.md)\> · Optional
+
+  Fixed global X, Y, Z rotations in degrees; defaults to zero.
+
+- [`color`](PartOptions.md#color) · `string` · Optional
+
+  Optional six-digit hexadecimal semantic part color.
+
+
+
+##### Returns
+
+[`GeneratedPart`](GeneratedPart.md)
+
+***
+
+### assert
+
+
+
+`readonly` **assert**: \{(`condition`: `false`, `message`: `string`, `options?`: [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\>): `never`; (`condition`: `boolean`, `message`: `string`, `options?`: [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\>): `void`; \}
+
+
+
+Immediately aborts on false; geometry observations in the condition run first.
+
+#### Call Signature
+
+
+
+(`condition`: `false`, `message`: `string`, `options?`: [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\>): `never`
+
+
+
+##### Parameters
+
+<a id="condition"></a>
+
+**`condition`** · `false` · Required
+
+
+
+<a id="message"></a>
+
+**`message`** · `string` · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\> · Optional
+
+
+
+##### Returns
+
+`never`
+
+#### Call Signature
+
+
+
+(`condition`: `boolean`, `message`: `string`, `options?`: [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\>): `void`
+
+
+
+##### Parameters
+
+<a id="condition-1"></a>
+
+**`condition`** · `boolean` · Required
+
+
+
+<a id="message-1"></a>
+
+**`message`** · `string` · Required
+
+
+
+<a id="options-2"></a>
+
+**`options`** · [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\> · Optional
+
+
+
+##### Returns
+
+`void`
+
+***
+
+### warn
+
+
+
+`readonly` **warn**: (`message`: `string`, `options?`: [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\>) => `void`
+
+
+
+Records a nonblocking issue; call only in the outer generation callback.
+
+#### Parameters
+
+<a id="message-2"></a>
+
+**`message`** · `string` · Required
+
+
+
+<a id="options-3"></a>
+
+**`options`** · [`DiagnosticOptions`](DiagnosticOptions.md)\<`P`\> · Optional
+
+
+
+#### Returns
+
+`void`
+
+
+## Related APIs
+
+- [Computed](Computed.md)
+- [ComputedValue](ComputedValue.md)
+- [DiagnosticOptions](DiagnosticOptions.md)
+- [GeneratedPart](GeneratedPart.md)
+- [PartGeometry](PartGeometry.md)
+- [PartOptions](PartOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,93 @@
+# GeneratedPart
+
+One declared output part. Construct with the context's `part` helper.
+
+## Extends
+
+- [`PartOptions`](PartOptions.md)
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Unique canonical lowercase hyphen-separated identity, at most 64 characters.
+
+***
+
+### geometry
+
+
+
+`readonly` **geometry**: [`ComputedValue`](ComputedValue.md)\<[`PartGeometry`](PartGeometry.md)\>
+
+
+
+Local geometry or a lazy reader; native objects never cross a revision.
+
+#### Inherited from
+
+[`PartOptions`](PartOptions.md).[`geometry`](PartOptions.md#geometry)
+
+***
+
+### position?
+
+
+
+`readonly` `optional` **position?**: [`ComputedValue`](ComputedValue.md)\<[`Vector3`](Vector3.md)\>
+
+
+
+XYZ translation in millimetres, applied after rotation; defaults to zero.
+
+#### Inherited from
+
+[`PartOptions`](PartOptions.md).[`position`](PartOptions.md#position)
+
+***
+
+### rotation?
+
+
+
+`readonly` `optional` **rotation?**: [`ComputedValue`](ComputedValue.md)\<[`Vector3`](Vector3.md)\>
+
+
+
+Fixed global X, Y, Z rotations in degrees; defaults to zero.
+
+#### Inherited from
+
+[`PartOptions`](PartOptions.md).[`rotation`](PartOptions.md#rotation)
+
+***
+
+### color?
+
+
+
+`readonly` `optional` **color?**: `string`
+
+
+
+Optional six-digit hexadecimal semantic part color.
+
+#### Inherited from
+
+[`PartOptions`](PartOptions.md).[`color`](PartOptions.md#color)
+
+
+## Related APIs
+
+- [ComputedValue](ComputedValue.md)
+- [PartGeometry](PartGeometry.md)
+- [PartOptions](PartOptions.md)
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,41 @@
+# GenerationDiagnostic
+
+Structured user-facing issue associated with the attempted revision.
+
+## Properties
+
+### severity
+
+
+
+`readonly` **severity**: `"error"` \| `"warning"`
+
+
+
+An error aborts generation; a warning allows generation to continue.
+
+***
+
+### message
+
+
+
+`readonly` **message**: `string`
+
+
+
+Human-readable corrective guidance.
+
+***
+
+### parameterId?
+
+
+
+`readonly` `optional` **parameterId?**: `string`
+
+
+
+Optional control identity, validated against the supplied parameters.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,54 @@
+# GenerationError
+
+A user-correctable assertion failure. Successful computation caches never retain failures.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+
+
+**new GenerationError**(`diagnostics`: readonly [`GenerationDiagnostic`](GenerationDiagnostic.md)[]): `GenerationError`
+
+
+
+Captures immutable diagnostics; unexpected author errors retain their original type.
+
+#### Parameters
+
+<a id="diagnostics"></a>
+
+**`diagnostics`** · readonly [`GenerationDiagnostic`](GenerationDiagnostic.md)[] · Required
+
+
+
+#### Returns
+
+`GenerationError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### diagnostics
+
+
+
+`readonly` **diagnostics**: readonly [`GenerationDiagnostic`](GenerationDiagnostic.md)[]
+
+
+
+Issues reached in normal JavaScript order, ending with the first failed assertion.
+
+
+## Related APIs
+
+- [GenerationDiagnostic](GenerationDiagnostic.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

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

package/dist/docs/reference/model/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`.