@metamesh/modeling 0.17.0 → 0.19.0

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

@@ -13,29 +13,17 @@ 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]);
 ```
 
-## Properties
-
-### \[solidBrand\]
-
-
-
-`readonly` **\[solidBrand\]**: `"Solid"`
-
-
-
-Compile-time identity brand for an immutable solid recipe.
-
 ## Methods
 
 ### translate()
 
 
 
-**translate**(`offset`: [`Vector3Input`](Vector3Input.md)): `Solid`
+**translate**(`offset`: [`Vector3Input`](../geometry/Vector3Input.md)): `Solid`
 
 
 
@@ -45,7 +33,7 @@ Translates XYZ coordinates in millimetres.
 
 <a id="offset"></a>
 
-**`offset`** · [`Vector3Input`](Vector3Input.md) · Required
+**`offset`** · [`Vector3Input`](../geometry/Vector3Input.md) · Required
 
 
 
@@ -59,7 +47,7 @@ Translates XYZ coordinates in millimetres.
 
 
 
-**rotate**(`degrees`: [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Solid`
+**rotate**(`degrees`: [`Vector3Input`](../geometry/Vector3Input.md), `options?`: [`Pivot3Options`](../geometry/Pivot3Options.md)): `Solid`
 
 
 
@@ -70,15 +58,15 @@ Rotates about global X, then Y, then Z in degrees.
 
 <a id="degrees"></a>
 
-**`degrees`** · [`Vector3Input`](Vector3Input.md) · Required
+**`degrees`** · [`Vector3Input`](../geometry/Vector3Input.md) · Required
 
 
 
 <a id="options"></a>
 
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
+**`options`** · [`Pivot3Options`](../geometry/Pivot3Options.md) · Optional
 
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
+- [`pivot`](../geometry/Pivot3Options.md#pivot) · [`Vector3Input`](../geometry/Vector3Input.md) · Optional
 
   World-space point left fixed by rotation or scaling.
 
@@ -94,7 +82,7 @@ Rotates about global X, then Y, then Z in degrees.
 
 
 
-**scale**(`factors`: `number` \| [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Solid`
+**scale**(`factors`: `number` \| [`Vector3Input`](../geometry/Vector3Input.md), `options?`: [`Pivot3Options`](../geometry/Pivot3Options.md)): `Solid`
 
 
 
@@ -105,15 +93,15 @@ Uniform or per-axis nonsingular scaling; negative factors reflect geometry.
 
 <a id="factors"></a>
 
-**`factors`** · `number` \| [`Vector3Input`](Vector3Input.md) · Required
+**`factors`** · `number` \| [`Vector3Input`](../geometry/Vector3Input.md) · Required
 
 
 
 <a id="options-1"></a>
 
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
+**`options`** · [`Pivot3Options`](../geometry/Pivot3Options.md) · Optional
 
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
+- [`pivot`](../geometry/Pivot3Options.md#pivot) · [`Vector3Input`](../geometry/Vector3Input.md) · Optional
 
   World-space point left fixed by rotation or scaling.
 
@@ -129,7 +117,7 @@ Uniform or per-axis nonsingular scaling; negative factors reflect geometry.
 
 
 
-**mirror**(`normal`: [`Vector3Input`](Vector3Input.md)): `Solid`
+**mirror**(`normal`: [`Vector3Input`](../geometry/Vector3Input.md)): `Solid`
 
 
 
@@ -139,7 +127,7 @@ Reflection across an origin line/plane.
 
 <a id="normal"></a>
 
-**`normal`** · [`Vector3Input`](Vector3Input.md) · Required
+**`normal`** · [`Vector3Input`](../geometry/Vector3Input.md) · Required
 
 
 
@@ -153,7 +141,7 @@ Reflection across an origin line/plane.
 
 
 
-**transform**(`placement`: [`Transform3Input`](Transform3Input.md)): `Solid`
+**transform**(`placement`: [`Transform3Input`](../geometry/Transform3Input.md)): `Solid`
 
 
 
@@ -163,7 +151,7 @@ Applies a reusable XYZ placement or canonical row-major matrix.
 
 <a id="placement"></a>
 
-**`placement`** · [`Transform3Input`](Transform3Input.md) · Required
+**`placement`** · [`Transform3Input`](../geometry/Transform3Input.md) · Required
 
 
 
@@ -173,19 +161,120 @@ Applies a reusable XYZ placement or canonical row-major matrix.
 
 ***
 
-### toTriangleMesh()
+### toMesh()
 
 
 
-**toTriangleMesh**(): [`TriangleMesh`](TriangleMesh.md)
+**toMesh**(): [`TriangleMesh`](../geometry/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
 
-[`TriangleMesh`](TriangleMesh.md)
+[`TriangleMesh`](../geometry/TriangleMesh.md)
+
+***
+
+### 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`
+
+***
+
+### join()
+
+
+
+**join**(`feature`: `Solid`, `options`: [`JoinOptions`](JoinOptions.md)): `Solid`
+
+
+
+Fuses an already positioned feature with a smooth (default) or straight width/height transition.
+The source datum belongs to the feature; neither input moves or loses material.
+Requires a verified local straight collar and continuous sampled support patch.
+The result has no inherited anchors. This is not a rolling-ball fillet.
+
+#### Parameters
+
+<a id="feature"></a>
+
+**`feature`** · `Solid` · Required
+
+
+
+<a id="options-2"></a>
+
+**`options`** · [`JoinOptions`](JoinOptions.md) · Required
+
+- [`source`](JoinOptions.md#source) · `string` \| [`Anchor3`](../geometry/Anchor3-type.md) · Required
+
+  Outward feature-root datum, pointing toward the base. Names resolve lazily on the feature;
+  explicit anchors use the operands' shared modeling coordinates. The collar grows opposite
+  this direction, with its roll fixed by the anchor's up vector. Every collar section cut
+  by the source plane participates, including disconnected roots.
+
+- [`transition`](JoinOptions.md#transition) · [`JoinTransition`](JoinTransition.md) · Required
+
+  Both dimensions must be positive, or both zero to validate contact and fuse without a blend.
+
+- [`resolution`](JoinOptions.md#resolution) · [`GeometryResolution`](../geometry/GeometryResolution.md) · Optional
+
+  Physical connection sampling. Input solids retain their own captured sampling.
+
+- [`limits`](JoinOptions.md#limits) · `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the evaluating host's limits.
+
+
+
+#### 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`
 
 ***
 
@@ -193,17 +282,18 @@ Copies manufacturing mesh buffers for interchange; requires an active model exec
 
 
 
-**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
 
 
 
@@ -244,7 +334,7 @@ and the solid's existing native tolerance. Choose it from the detail you can aff
 
 
 
-**withAnchors**(`anchors`: `Readonly`\<`Record`\<`string`, [`Anchor3`](Anchor3.md)\>\>): `Solid`
+**withAnchors**(`anchors`: `Readonly`\<`Record`\<`string`, [`Anchor3`](../geometry/Anchor3-type.md)\>\>): `Solid`
 
 
 
@@ -254,7 +344,7 @@ Returns a new recipe with copied named anchors; existing names may be replaced.
 
 <a id="anchors"></a>
 
-**`anchors`** · `Readonly`\<`Record`\<`string`, [`Anchor3`](Anchor3.md)\>\> · Required
+**`anchors`** · `Readonly`\<`Record`\<`string`, [`Anchor3`](../geometry/Anchor3-type.md)\>\> · Required
 
 
 
@@ -268,7 +358,7 @@ Returns a new recipe with copied named anchors; existing names may be replaced.
 
 
 
-**attach**(`source`: `string` \| [`Anchor3`](Anchor3.md), `target`: [`Anchor3`](Anchor3.md), `options?`: [`AttachOptions`](AttachOptions.md)): `Solid`
+**attach**(`source`: `string` \| [`Anchor3`](../geometry/Anchor3-type.md), `target`: [`Anchor3`](../geometry/Anchor3-type.md), `options?`: [`AttachOptions`](../geometry/AttachOptions.md)): `Solid`
 
 
 
@@ -278,33 +368,33 @@ Places an explicit or named source anchor against an explicit target anchor.
 
 <a id="source"></a>
 
-**`source`** · `string` \| [`Anchor3`](Anchor3.md) · Required
+**`source`** · `string` \| [`Anchor3`](../geometry/Anchor3-type.md) · Required
 
 
 
 <a id="target"></a>
 
-**`target`** · [`Anchor3`](Anchor3.md) · Required
+**`target`** · [`Anchor3`](../geometry/Anchor3-type.md) · Required
 
 
 
-<a id="options-2"></a>
+<a id="options-3"></a>
 
-**`options`** · [`AttachOptions`](AttachOptions.md) · Optional
+**`options`** · [`AttachOptions`](../geometry/AttachOptions.md) · Optional
 
-- [`alignment`](AttachOptions.md#alignment) · `"opposed"` \| `"same"` · Optional
+- [`alignment`](../geometry/AttachOptions.md#alignment) · `"opposed"` \| `"same"` · Optional
 
   Align outward directions face-to-face (`opposed`) or in parallel (`same`).
 
-- [`gap`](AttachOptions.md#gap) · `number` · Optional
+- [`gap`](../geometry/AttachOptions.md#gap) · `number` · Optional
 
   Separation along the target anchor's outward direction in model units.
 
-- [`spin`](AttachOptions.md#spin) · `number` · Optional
+- [`spin`](../geometry/AttachOptions.md#spin) · `number` · Optional
 
   Additional right-handed roll about the attached direction, in degrees.
 
-- [`tolerance`](AttachOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+- [`tolerance`](../geometry/AttachOptions.md#tolerance) · [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md) · Optional
 
   Optional numeric comparison overrides.
 
@@ -378,20 +468,215 @@ 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`](../geometry/Anchor3-type.md)
+
+
+
+Reads a copied immutable named anchor during active synchronous model execution.
+
+#### Parameters
+
+<a id="name"></a>
+
+**`name`** · `string` · Required
+
+
+
+#### Returns
+
+[`Anchor3`](../geometry/Anchor3-type.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`](../geometry/Vector3Input.md), `endpoint`: [`Vector3Input`](../geometry/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`](../geometry/Vector3Input.md) · Required
+
+
+
+<a id="endpoint"></a>
+
+**`endpoint`** · [`Vector3Input`](../geometry/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)
+- [Anchor3](../geometry/Anchor3-type.md)
+- [AttachOptions](../geometry/AttachOptions.md)
+- [JoinOptions](JoinOptions.md)
+- [Pivot3Options](../geometry/Pivot3Options.md)
+- [PlaneOptions](PlaneOptions.md)
 - [Section](Section.md)
-- [Transform3Input](Transform3Input.md)
-- [TriangleMesh](TriangleMesh.md)
-- [Vector3Input](Vector3Input.md)
+- [SolidInspection](SolidInspection.md)
+- [SolidSegmentHit](SolidSegmentHit.md)
+- [Transform3Input](../geometry/Transform3Input.md)
+- [TriangleMesh](../geometry/TriangleMesh.md)
+- [Vector3Input](../geometry/Vector3Input.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)
+- [Choose a primitive](../../guides/profiles-and-extrusion.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/profiles-and-extrusion.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+
+## Supported imports
+
+```ts
+import type { Solid } from "@metamesh/modeling";
+```
 
-Package: `@metamesh/modeling@0.17.0`.
+Package: `@metamesh/modeling@0.19.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`](../geometry/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,16 @@ Effective native geometric tolerance in millimetres.
 
 ## Related APIs
 
-- [Vector3Data](Vector3Data.md)
+- [Bounds3Data](../geometry/Bounds3Data.md)
 
 ## Guides
 
-- [Solid inspection](../../guides/recipes.md#solid-inspection)
+- [Solid inspection](../../guides/resolution-and-inspection.md#solid-inspection)
+
+## Supported imports
+
+```ts
+import type { SolidInspection } from "@metamesh/modeling";
+```
 
-Package: `@metamesh/modeling@0.17.0`.
+Package: `@metamesh/modeling@0.19.0`.

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

@@ -32,7 +32,7 @@ Distance from the segment origin in millimetres.
 
 
 
-`readonly` **position**: [`Vector3Data`](Vector3Data.md)
+`readonly` **position**: [`Vector3Data`](../geometry/Vector3Data.md)
 
 
 
@@ -44,7 +44,7 @@ Intersection position in millimetres.
 
 
 
-`readonly` **normal**: [`Vector3Data`](Vector3Data.md)
+`readonly` **normal**: [`Vector3Data`](../geometry/Vector3Data.md)
 
 
 
@@ -53,6 +53,16 @@ Outward unit surface normal at the intersection.
 
 ## Related APIs
 
-- [Vector3Data](Vector3Data.md)
+- [Vector3Data](../geometry/Vector3Data.md)
 
-Package: `@metamesh/modeling@0.17.0`.
+## Guides
+
+- [Solid inspection](../../guides/resolution-and-inspection.md#solid-inspection)
+
+## Supported imports
+
+```ts
+import type { SolidSegmentHit } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.19.0`.