@metamesh/modeling 0.16.0 → 0.18.0

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

@@ -13,7 +13,7 @@ A no-op may reuse the receiver; final part placement belongs in `part` options.
 
 ```ts
 const body = box({ size: [30, 20, 6] })
-  .subtract([cylinder({ height: 8, radius: 3 })])
+  .subtract(cylinder({ height: 8, radius: 3 }))
   .rotate([0, 0, 45]);
 ```
 
@@ -173,15 +173,16 @@ Applies a reusable XYZ placement or canonical row-major matrix.
 
 ***
 
-### toTriangleMesh()
+### toMesh()
 
 
 
-**toTriangleMesh**(): [`TriangleMesh`](TriangleMesh.md)
+**toMesh**(): [`TriangleMesh`](TriangleMesh.md)
 
 
 
-Copies manufacturing mesh buffers for interchange; requires an active model execution.
+Copies indexed Float32 XYZ and Uint32 triangle buffers in millimetres for interchange.
+Requires an active synchronous model execution; the returned TriangleMesh is caller-owned.
 
 #### Returns
 
@@ -189,21 +190,70 @@ Copies manufacturing mesh buffers for interchange; requires an active model exec
 
 ***
 
+### union()
+
+
+
+**union**(`operands`: `Solid` \| readonly `Solid`[]): `Solid`
+
+
+
+Robust union with one or more solids; an empty operand array preserves this solid.
+
+#### Parameters
+
+<a id="operands"></a>
+
+**`operands`** · `Solid` \| readonly `Solid`[] · Required
+
+
+
+#### Returns
+
+`Solid`
+
+***
+
+### intersect()
+
+
+
+**intersect**(`operands`: `Solid` \| readonly `Solid`[]): `Solid`
+
+
+
+Robust intersection with every supplied solid; an empty operand array preserves this solid.
+
+#### Parameters
+
+<a id="operands-1"></a>
+
+**`operands`** · `Solid` \| readonly `Solid`[] · Required
+
+
+
+#### Returns
+
+`Solid`
+
+***
+
 ### subtract()
 
 
 
-**subtract**(`cutters`: readonly `Solid`[]): `Solid`
+**subtract**(`cutters`: `Solid` \| readonly `Solid`[]): `Solid`
 
 
 
-Robust difference; an empty cutter array preserves the source.
+Robust difference removing one cutter or the union of all supplied cutters.
+An empty cutter array preserves this solid.
 
 #### Parameters
 
 <a id="cutters"></a>
 
-**`cutters`** · readonly `Solid`[] · Required
+**`cutters`** · `Solid` \| readonly `Solid`[] · Required
 
 
 
@@ -378,13 +428,200 @@ Takes a filled horizontal slice at Z millimetres.
 
 [`Section`](Section.md)
 
+***
+
+### inspect()
+
+
+
+**inspect**(): [`SolidInspection`](SolidInspection.md)
+
+
+
+Reads immutable bounds, volume in mm³, surface area in mm², and material-component count.
+Requires active synchronous model execution; repeated reads share scoped native results.
+
+#### Returns
+
+[`SolidInspection`](SolidInspection.md)
+
+***
+
+### isEmpty()
+
+
+
+**isEmpty**(): `boolean`
+
+
+
+Checks whether this solid contains no geometry during active synchronous model execution.
+
+#### Returns
+
+`boolean`
+
+***
+
+### components()
+
+
+
+**components**(): readonly `Solid`[]
+
+
+
+Observes disconnected material pieces, retaining each piece's enclosed cavities.
+Requires active synchronous model execution. Empty geometry gives []; order is unspecified.
+Selections and recipes using them can only be evaluated in this session.
+Containment is bounded to 2,000,000 comparisons; this does not cut connected geometry.
+
+#### Returns
+
+readonly `Solid`[]
+
+***
+
+### anchor()
+
+
+
+**anchor**(`name`: `string`): [`Anchor3`](Anchor3.md)
+
+
+
+Reads a copied immutable named anchor during active synchronous model execution.
+
+#### Parameters
+
+<a id="name"></a>
+
+**`name`** · `string` · Required
+
+
+
+#### Returns
+
+[`Anchor3`](Anchor3.md)
+
+***
+
+### distance()
+
+
+
+**distance**(`other`: `Solid`): `number`
+
+
+
+Measures actual minimum separation in millimetres during active synchronous model execution.
+Contact or overlapping material gives zero; empty geometry and cross-session selections reject.
+The kernel manages its search range; results follow native numeric precision.
+
+#### Parameters
+
+<a id="other"></a>
+
+**`other`** · `Solid` · Required
+
+
+
+#### Returns
+
+`number`
+
+***
+
+### castSegment()
+
+
+
+**castSegment**(`origin`: [`Vector3Input`](Vector3Input.md), `endpoint`: [`Vector3Input`](Vector3Input.md)): readonly [`SolidSegmentHit`](SolidSegmentHit.md)[]
+
+
+
+Copies intersections along the finite directed origin-to-endpoint segment in millimetres.
+Requires active synchronous model execution.
+
+#### Parameters
+
+<a id="origin"></a>
+
+**`origin`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+<a id="endpoint"></a>
+
+**`endpoint`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+readonly [`SolidSegmentHit`](SolidSegmentHit.md)[]
+
+***
+
+### split()
+
+
+
+**split**(`cutter`: `Solid`): readonly \[`Solid`, `Solid`\]
+
+
+
+Splits into [inside the cutter, outside the cutter]; the cutter itself is not returned.
+Either result may be empty or contain multiple disconnected components.
+
+#### Parameters
+
+<a id="cutter"></a>
+
+**`cutter`** · `Solid` · Required
+
+
+
+#### Returns
+
+readonly \[`Solid`, `Solid`\]
+
+***
+
+### splitByPlane()
+
+
+
+**splitByPlane**(`plane`: [`PlaneOptions`](PlaneOptions.md)): readonly \[`Solid`, `Solid`\]
+
+
+
+Splits into [positive-normal side, negative side] with closed cut faces.
+The nonzero normal is normalized; offset is its signed distance from the origin in millimetres.
+Offset defaults to zero. Either result may be empty.
+
+#### Parameters
+
+<a id="plane"></a>
+
+**`plane`** · [`PlaneOptions`](PlaneOptions.md) · Required
+
+
+
+#### Returns
+
+readonly \[`Solid`, `Solid`\]
+
 
 ## Related APIs
 
 - [Anchor3](Anchor3.md)
 - [AttachOptions](AttachOptions.md)
 - [Pivot3Options](Pivot3Options.md)
+- [PlaneOptions](PlaneOptions.md)
 - [Section](Section.md)
+- [SolidInspection](SolidInspection.md)
+- [SolidSegmentHit](SolidSegmentHit.md)
 - [Transform3Input](Transform3Input.md)
 - [TriangleMesh](TriangleMesh.md)
 - [Vector3Input](Vector3Input.md)
@@ -394,4 +631,4 @@ Takes a filled horizontal slice at Z millimetres.
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -16,27 +16,15 @@ Whether this native solid contains no material.
 
 ***
 
-### max
+### bounds
 
 
 
-`readonly` **max**: [`Vector3Data`](Vector3Data.md)
+`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
 
 
 
-Inclusive maximum coordinates in millimetres.
-
-***
-
-### min
-
-
-
-`readonly` **min**: [`Vector3Data`](Vector3Data.md)
-
-
-
-Inclusive minimum coordinates in millimetres.
+Immutable axis-aligned XYZ bounds in millimetres.
 
 ***
 
@@ -89,10 +77,10 @@ Effective native geometric tolerance in millimetres.
 
 ## Related APIs
 
-- [Vector3Data](Vector3Data.md)
+- [Bounds3Data](Bounds3Data.md)
 
 ## Guides
 
 - [Solid inspection](../../guides/recipes.md#solid-inspection)
 
-Package: `@metamesh/modeling@0.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -55,4 +55,8 @@ Outward unit surface normal at the intersection.
 
 - [Vector3Data](Vector3Data.md)
 
-Package: `@metamesh/modeling@0.16.0`.
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -17,4 +17,4 @@ Exactly one radius or diameter, placement, and tessellation for an origin-center
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -0,0 +1,80 @@
+# SquareThreadProfileSpec
+
+Square profile with equal crest and root widths.
+
+## Extends
+
+- [`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md)
+
+## Properties
+
+### kind
+
+
+
+`readonly` **kind**: `"square"`
+
+
+
+Selects the square profile family.
+
+***
+
+### depth?
+
+
+
+`readonly` `optional` **depth?**: `number`
+
+
+
+Radial depth in millimetres.
+
+#### Default Value
+
+`pitch / 2`
+
+***
+
+### pitch
+
+
+
+`readonly` **pitch**: `number`
+
+
+
+Adjacent axial thread spacing in millimetres.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`pitch`](ThreadProfileBaseSpec.md#pitch)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
+
+
+
+Optional numerical tolerance overrides.
+
+#### Inherited from
+
+[`ThreadProfileBaseSpec`](ThreadProfileBaseSpec.md).[`tolerance`](ThreadProfileBaseSpec.md#tolerance)
+
+
+## Related APIs
+
+- [GeometryToleranceOptions](GeometryToleranceOptions.md)
+- [ThreadProfileBaseSpec](ThreadProfileBaseSpec.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+- [Preflight guarantees and host settings](../../guides/concepts.md#check-preflight-guarantees)
+
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -0,0 +1,81 @@
+# StarContourOptions
+
+Alternating vertex radii and exact point count for a centered XY star.
+
+## Extended by
+
+- [`StarOptions`](StarOptions.md)
+
+## Properties
+
+### outerRadius
+
+
+
+`readonly` **outerRadius**: `number`
+
+
+
+Positive outer vertex radius in millimetres.
+
+***
+
+### innerRadius
+
+
+
+`readonly` **innerRadius**: `number`
+
+
+
+Positive inner vertex radius in millimetres, smaller than the outer radius.
+
+***
+
+### points
+
+
+
+`readonly` **points**: `number`
+
+
+
+Integer outer point count, at least three; output contains twice as many vertices.
+
+***
+
+### rotation?
+
+
+
+`readonly` `optional` **rotation?**: `number`
+
+
+
+Counterclockwise rotation in degrees; defaults to zero with an outer vertex on +X.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings, bounded by the host policy during modeling.
+
+
+## Related APIs
+
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [StarOptions](StarOptions.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.18.0`.

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

@@ -4,6 +4,7 @@ Alternating outer and inner vertices, centered on the XY origin.
 
 ## Extends
 
+- [`StarContourOptions`](StarContourOptions.md)
 - [`PrimitiveAttachment`](PrimitiveAttachment.md)
 
 ## Properties
@@ -24,18 +25,6 @@ Applied after local construction; Section attachment must preserve the XY plane.
 
 ***
 
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
-
-
-
-Explicit sampling ceilings, bounded by the host policy.
-
-***
-
 ### outerRadius
 
 
@@ -46,6 +35,10 @@ Explicit sampling ceilings, bounded by the host policy.
 
 Positive outer vertex radius in millimetres.
 
+#### Inherited from
+
+[`StarContourOptions`](StarContourOptions.md).[`outerRadius`](StarContourOptions.md#outerradius)
+
 ***
 
 ### innerRadius
@@ -56,7 +49,11 @@ Positive outer vertex radius in millimetres.
 
 
 
-Positive inner vertex radius, smaller than the outer radius.
+Positive inner vertex radius in millimetres, smaller than the outer radius.
+
+#### Inherited from
+
+[`StarContourOptions`](StarContourOptions.md).[`innerRadius`](StarContourOptions.md#innerradius)
 
 ***
 
@@ -68,7 +65,11 @@ Positive inner vertex radius, smaller than the outer radius.
 
 
 
-Integer outer point count from three through 50000.
+Integer outer point count, at least three; output contains twice as many vertices.
+
+#### Inherited from
+
+[`StarContourOptions`](StarContourOptions.md).[`points`](StarContourOptions.md#points)
 
 ***
 
@@ -80,7 +81,27 @@ Integer outer point count from three through 50000.
 
 
 
-Initial counterclockwise rotation in degrees; defaults to zero.
+Counterclockwise rotation in degrees; defaults to zero with an outer vertex on +X.
+
+#### Inherited from
+
+[`StarContourOptions`](StarContourOptions.md).[`rotation`](StarContourOptions.md#rotation)
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings, bounded by the host policy during modeling.
+
+#### Inherited from
+
+[`StarContourOptions`](StarContourOptions.md).[`limits`](StarContourOptions.md#limits)
 
 
 ## Related APIs
@@ -88,6 +109,7 @@ Initial counterclockwise rotation in degrees; defaults to zero.
 - [GeometrySamplingLimits](GeometrySamplingLimits.md)
 - [PrimitiveAttachment](PrimitiveAttachment.md)
 - [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
+- [StarContourOptions](StarContourOptions.md)
 
 ## Guides
 
@@ -95,4 +117,4 @@ Initial counterclockwise rotation in degrees; defaults to zero.
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -13,4 +13,4 @@ End-cap treatment for an open stroked path.
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -13,4 +13,4 @@ Join treatment where adjacent stroked path segments meet.
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -88,4 +88,4 @@ Positive total stroke width in millimetres, centered on the sampled path.
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -13,4 +13,4 @@ Placement of painted SVG geometry after SVG Y-axis inversion.
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -75,4 +75,4 @@ Positive uniform factor converting SVG user units to millimetres; defaults to on
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.

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

@@ -4,6 +4,18 @@ Bounded SVG document sampling. Center origin uses the final painted bounds.
 
 ## Properties
 
+### fit?
+
+
+
+`readonly` `optional` **fit?**: [`Bounds2Input`](Bounds2Input.md)
+
+
+
+Fit painted bounds uniformly inside positioned XY millimetre bounds; adaptive resolution applies at the fitted size.
+
+***
+
 ### limits?
 
 
@@ -53,6 +65,7 @@ Place the painted bounds around the origin or preserve document coordinates.
 
 ## Related APIs
 
+- [Bounds2Input](Bounds2Input.md)
 - [GeometryResolution](GeometryResolution.md)
 - [GeometrySamplingLimits](GeometrySamplingLimits.md)
 - [SvgOrigin](SvgOrigin.md)
@@ -63,4 +76,4 @@ Place the painted bounds around the origin or preserve document coordinates.
 - [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.16.0`.
+Package: `@metamesh/modeling@0.18.0`.