@metamesh/modeling 0.17.0 → 0.19.0

package/dist/docs/reference/export/ExportGeometry.md

@@ -0,0 +1,39 @@
+# ExportGeometry
+
+Local millimetre, Z-up indexed geometry; optional unit normals describe display shading only.
+
+**ExportGeometry** = [`TriangleMeshInput`](../geometry/TriangleMeshInput.md) & `object`
+
+
+
+## Type Declaration
+
+### normals?
+
+
+
+`readonly` `optional` **normals?**: `Float32Array` \| [`ImmutableBuffer`](../geometry/ImmutableBuffer-type.md)\<`Float32Array`\>
+
+
+
+One finite unit XYZ normal per position; omitted normals are derived for GLB.
+
+## Supported imports
+
+```ts
+import type { ExportGeometry } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportGeometry } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportGeometry } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportGeometry } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportGlbOptions.md

@@ -0,0 +1,118 @@
+# ExportGlbOptions
+
+Uncompressed glTF 2.0 binary serialization; converts millimetres/Z-up to metres/Y-up.
+
+## Extends
+
+- [`ExportOptions`](ExportOptions.md)
+
+## Properties
+
+### name?
+
+
+
+`readonly` `optional` **name?**: `string`
+
+
+
+Display name, one through 1024 valid XML characters; defaults to MetaMesh model.
+
+#### Inherited from
+
+[`ExportOptions`](ExportOptions.md).[`name`](ExportOptions.md#name)
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ExportLimits`](ExportLimits.md)\>
+
+
+
+Explicit export ceilings, independent of engine/session configuration.
+
+#### Inherited from
+
+[`ExportOptions`](ExportOptions.md).[`limits`](ExportOptions.md#limits)
+
+***
+
+### meshValidation?
+
+
+
+`readonly` `optional` **meshValidation?**: `"topology"` \| `"solid"`
+
+
+
+Topology validation by default; solid additionally checks bounded intersections and shell nesting.
+
+#### Inherited from
+
+[`ExportOptions`](ExportOptions.md).[`meshValidation`](ExportOptions.md#meshvalidation)
+
+***
+
+### materials?
+
+
+
+`readonly` `optional` **materials?**: readonly [`ExportMaterial`](ExportMaterial.md)[]
+
+
+
+Portable material identities referenced by parts. No slicer or device mapping is implied.
+
+#### Inherited from
+
+[`ExportOptions`](ExportOptions.md).[`materials`](ExportOptions.md#materials)
+
+***
+
+### signal?
+
+
+
+`readonly` `optional` **signal?**: `AbortSignal`
+
+
+
+Cancellation checked between bounded writing tasks; browser hosts should schedule CPU work in a Worker.
+
+#### Inherited from
+
+[`ExportOptions`](ExportOptions.md).[`signal`](ExportOptions.md#signal)
+
+***
+
+### creaseAngle?
+
+
+
+`readonly` `optional` **creaseAngle?**: `number`
+
+
+
+Normal smoothing threshold in degrees from zero through 180; defaults to 20. Authored normals take precedence.
+
+
+## Related APIs
+
+- [ExportLimits](ExportLimits.md)
+- [ExportMaterial](ExportMaterial.md)
+- [ExportOptions](ExportOptions.md)
+
+## Supported imports
+
+```ts
+import type { ExportGlbOptions } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportGlbOptions } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportLimits.md

@@ -0,0 +1,83 @@
+# ExportLimits
+
+Independent trusted export ceilings; output limits also apply to streaming writers.
+
+## Properties
+
+### maxParts
+
+
+
+`readonly` **maxParts**: `number`
+
+
+
+Maximum selected semantic parts.
+
+***
+
+### maxVertices
+
+
+
+`readonly` **maxVertices**: `number`
+
+
+
+Maximum aggregate input vertices across selected instances.
+
+***
+
+### maxTriangles
+
+
+
+`readonly` **maxTriangles**: `number`
+
+
+
+Maximum aggregate input triangles across selected instances.
+
+***
+
+### maxBytes
+
+
+
+`readonly` **maxBytes**: `number`
+
+
+
+Maximum captured unique numeric buffer-view bytes, including authored normals.
+
+***
+
+### maxOutputBytes
+
+
+
+`readonly` **maxOutputBytes**: `number`
+
+
+
+Maximum encoded file bytes; defaults to 512 MiB.
+
+## Supported imports
+
+```ts
+import type { ExportLimits } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportLimits } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportLimits } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportLimits } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportMaterial.md

@@ -0,0 +1,47 @@
+# ExportMaterial
+
+Portable print material intent. Equal display colors do not merge different identities.
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Unique canonical lowercase kebab-case identity, preserved by 3MF as the base-material name.
+
+***
+
+### color
+
+
+
+`readonly` **color**: `string`
+
+
+
+Suggested six-digit sRGB display color; does not select filament, extruder, or physical tray.
+
+## Supported imports
+
+```ts
+import type { ExportMaterial } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportMaterial } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportMaterial } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportMaterial } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportOptions.md

@@ -0,0 +1,94 @@
+# ExportOptions
+
+Shared serialization policy; hosts own scheduling, filenames, and delivery.
+
+## Extended by
+
+- [`ExportGlbOptions`](ExportGlbOptions.md)
+
+## Properties
+
+### name?
+
+
+
+`readonly` `optional` **name?**: `string`
+
+
+
+Display name, one through 1024 valid XML characters; defaults to MetaMesh model.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ExportLimits`](ExportLimits.md)\>
+
+
+
+Explicit export ceilings, independent of engine/session configuration.
+
+***
+
+### meshValidation?
+
+
+
+`readonly` `optional` **meshValidation?**: `"topology"` \| `"solid"`
+
+
+
+Topology validation by default; solid additionally checks bounded intersections and shell nesting.
+
+***
+
+### materials?
+
+
+
+`readonly` `optional` **materials?**: readonly [`ExportMaterial`](ExportMaterial.md)[]
+
+
+
+Portable material identities referenced by parts. No slicer or device mapping is implied.
+
+***
+
+### signal?
+
+
+
+`readonly` `optional` **signal?**: `AbortSignal`
+
+
+
+Cancellation checked between bounded writing tasks; browser hosts should schedule CPU work in a Worker.
+
+
+## Related APIs
+
+- [ExportGlbOptions](ExportGlbOptions.md)
+- [ExportLimits](ExportLimits.md)
+- [ExportMaterial](ExportMaterial.md)
+
+## Supported imports
+
+```ts
+import type { ExportOptions } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportOptions } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportOptions } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportOptions } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportPart.md

@@ -0,0 +1,88 @@
+# ExportPart
+
+A semantic part referencing reusable local geometry, with placement and appearance kept separate.
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Unique canonical lowercase kebab-case identity, at most 64 characters.
+
+***
+
+### geometry
+
+
+
+`readonly` **geometry**: [`ExportGeometry`](ExportGeometry.md)
+
+
+
+Local geometry; engine results and decoded Worker parts are accepted directly.
+
+***
+
+### transform?
+
+
+
+`readonly` `optional` **transform?**: [`Transform3Data`](../geometry/Transform3Data.md)
+
+
+
+Proper rigid row-major local-to-world matrix; translations are millimetres. Defaults to identity.
+
+***
+
+### color?
+
+
+
+`readonly` `optional` **color?**: `string`
+
+
+
+Six-digit sRGB display color; overrides the assigned material's suggested display color.
+
+***
+
+### materialId?
+
+
+
+`readonly` `optional` **materialId?**: `string`
+
+
+
+Stable print material identity from options.materials; never inferred from display color.
+
+
+## Related APIs
+
+- [ExportGeometry](ExportGeometry.md)
+
+## Supported imports
+
+```ts
+import type { ExportPart } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportPart } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportPart } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportPart } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportReport.md

@@ -0,0 +1,82 @@
+# ExportReport
+
+Completed writer metadata; successful completion means the sink accepted every chunk.
+
+## Extended by
+
+- [`ExportedFile`](ExportedFile.md)
+
+## Properties
+
+### mediaType
+
+
+
+`readonly` **mediaType**: `string`
+
+
+
+Registered file media type.
+
+***
+
+### extension
+
+
+
+`readonly` **extension**: [`ExportFormat`](ExportFormat.md)
+
+
+
+File extension without a leading dot.
+
+***
+
+### diagnostics
+
+
+
+`readonly` **diagnostics**: readonly [`ExportDiagnostic`](ExportDiagnostic.md)[]
+
+
+
+Expected format losses; invalid input and failed delivery reject instead.
+
+***
+
+### byteLength
+
+
+
+`readonly` **byteLength**: `number`
+
+
+
+Encoded bytes delivered to the sink.
+
+
+## Related APIs
+
+- [ExportDiagnostic](ExportDiagnostic.md)
+- [ExportedFile](ExportedFile.md)
+- [ExportFormat](ExportFormat.md)
+
+## Supported imports
+
+```ts
+import type { ExportReport } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportReport } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportReport } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportReport } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportSink.md

@@ -0,0 +1,39 @@
+# ExportSink
+
+Receives owned chunks in order. Writers await each call for backpressure; the host closes its destination.
+
+**ExportSink** = (`chunk`: `Uint8Array`) => `void` \| `Promise`\<`void`\>
+
+
+
+## Parameters
+
+<a id="chunk"></a>
+
+**`chunk`** · `Uint8Array` · Required
+
+
+
+## Returns
+
+`void` \| `Promise`\<`void`\>
+
+## Supported imports
+
+```ts
+import type { ExportSink } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportSink } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportSink } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportSink } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportStlOptions.md

@@ -0,0 +1,24 @@
+# ExportStlOptions
+
+Binary STL serialization in millimetres; open triangle surfaces are permitted by default.
+
+**ExportStlOptions** = [`ExportOptions`](ExportOptions.md)
+
+
+
+
+## Related APIs
+
+- [ExportOptions](ExportOptions.md)
+
+## Supported imports
+
+```ts
+import type { ExportStlOptions } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportStlOptions } from "@metamesh/modeling/export/stl";
+```
+
+Package: `@metamesh/modeling@0.19.0`.

package/dist/docs/reference/export/ExportedFile.md

@@ -0,0 +1,110 @@
+# ExportedFile
+
+Owned file bytes and format metadata, usable in both Node and browsers.
+
+## Extends
+
+- [`ExportReport`](ExportReport.md)
+
+## Properties
+
+### mediaType
+
+
+
+`readonly` **mediaType**: `string`
+
+
+
+Registered file media type.
+
+#### Inherited from
+
+[`ExportReport`](ExportReport.md).[`mediaType`](ExportReport.md#mediatype)
+
+***
+
+### extension
+
+
+
+`readonly` **extension**: [`ExportFormat`](ExportFormat.md)
+
+
+
+File extension without a leading dot.
+
+#### Inherited from
+
+[`ExportReport`](ExportReport.md).[`extension`](ExportReport.md#extension)
+
+***
+
+### diagnostics
+
+
+
+`readonly` **diagnostics**: readonly [`ExportDiagnostic`](ExportDiagnostic.md)[]
+
+
+
+Expected format losses; invalid input and failed delivery reject instead.
+
+#### Inherited from
+
+[`ExportReport`](ExportReport.md).[`diagnostics`](ExportReport.md#diagnostics)
+
+***
+
+### byteLength
+
+
+
+`readonly` **byteLength**: `number`
+
+
+
+Encoded bytes delivered to the sink.
+
+#### Inherited from
+
+[`ExportReport`](ExportReport.md).[`byteLength`](ExportReport.md#bytelength)
+
+***
+
+### bytes
+
+
+
+`readonly` **bytes**: `Uint8Array`\<`ArrayBuffer`\>
+
+
+
+Fresh mutable bytes; never aliases the input snapshot.
+
+
+## Related APIs
+
+- [ExportDiagnostic](ExportDiagnostic.md)
+- [ExportFormat](ExportFormat.md)
+- [ExportReport](ExportReport.md)
+
+## Supported imports
+
+```ts
+import type { ExportedFile } from "@metamesh/modeling/export";
+```
+
+```ts
+import type { ExportedFile } from "@metamesh/modeling/export/stl";
+```
+
+```ts
+import type { ExportedFile } from "@metamesh/modeling/export/3mf";
+```
+
+```ts
+import type { ExportedFile } from "@metamesh/modeling/export/glb";
+```
+
+Package: `@metamesh/modeling@0.19.0`.