@metamesh/modeling 0.12.0 → 0.14.0

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

@@ -0,0 +1,140 @@
+# ExtrudeOptions
+
+Dimensions and sampling shared by native and pure +Z extrusion.
+
+## Extends
+
+- `ExtrusionSamplingOptions`
+
+## Properties
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Positive extrusion height in millimetres.
+
+***
+
+### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
+
+Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
+
+***
+
+### ends?
+
+
+
+`readonly` `optional` **ends?**: [`EndTreatments`](EndTreatments.md)
+
+
+
+Independent inward end treatments on straight convex single-contour extrusions.
+
+***
+
+### divisions?
+
+
+
+`readonly` `optional` **divisions?**: `number`
+
+
+
+Exact number of intermediate profiles, nonnegative; overrides physical sampling.
+
+#### Inherited from
+
+`ExtrusionSamplingOptions.divisions`
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
+
+
+
+Explicit output and sampling allocation ceilings.
+
+#### Inherited from
+
+`ExtrusionSamplingOptions.limits`
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical policy over the nearest model scope.
+
+#### Inherited from
+
+`ExtrusionSamplingOptions.resolution`
+
+***
+
+### scaleTop?
+
+
+
+`readonly` `optional` **scaleTop?**: `number` \| [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Finite uniform or XY scale of the top profile; defaults to one.
+
+#### Inherited from
+
+`ExtrusionSamplingOptions.scaleTop`
+
+***
+
+### twistDegrees?
+
+
+
+`readonly` `optional` **twistDegrees?**: `number`
+
+
+
+Finite rotation of the top profile about +Z, in degrees; defaults to zero.
+
+#### Inherited from
+
+`ExtrusionSamplingOptions.twistDegrees`
+
+
+## Related APIs
+
+- [EndTreatments](EndTreatments.md)
+- [GeometryResolution](GeometryResolution.md)
+- [ModelingLimits](ModelingLimits.md)
+- [Vector2Tuple](Vector2Tuple.md)
+
+## Guides
+
+- [Revolve a radial profile](../../guides/recipes.md#revolve-a-radial-profile)
+- [Rotation-minimizing path sweep](../../guides/recipes.md#rotation-minimizing-path-sweep)
+- [Matched-section loft](../../guides/recipes.md#matched-section-loft)
+- [Choose a modeling path](../../guides/concepts.md#choose-a-modeling-path)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,121 @@
+# FinalizedModel
+
+Finalized manufacturing snapshot. Its arrays are independent of all native values.
+
+## Extended by
+
+- [`ModelSnapshot`](../engine/ModelSnapshot.md)
+
+## Properties
+
+### parts
+
+
+
+`readonly` **parts**: readonly [`FinalizedPart`](FinalizedPart.md)[]
+
+
+
+Ordered finalized manufacturing parts with copied transferable arrays.
+
+***
+
+### bounds
+
+
+
+`readonly` **bounds**: [`Bounds3`](Bounds3.md)
+
+
+
+Axis-aligned XYZ bounds in millimetres.
+
+***
+
+### stats
+
+
+
+`readonly` **stats**: `object`
+
+
+
+Aggregate counts, unique backing storage, volume, and execution timings.
+
+#### vertices
+
+
+
+`readonly` **vertices**: `number`
+
+
+
+Aggregate position-buffer vertex count.
+
+#### triangles
+
+
+
+`readonly` **triangles**: `number`
+
+
+
+Aggregate indexed triangle count.
+
+#### volumeMm3
+
+
+
+`readonly` **volumeMm3**: `number`
+
+
+
+Signed enclosed volume of all selected parts in cubic millimetres.
+
+#### bytes
+
+
+
+`readonly` **bytes**: `number`
+
+
+
+Unique transferable backing-buffer bytes, counted once across all parts.
+
+#### buildMs
+
+
+
+`readonly` **buildMs**: `number`
+
+
+
+Synchronous callback duration in milliseconds.
+
+#### finalizationMs
+
+
+
+`readonly` **finalizationMs**: `number`
+
+
+
+Manufacturing validation and buffer finalization duration in milliseconds.
+
+#### generationMs
+
+
+
+`readonly` **generationMs**: `number`
+
+
+
+Total callback and finalization duration in milliseconds.
+
+
+## Related APIs
+
+- [Bounds3](Bounds3.md)
+- [FinalizedPart](FinalizedPart.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,87 @@
+# FinalizedPart
+
+Copied manufacturing part with facts computed from the finalized mesh.
+
+## Extends
+
+- [`TriangleMesh`](TriangleMesh.md)
+
+## Extended by
+
+- [`SnapshotPart`](../engine/SnapshotPart.md)
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Stable canonical lowercase identity; unique within the containing topology or output.
+
+***
+
+### color?
+
+
+
+`readonly` `optional` **color?**: `string`
+
+
+
+Optional six-digit hex RGB display color.
+
+***
+
+### measurements
+
+
+
+`readonly` **measurements**: [`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
+
+
+
+Fresh validated facts for these exact finalized buffers.
+
+***
+
+### indices
+
+
+
+`readonly` **indices**: `Uint32Array`
+
+
+
+Three unsigned vertex indices per triangle.
+
+#### Inherited from
+
+[`TriangleMesh`](TriangleMesh.md).[`indices`](TriangleMesh.md#indices)
+
+***
+
+### positions
+
+
+
+`readonly` **positions**: `Float32Array`
+
+
+
+Flat XYZ coordinates, three finite values per vertex.
+
+#### Inherited from
+
+[`TriangleMesh`](TriangleMesh.md).[`positions`](TriangleMesh.md#positions)
+
+
+## Related APIs
+
+- [TriangleMesh](TriangleMesh.md)
+- [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
+
+Package: `@metamesh/modeling@0.14.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**: [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+World-space origin of the local frame.
+
+***
+
+### xAxis
+
+
+
+`readonly` **xAxis**: [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+Unit vector defining the local +X axis.
+
+***
+
+### yAxis
+
+
+
+`readonly` **yAxis**: [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+Unit vector defining the local +Y axis.
+
+***
+
+### zAxis
+
+
+
+`readonly` **zAxis**: [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+Unit vector defining the local +Z axis.
+
+
+## Related APIs
+
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.14.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.14.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)\<[`Vector3Input`](Vector3Input.md)\> · Optional
+
+  XYZ vector or tuple translation in millimetres, applied after rotation; defaults to zero.
+
+- [`rotation`](PartOptions.md#rotation) · [`ComputedValue`](ComputedValue.md)\<[`Vector3Input`](Vector3Input.md)\> · Optional
+
+  XYZ vector or tuple of 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.14.0`.