@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,110 @@
+# TorusOptions
+
+Dimensions and independent ring/profile tessellation for a torus around the Z axis.
+
+## Extends
+
+- [`PrimitivePlacement`](PrimitivePlacement.md)
+
+## Properties
+
+### placement?
+
+
+
+`readonly` `optional` **placement?**: [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md)
+
+
+
+Applied after local construction; Section placement must preserve the XY plane.
+
+#### Inherited from
+
+[`PrimitivePlacement`](PrimitivePlacement.md).[`placement`](PrimitivePlacement.md#placement)
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings, bounded by the host policy.
+
+***
+
+### majorRadius
+
+
+
+`readonly` **majorRadius**: `number`
+
+
+
+Radius from the Z axis to the profile center, in millimetres; greater than `minorRadius`.
+
+***
+
+### majorSegments?
+
+
+
+`readonly` `optional` **majorSegments?**: `number`
+
+
+
+Exact segment count around the Z axis; omitted uses adaptive resolution.
+
+***
+
+### minorRadius
+
+
+
+`readonly` **minorRadius**: `number`
+
+
+
+Radius of the swept circular profile in millimetres.
+
+***
+
+### minorSegments?
+
+
+
+`readonly` `optional` **minorSegments?**: `number`
+
+
+
+Exact segment count around the swept profile; omitted uses adaptive resolution.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical tessellation policy over the active model-wide policy.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [PrimitivePlacement](PrimitivePlacement.md)
+- [PrimitivePlacementOptions](PrimitivePlacementOptions.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/Transform2.md

@@ -0,0 +1,15 @@
+# Transform2
+
+Row-major affine XY matrix. Translation occupies m02/m12; final row is [0, 0, 1].
+
+**Transform2** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`\]
+
+
+
+
+## Guides
+
+- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,18 @@
+# Transform3
+
+A row-major affine 4x4 matrix applied to column vectors.
+
+**Transform3** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m03`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m13`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`, `m23`: `number`, `m30`: `number`, `m31`: `number`, `m32`: `number`, `m33`: `number`\]
+
+
+
+Translation occupies indices 3, 7, and 11. The final row must be
+`[0, 0, 0, 1]` within the active geometry tolerance.
+
+
+## Guides
+
+- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,42 @@
+# TriangleMesh
+
+A topology-preserving indexed triangle mesh with XYZ vertex positions.
+
+## Extended by
+
+- [`FinalizedPart`](FinalizedPart.md)
+
+## Properties
+
+### indices
+
+
+
+`readonly` **indices**: `Uint32Array`
+
+
+
+Three unsigned vertex indices per triangle.
+
+***
+
+### positions
+
+
+
+`readonly` **positions**: `Float32Array`
+
+
+
+Flat XYZ coordinates, three finite values per vertex.
+
+
+## Related APIs
+
+- [FinalizedPart](FinalizedPart.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,123 @@
+# TriangleMeshAnalysis
+
+Measurements and optional edge-connected topology from one validated mesh traversal.
+
+## Extends
+
+- [`TriangleMeshMeasurements`](TriangleMeshMeasurements.md)
+
+## Properties
+
+### connectedComponentCount?
+
+
+
+`readonly` `optional` **connectedComponentCount?**: `number`
+
+
+
+Number of referenced edge-connected components when `includeTopology` is requested.
+
+***
+
+### edgeCount?
+
+
+
+`readonly` `optional` **edgeCount?**: `number`
+
+
+
+Number of distinct indexed undirected edges when `includeTopology` is requested.
+
+***
+
+### bounds
+
+
+
+`readonly` **bounds**: [`Bounds3`](Bounds3.md)
+
+
+
+Axis-aligned bounds.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`bounds`](TriangleMeshMeasurements.md#bounds)
+
+***
+
+### signedVolume
+
+
+
+`readonly` **signedVolume**: `number`
+
+
+
+Signed enclosed volume; positive values correspond to outward winding.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`signedVolume`](TriangleMeshMeasurements.md#signedvolume)
+
+***
+
+### surfaceArea
+
+
+
+`readonly` **surfaceArea**: `number`
+
+
+
+Sum of all triangle areas in squared model units.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`surfaceArea`](TriangleMeshMeasurements.md#surfacearea)
+
+***
+
+### triangleCount
+
+
+
+`readonly` **triangleCount**: `number`
+
+
+
+Number of indexed triangles.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`triangleCount`](TriangleMeshMeasurements.md#trianglecount)
+
+***
+
+### vertexCount
+
+
+
+`readonly` **vertexCount**: `number`
+
+
+
+Number of distinct entries in the position buffer.
+
+#### Inherited from
+
+[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`vertexCount`](TriangleMeshMeasurements.md#vertexcount)
+
+
+## Related APIs
+
+- [Bounds3](Bounds3.md)
+- [TriangleMeshMeasurements](TriangleMeshMeasurements.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,79 @@
+# TriangleMeshMeasurements
+
+Geometric measurements derived from a validated, non-empty triangle mesh.
+
+## Extended by
+
+- [`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
+
+## Properties
+
+### bounds
+
+
+
+`readonly` **bounds**: [`Bounds3`](Bounds3.md)
+
+
+
+Axis-aligned bounds.
+
+***
+
+### signedVolume
+
+
+
+`readonly` **signedVolume**: `number`
+
+
+
+Signed enclosed volume; positive values correspond to outward winding.
+
+***
+
+### surfaceArea
+
+
+
+`readonly` **surfaceArea**: `number`
+
+
+
+Sum of all triangle areas in squared model units.
+
+***
+
+### triangleCount
+
+
+
+`readonly` **triangleCount**: `number`
+
+
+
+Number of indexed triangles.
+
+***
+
+### vertexCount
+
+
+
+`readonly` **vertexCount**: `number`
+
+
+
+Number of distinct entries in the position buffer.
+
+
+## Related APIs
+
+- [Bounds3](Bounds3.md)
+- [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,143 @@
+# TubeOptions
+
+Dimensions, placement, and tessellation for a hollow Z-axis tube.
+
+## Extends
+
+- [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md)
+- [`PrimitivePlacement`](PrimitivePlacement.md)
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings; bound modeling operations may only lower the host policy.
+
+#### Inherited from
+
+[`CircularPrimitiveOptions`](CircularPrimitiveOptions.md).[`limits`](CircularPrimitiveOptions.md#limits)
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+Exact circumferential segment count from three through the configured safety limit.
+
+This local topology override takes precedence over [CircularPrimitiveOptions.resolution](CircularPrimitiveOptions.md#resolution)
+and any active model-wide resolution policy.
+
+#### Inherited from
+
+[`CircularPrimitiveOptions`](CircularPrimitiveOptions.md).[`segments`](CircularPrimitiveOptions.md#segments)
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical tessellation policy over the active model-wide policy.
+
+#### Inherited from
+
+[`CircularPrimitiveOptions`](CircularPrimitiveOptions.md).[`resolution`](CircularPrimitiveOptions.md#resolution)
+
+***
+
+### placement?
+
+
+
+`readonly` `optional` **placement?**: [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md)
+
+
+
+Applied after local construction; Section placement must preserve the XY plane.
+
+#### Inherited from
+
+[`PrimitivePlacement`](PrimitivePlacement.md).[`placement`](PrimitivePlacement.md#placement)
+
+***
+
+### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
+
+Centers the tube on the Z origin when `true`; otherwise its bottom is at `Z = 0`.
+
+#### Default Value
+
+`true`
+
+***
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Total height along Z in millimetres.
+
+***
+
+### innerRadius
+
+
+
+`readonly` **innerRadius**: `number`
+
+
+
+Positive inner radius in millimetres.
+
+***
+
+### outerRadius
+
+
+
+`readonly` **outerRadius**: `number`
+
+
+
+Outer radius in millimetres; greater than [TubeOptions.innerRadius](#innerradius).
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [PrimitivePlacement](PrimitivePlacement.md)
+- [PrimitivePlacementOptions](PrimitivePlacementOptions.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/Vector2.md

@@ -0,0 +1,15 @@
+# Vector2
+
+A two-dimensional Cartesian vector or point.
+
+**Vector2** = readonly \[`x`: `number`, `y`: `number`\]
+
+
+
+
+## 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/Vector3.md

@@ -0,0 +1,15 @@
+# Vector3
+
+A three-dimensional Cartesian vector or point.
+
+**Vector3** = readonly \[`x`: `number`, `y`: `number`, `z`: `number`\]
+
+
+
+
+## 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/VectorTextLayout.md

@@ -0,0 +1,40 @@
+# VectorTextLayout
+
+Immutable vector layout with no browser, font parser, or kernel ownership.
+
+## Properties
+
+### paths
+
+
+
+`readonly` **paths**: readonly `string`[]
+
+
+
+Nonzero-filled path data in millimetres, positive Y upward; empty for text with no ink.
+
+***
+
+### metrics
+
+
+
+`readonly` **metrics**: [`VectorTextMetrics`](VectorTextMetrics.md)
+
+
+
+Exact measurements of these paths and their logical text layout.
+
+
+## Related APIs
+
+- [VectorTextMetrics](VectorTextMetrics.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/VectorTextMetrics.md

@@ -0,0 +1,100 @@
+# VectorTextMetrics
+
+Text measurements from the same immutable layout that supplies geometry and SVG outlines.
+
+## Properties
+
+### bounds
+
+
+
+`readonly` **bounds**: [`Bounds2`](Bounds2.md) \| `null`
+
+
+
+Visible curve bounds after alignment, or null when the text has no ink.
+
+***
+
+### advance
+
+
+
+`readonly` **advance**: readonly \[`number`, `number`\]
+
+
+
+Unaligned logical advance and negative baseline displacement in mm; arcs retain [arc length, 0].
+
+***
+
+### logicalWidth
+
+
+
+`readonly` **logicalWidth**: `number`
+
+
+
+Maximum logical line advance in millimetres, including spaces; arc length on circular baselines.
+
+***
+
+### ascent
+
+
+
+`readonly` **ascent**: `number`
+
+
+
+Selected font's ascender distance above a baseline in millimetres, independent of the text.
+
+***
+
+### descent
+
+
+
+`readonly` **descent**: `number`
+
+
+
+Selected font's descender distance below a baseline in millimetres, a non-negative value.
+
+***
+
+### lineHeight
+
+
+
+`readonly` **lineHeight**: `number`
+
+
+
+Actual distance between baselines in millimetres.
+
+***
+
+### lineCount
+
+
+
+`readonly` **lineCount**: `number`
+
+
+
+Number of lines, including empty and trailing lines; empty text occupies one line.
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.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`.