@metamesh/modeling 0.11.0 → 0.13.0

package/dist/docs/reference/engine/Export3mfOptions.md

@@ -0,0 +1,29 @@
+# Export3mfOptions
+
+Completed-snapshot serialization settings; filename selection belongs to the host.
+
+## Properties
+
+### meshValidation?
+
+
+
+`readonly` `optional` **meshValidation?**: `"topology"` \| `"solid"`
+
+
+
+Optional bounded geometric solid checks on captured buffers; defaults to indexed topology validation.
+
+***
+
+### name?
+
+
+
+`readonly` `optional` **name?**: `string`
+
+
+
+Document display name; defaults to MetaMesh model.
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/ExportMeshPart.md

@@ -0,0 +1,65 @@
+# ExportMeshPart
+
+Manufacturing buffers accepted by the snapshot exporter.
+
+## Extends
+
+- [`TriangleMesh`](../geometry/TriangleMesh.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.
+
+***
+
+### indices
+
+
+
+`readonly` **indices**: `Uint32Array`
+
+
+
+Three unsigned vertex indices per triangle.
+
+#### Inherited from
+
+[`TriangleMesh`](../geometry/TriangleMesh.md).[`indices`](../geometry/TriangleMesh.md#indices)
+
+***
+
+### positions
+
+
+
+`readonly` **positions**: `Float32Array`
+
+
+
+Flat XYZ coordinates, three finite values per vertex.
+
+#### Inherited from
+
+[`TriangleMesh`](../geometry/TriangleMesh.md).[`positions`](../geometry/TriangleMesh.md#positions)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/GenerationOptions.md

@@ -0,0 +1,62 @@
+# GenerationOptions
+
+Execution settings supplied by the host, independently of generator metadata.
+
+## Extended by
+
+- [`SessionOptions`](SessionOptions.md)
+
+## Properties
+
+### meshValidation?
+
+
+
+`readonly` `optional` **meshValidation?**: `"topology"` \| `"solid"`
+
+
+
+Optional bounded intersection and nested-shell checks; defaults to indexed topology validation.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../model/ModelingLimits.md)\>
+
+
+
+Per-build limits, no larger than the configured engine ceilings.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](../model/GeometryResolution.md)
+
+
+
+Physical sampling defaults; operation options and exact counts override these.
+
+***
+
+### meshTopologyMode?
+
+
+
+`readonly` `optional` **meshTopologyMode?**: `"original"` \| `"optimized"`
+
+
+
+Optional bounded planar cleanup; unsupported candidates preserve the original part.
+
+
+## Related APIs
+
+- [SessionOptions](SessionOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/GeometryResource.md

@@ -0,0 +1,77 @@
+# GeometryResource
+
+Validated local geometry resource; accessors return owned buffer copies.
+
+## Extends
+
+- [`TriangleMesh`](../geometry/TriangleMesh.md)
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Session-scoped immutable resource identity, stable while geometry is reused.
+
+***
+
+### revision
+
+
+
+`readonly` **revision**: `number`
+
+
+
+Immutable resource revision; a new resource receives a new identity.
+
+***
+
+### measurements
+
+
+
+`readonly` **measurements**: [`TriangleMeshAnalysis`](../model/TriangleMeshAnalysis.md)
+
+
+
+Facts for the exact local manufacturing buffers.
+
+***
+
+### indices
+
+
+
+`readonly` **indices**: `Uint32Array`
+
+
+
+Three unsigned vertex indices per triangle.
+
+#### Inherited from
+
+[`TriangleMesh`](../geometry/TriangleMesh.md).[`indices`](../geometry/TriangleMesh.md#indices)
+
+***
+
+### positions
+
+
+
+`readonly` **positions**: `Float32Array`
+
+
+
+Flat XYZ coordinates, three finite values per vertex.
+
+#### Inherited from
+
+[`TriangleMesh`](../geometry/TriangleMesh.md).[`positions`](../geometry/TriangleMesh.md#positions)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/ModelDependencies.md

@@ -0,0 +1,41 @@
+# ModelDependencies
+
+Known dependencies for inspection; plain JavaScript bindings do not reveal their parameter origin.
+
+## Properties
+
+### modelParameters
+
+
+
+`readonly` **modelParameters**: readonly `string`[]
+
+
+
+Parameter keys read outside computed callbacks, affecting structure or ordinary code.
+
+***
+
+### computations
+
+
+
+`readonly` **computations**: readonly `object`[]
+
+
+
+Direct dependencies recorded by successfully evaluated computations.
+
+***
+
+### parts
+
+
+
+`readonly` **parts**: readonly `object`[]
+
+
+
+Part reader roots and known transitive parameter dependencies.
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/ModelEngine.md

@@ -0,0 +1,103 @@
+# ModelEngine
+
+Host engine. No native values or manually disposable handles are exposed.
+
+## Properties
+
+### limits
+
+
+
+`readonly` **limits**: [`ModelingLimits`](../model/ModelingLimits.md)
+
+
+
+Immutable resource ceilings selected when this engine was initialized.
+
+## Methods
+
+### createSession()
+
+
+
+**createSession**\<`P`, `S`\>(`program`: [`ModelProgram`](../model/ModelProgram.md)\<`P`, `S`\>, ...`options`: keyof `S` *extends* `never` ? \[`options?`: [`SessionOptions`](SessionOptions.md)\<`S`\>\] : \[`options`: [`SessionOptions`](SessionOptions.md)\<`S`\> & `object`\]): [`ModelSession`](ModelSession.md)\<`P`\>
+
+
+
+Creates isolated caches; prepared service capabilities remain fixed for its lifetime.
+
+#### Type Parameters
+
+##### P
+
+`P`
+
+##### S
+
+`S`
+
+#### Parameters
+
+<a id="program"></a>
+
+**`program`** · [`ModelProgram`](../model/ModelProgram.md)\<`P`, `S`\> · Required
+
+
+
+<a id="options"></a>
+
+**`...options`** · keyof `S` *extends* `never` ? \[`options?`: [`SessionOptions`](SessionOptions.md)\<`S`\>\] : \[`options`: [`SessionOptions`](SessionOptions.md)\<`S`\> & `object`\] · Required
+
+
+
+#### Returns
+
+[`ModelSession`](ModelSession.md)\<`P`\>
+
+***
+
+### export3mf()
+
+
+
+**export3mf**(`parts`: readonly [`ExportMeshPart`](ExportMeshPart.md)[], `options?`: [`Export3mfOptions`](Export3mfOptions.md)): `Promise`\<`ArrayBuffer`\>
+
+
+
+Serializes already finalized mesh parts; never prepares or builds a generator again.
+
+#### Parameters
+
+<a id="parts"></a>
+
+**`parts`** · readonly [`ExportMeshPart`](ExportMeshPart.md)[] · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`Export3mfOptions`](Export3mfOptions.md) · Optional
+
+- [`meshValidation`](Export3mfOptions.md#meshvalidation) · `"topology"` \| `"solid"` · Optional
+
+  Optional bounded geometric solid checks on captured buffers; defaults to indexed topology validation.
+
+- [`name`](Export3mfOptions.md#name) · `string` · Optional
+
+  Document display name; defaults to MetaMesh model.
+
+
+
+#### Returns
+
+`Promise`\<`ArrayBuffer`\>
+
+
+## Related APIs
+
+- [Export3mfOptions](Export3mfOptions.md)
+- [ExportMeshPart](ExportMeshPart.md)
+- [ModelSession](ModelSession.md)
+- [SessionOptions](SessionOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/ModelEngineOptions.md

@@ -0,0 +1,33 @@
+# ModelEngineOptions
+
+Kernel asset initialization. Networking and Worker ownership remain with the host.
+
+## Properties
+
+### locateFile?
+
+
+
+`readonly` `optional` **locateFile?**: () => `string`
+
+
+
+Resolves the kernel's WASM asset. Browser hosts supply their bundled asset URL.
+
+#### Returns
+
+`string`
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../model/ModelingLimits.md)\>
+
+
+
+Trusted application ceilings. Builds may lower them; generators receive no engine.
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/ModelSession.md

@@ -0,0 +1,96 @@
+# ModelSession
+
+Stateful execution owner; a failed revision cannot change previously returned snapshots.
+
+## Type Parameters
+
+### P
+
+`P`
+
+## Methods
+
+### run()
+
+
+
+**run**(`params`: `Readonly`\<`P`\>): [`ModelSnapshot`](ModelSnapshot.md)
+
+
+
+Generates an atomic manufacturing snapshot or throws; parameters are copied and frozen.
+
+#### Parameters
+
+<a id="params"></a>
+
+**`params`** · `Readonly`\<`P`\> · Required
+
+
+
+#### Returns
+
+[`ModelSnapshot`](ModelSnapshot.md)
+
+***
+
+### validate()
+
+
+
+**validate**(`params`: `Readonly`\<`P`\>): readonly [`GenerationDiagnostic`](../model/GenerationDiagnostic.md)[]
+
+
+
+Runs declaration and reached assertions without realizing returned parts.
+
+#### Parameters
+
+<a id="params-1"></a>
+
+**`params`** · `Readonly`\<`P`\> · Required
+
+
+
+#### Returns
+
+readonly [`GenerationDiagnostic`](../model/GenerationDiagnostic.md)[]
+
+***
+
+### clearCache()
+
+
+
+**clearCache**(): `void`
+
+
+
+Clears optional caches without invalidating captured snapshots.
+
+#### Returns
+
+`void`
+
+***
+
+### dispose()
+
+
+
+**dispose**(): `void`
+
+
+
+Releases session ownership; idempotent, captured snapshots remain usable.
+
+#### Returns
+
+`void`
+
+
+## Related APIs
+
+- [ModelSnapshot](ModelSnapshot.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/engine/ModelSnapshot.md

@@ -0,0 +1,173 @@
+# ModelSnapshot
+
+Captured immutable revision; disposal never changes another snapshot or an in-flight export.
+
+## Extends
+
+- [`FinalizedModel`](../model/FinalizedModel.md)
+
+## Properties
+
+### parts
+
+
+
+`readonly` **parts**: readonly [`SnapshotPart`](SnapshotPart.md)[]
+
+
+
+Ordered world-space parts, each referring to reusable local geometry.
+
+#### Overrides
+
+[`FinalizedModel`](../model/FinalizedModel.md).[`parts`](../model/FinalizedModel.md#parts)
+
+***
+
+### diagnostics
+
+
+
+`readonly` **diagnostics**: readonly [`GenerationDiagnostic`](../model/GenerationDiagnostic.md)[]
+
+
+
+Nonblocking diagnostics emitted for this revision.
+
+***
+
+### dependencies
+
+
+
+`readonly` **dependencies**: [`ModelDependencies`](ModelDependencies.md)
+
+
+
+Known dependency graph; outer reads remain conservative model-wide dependencies.
+
+***
+
+### bounds
+
+
+
+`readonly` **bounds**: [`Bounds3`](../model/Bounds3.md)
+
+
+
+Axis-aligned XYZ bounds in millimetres.
+
+#### Inherited from
+
+[`FinalizedModel`](../model/FinalizedModel.md).[`bounds`](../model/FinalizedModel.md#bounds)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`FinalizedModel`](../model/FinalizedModel.md).[`stats`](../model/FinalizedModel.md#stats)
+
+## Methods
+
+### dispose()
+
+
+
+**dispose**(): `void`
+
+
+
+Releases this snapshot's references; idempotent, further access is invalid.
+
+#### Returns
+
+`void`
+
+
+## Related APIs
+
+- [ModelDependencies](ModelDependencies.md)
+- [SnapshotPart](SnapshotPart.md)
+
+Package: `@metamesh/modeling@0.13.0`.