@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,46 @@
+# CorrespondingComponent
+
+One sampled component retaining contour identities and logical point correspondence.
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Stable canonical lowercase identity; unique within the containing topology or output.
+
+***
+
+### outer
+
+
+
+`readonly` **outer**: [`CorrespondingContour`](CorrespondingContour.md)
+
+
+
+Counterclockwise outer contour.
+
+***
+
+### holes
+
+
+
+`readonly` **holes**: readonly [`CorrespondingContour`](CorrespondingContour.md)[]
+
+
+
+Clockwise hole contours belonging to this component.
+
+
+## Related APIs
+
+- [CorrespondingContour](CorrespondingContour.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,46 @@
+# CorrespondingContour
+
+A sampled contour retaining logical slots, including intentionally collapsed spans.
+
+## Properties
+
+### id
+
+
+
+`readonly` **id**: `string`
+
+
+
+Stable canonical lowercase identity; unique within the containing topology or output.
+
+***
+
+### points
+
+
+
+`readonly` **points**: [`Contour`](Contour.md)
+
+
+
+Ordered sampled points in millimetres; closing vertices are implicit.
+
+***
+
+### spans
+
+
+
+`readonly` **spans**: readonly `string`[]
+
+
+
+One span identity per point; indices correspond between every matched family member.
+
+
+## Related APIs
+
+- [Contour](Contour.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,22 @@
+# CorrespondingProfile
+
+Shared logical contour sampling suitable for a loft or hollow sweep.
+
+## Properties
+
+### components
+
+
+
+`readonly` **components**: readonly [`CorrespondingComponent`](CorrespondingComponent.md)[]
+
+
+
+Ordered components with explicit contour identities.
+
+
+## Related APIs
+
+- [CorrespondingComponent](CorrespondingComponent.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,27 @@
+# CorrespondingProfileStation
+
+One already matched profile at an explicit height or right-handed spatial frame.
+
+**CorrespondingProfileStation** = [`LoftPlacement`](LoftPlacement.md) & `object`
+
+
+
+## Type Declaration
+
+### profile
+
+
+
+`readonly` **profile**: [`CorrespondingProfile`](CorrespondingProfile.md)
+
+
+
+Already corresponding filled contours with authoritative landmark slots.
+
+
+## Related APIs
+
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [LoftPlacement](LoftPlacement.md)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,58 @@
+# CylinderOptions
+
+Dimensions, placement, independent end finishing, and tessellation for a Z-axis cylinder or frustum.
+
+**CylinderOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`RadialSizingOptions`](RadialSizingOptions.md) & [`PrimitivePlacement`](PrimitivePlacement.md) & `object` & (\{ `radius`: `number` \| readonly \[`bottom`: `number`, `top`: `number`\]; `diameter?`: `never`; \} \| \{ `diameter`: `number` \| readonly \[`bottom`: `number`, `top`: `number`\]; `radius?`: `never`; \})
+
+
+
+## Type Declaration
+
+### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
+
+Centers the solid on the Z origin when `true`; otherwise its bottom is at `Z = 0`.
+
+#### Default Value
+
+`true`
+
+### ends?
+
+
+
+`readonly` `optional` **ends?**: [`EndTreatments`](EndTreatments.md)
+
+
+
+Independent end treatments; first setback is cap inset and second follows the sloped side.
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Total height along +Z in millimetres.
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [EndTreatments](EndTreatments.md)
+- [PrimitivePlacement](PrimitivePlacement.md)
+- [RadialSizingOptions](RadialSizingOptions.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,23 @@
+# DiagnosticOptions
+
+Typed parameter association for an assertion or warning.
+
+## Type Parameters
+
+### P
+
+`P`
+
+## Properties
+
+### parameterId?
+
+
+
+`readonly` `optional` **parameterId?**: `Extract`\<keyof `P`, `string`\>
+
+
+
+Existing top-level parameter key.
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,22 @@
+# EdgeTreatment
+
+Uniform finishing vocabulary shared by applicable solid edges and profile corners.
+
+**EdgeTreatment** = [`ChamferedEdgeTreatment`](ChamferedEdgeTreatment.md) \| [`RoundedEdgeTreatment`](RoundedEdgeTreatment.md) \| [`SmoothEdgeTreatment`](SmoothEdgeTreatment.md) \| [`ProfiledEdgeTreatment`](ProfiledEdgeTreatment.md)
+
+
+
+
+## Related APIs
+
+- [ChamferedEdgeTreatment](ChamferedEdgeTreatment.md)
+- [ProfiledEdgeTreatment](ProfiledEdgeTreatment.md)
+- [RoundedEdgeTreatment](RoundedEdgeTreatment.md)
+- [SmoothEdgeTreatment](SmoothEdgeTreatment.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,21 @@
+# EllipseContourOptions
+
+Ellipse dimensions with exactly one XY radii or full-size tuple and explicit sampling.
+
+**EllipseContourOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & (\{ `radius`: [`Vector2`](Vector2.md); `size?`: `never`; \} \| \{ `size`: [`Vector2`](Vector2.md); `radius?`: `never`; \})
+
+
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [Vector2](Vector2.md)
+
+## Guides
+
+- [Section, hole, offset, and extrusion](../../guides/recipes.md#section-hole-offset-and-extrusion)
+- [SVG sections: fills and strokes are different inputs](../../guides/concepts.md#svg-sections-fills-and-strokes-are-different-inputs)
+- [Text and font variability](../../guides/concepts.md#text-and-font-variability)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,21 @@
+# EllipseOptions
+
+Ellipse dimensions in local XY, with exactly one radii or full-size tuple.
+
+**EllipseOptions** = [`EllipseContourOptions`](EllipseContourOptions.md) & [`PrimitivePlacement`](PrimitivePlacement.md)
+
+
+
+
+## Related APIs
+
+- [EllipseContourOptions](EllipseContourOptions.md)
+- [PrimitivePlacement](PrimitivePlacement.md)
+
+## Guides
+
+- [Section, hole, offset, and extrusion](../../guides/recipes.md#section-hole-offset-and-extrusion)
+- [SVG sections: fills and strokes are different inputs](../../guides/concepts.md#svg-sections-fills-and-strokes-are-different-inputs)
+- [Text and font variability](../../guides/concepts.md#text-and-font-variability)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,39 @@
+# EndTreatments
+
+Independent inward finishing on primitive or straight convex extrusion ends. Zero amounts leave the end untreated, including when all ends are disabled.
+
+## Properties
+
+### bottom?
+
+
+
+`readonly` `optional` **bottom?**: [`EdgeTreatment`](EdgeTreatment.md)
+
+
+
+Bottom cap and adjoining side; omitted leaves the end untreated.
+
+***
+
+### top?
+
+
+
+`readonly` `optional` **top?**: [`EdgeTreatment`](EdgeTreatment.md)
+
+
+
+Top cap and adjoining side; omitted leaves the end untreated.
+
+
+## Related APIs
+
+- [EdgeTreatment](EdgeTreatment.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.13.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` \| [`Vector2`](Vector2.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)
+- [Vector2](Vector2.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.13.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.13.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.13.0`.