@metamesh/modeling 0.11.0 → 0.13.0

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

@@ -0,0 +1,74 @@
+# revolve
+
+Revolves explicit corresponding radial/Z contours around +Z, with caps for partial sweeps. Filled Sections use `section.revolve(options)`.
+
+**revolve**(`shape`: [`CorrespondingProfile`](CorrespondingProfile.md), `options?`: [`RevolveOptions`](RevolveOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Revolve
+
+```ts
+import { matchProfiles, revolve } from "@metamesh/modeling";
+import { rectangleProfile } from "@metamesh/modeling/geometry";
+
+// Contour coordinates are [radius, Z].
+const [profile] = matchProfiles([rectangleProfile({ size: [4, 16], center: false })]);
+revolve(profile!, { revolveDegrees: 270 });
+```
+
+## Parameters
+
+<a id="shape"></a>
+
+**`shape`** · [`CorrespondingProfile`](CorrespondingProfile.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`RevolveOptions`](RevolveOptions.md) · Optional
+
+- [`segments`](RevolveOptions.md#segments) · `number` · Optional
+
+  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.
+
+- [`resolution`](RevolveOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+- [`revolveDegrees`](RevolveOptions.md#revolvedegrees) · `number` · Optional
+
+  Positive angular sweep no greater than 360 degrees; partial revolutions have end caps.
+  Segment counts describe a complete circle and scale to this angular span. Native filled
+  revolutions require at least three sweep intervals: adaptive sampling refines to that floor,
+  while exact counts that imply fewer intervals reject. Pure revolveMesh supports one interval.
+
+- [`limits`](RevolveOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling allocation ceilings.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [RevolveOptions](RevolveOptions.md)
+- [Solid](Solid.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/solidFromMesh.md

@@ -0,0 +1,42 @@
+# solidFromMesh
+
+Imports a bounded closed indexed mesh.
+
+**solidFromMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md) \| [`ImmutableTriangleMesh`](ImmutableTriangleMesh.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Mesh import
+
+```ts
+import { solidFromMesh } from "@metamesh/modeling";
+import { extrudeMesh, rectangleContour } from "@metamesh/modeling/geometry";
+
+const mesh = extrudeMesh(rectangleContour({ size: [20, 12] }), { height: 6 });
+solidFromMesh(mesh);
+```
+
+## Parameters
+
+<a id="mesh"></a>
+
+**`mesh`** · [`TriangleMesh`](TriangleMesh.md) \| [`ImmutableTriangleMesh`](ImmutableTriangleMesh.md) · Required
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [ImmutableTriangleMesh](ImmutableTriangleMesh.md)
+- [Solid](Solid.md)
+- [TriangleMesh](TriangleMesh.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,42 @@
+# sphere
+
+Origin-centered sphere.
+
+**sphere**(`options`: [`SphereOptions`](SphereOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Sphere
+
+
+
+```ts
+sphere({ diameter: 20 });
+```
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`SphereOptions`](SphereOptions.md) · Required
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [SphereOptions](SphereOptions.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/split.md

@@ -0,0 +1,54 @@
+# split
+
+Splits a solid into [inside the cutter, outside the cutter].
+
+**split**(`solid`: [`Solid`](Solid.md), `cutter`: [`Solid`](Solid.md)): readonly \[[`Solid`](Solid.md), [`Solid`](Solid.md)\]
+
+
+
+## Example: Keep the plug and the surrounding body
+
+
+
+```ts
+const body = box({ size: [30, 20, 8] });
+const cutter = cylinder({ height: 10, diameter: 8 });
+const [plug, remainder] = split(body, cutter);
+// Move the plug beside the body to show both results.
+union([plug.translate([0, -20, 0]), remainder]);
+```
+
+
+
+The first result is the intersection; the second is the subtraction. The cutter itself
+is not returned. Either result may be empty or contain multiple disconnected components.
+
+## Parameters
+
+<a id="solid"></a>
+
+**`solid`** · [`Solid`](Solid.md) · Required
+
+
+
+<a id="cutter"></a>
+
+**`cutter`** · [`Solid`](Solid.md) · Required
+
+
+
+## Returns
+
+readonly \[[`Solid`](Solid.md), [`Solid`](Solid.md)\]
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+
+## Guides
+
+- [Choose the Boolean by the material you want](../../guides/fundamentals.md#choose-the-boolean-by-the-material-you-want)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,66 @@
+# splitByPlane
+
+Splits a solid into [positive-normal side, negative side] at a world-space plane.
+
+**splitByPlane**(`solid`: [`Solid`](Solid.md), `plane`: [`PlaneOptions`](PlaneOptions.md)): readonly \[[`Solid`](Solid.md), [`Solid`](Solid.md)\]
+
+
+
+## Example: Separate two halves at X = 0
+
+
+
+```ts
+const body = box({ size: [30, 20, 8] });
+const [right, left] = splitByPlane(body, { normal: [1, 0, 0] });
+// The gap is only for display; the cut itself removes no material.
+union([right.translate([4, 0, 0]), left.translate([-4, 0, 0])]);
+```
+
+
+
+## Example: Keep only the positive half
+
+
+
+```ts
+const [right] = splitByPlane(box({ size: [30, 20, 8] }), { normal: [1, 0, 0] });
+right;
+```
+
+
+
+The nonzero normal is normalized; offset is the signed distance from the origin in
+millimetres, defaulting to zero. Both cut faces are closed. Select either tuple result
+to retain one side; either result may be empty.
+
+## Parameters
+
+<a id="solid"></a>
+
+**`solid`** · [`Solid`](Solid.md) · Required
+
+
+
+<a id="plane"></a>
+
+**`plane`** · [`PlaneOptions`](PlaneOptions.md) · Required
+
+
+
+## Returns
+
+readonly \[[`Solid`](Solid.md), [`Solid`](Solid.md)\]
+
+
+## Related APIs
+
+- [PlaneOptions](PlaneOptions.md)
+- [Solid](Solid.md)
+
+## Guides
+
+- [Choose the Boolean by the material you want](../../guides/fundamentals.md#choose-the-boolean-by-the-material-you-want)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

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

@@ -0,0 +1,63 @@
+# star
+
+Alternating outer/inner star vertices.
+
+**star**(`options`: [`StarOptions`](StarOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Five-point section
+
+```ts
+star({ outerRadius: 12, innerRadius: 6, points: 5 });
+```
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`StarOptions`](StarOptions.md) · Required
+
+- [`outerRadius`](StarOptions.md#outerradius) · `number` · Required
+
+  Positive outer vertex radius in millimetres.
+
+- [`innerRadius`](StarOptions.md#innerradius) · `number` · Required
+
+  Positive inner vertex radius, smaller than the outer radius.
+
+- [`points`](StarOptions.md#points) · `number` · Required
+
+  Integer outer point count from three through 50000.
+
+- [`placement`](StarOptions.md#placement) · [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md) · Optional
+
+  Applied after local construction; Section placement must preserve the XY plane.
+
+- [`limits`](StarOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings, bounded by the host policy.
+
+- [`rotationDegrees`](StarOptions.md#rotationdegrees) · `number` · Optional
+
+  Initial counterclockwise rotation in degrees; defaults to zero.
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.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.13.0`.

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

@@ -0,0 +1,65 @@
+# svgPathSection
+
+Imports bounded filled SVG path data.
+
+**svgPathSection**(`path`: `string`, `options?`: [`SvgPathSectionOptions`](SvgPathSectionOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Fill an SVG path in millimetres
+
+```ts
+svgPathSection("M0 0H20V12H0Z", { origin: "center", scale: 1 });
+```
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · `string` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SvgPathSectionOptions`](SvgPathSectionOptions.md) · Optional
+
+- [`limits`](SvgPathSectionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the configured engine policy.
+
+- [`fillRule`](SvgPathSectionOptions.md#fillrule) · `"nonzero"` \| `"evenodd"` · Optional
+
+  Nonzero or even-odd filled-contour rule; defaults to nonzero.
+
+- [`resolution`](SvgPathSectionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+- [`origin`](SvgPathSectionOptions.md#origin) · [`SvgOrigin`](SvgOrigin.md) · Optional
+
+  Center the painted bounds or preserve original path coordinates.
+
+- [`scale`](SvgPathSectionOptions.md#scale) · `number` · Optional
+
+  Positive uniform factor converting SVG user units to millimetres; defaults to one.
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [SvgPathSectionOptions](SvgPathSectionOptions.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/svgSection.md

@@ -0,0 +1,64 @@
+# svgSection
+
+Imports bounded painted SVG document geometry.
+
+**svgSection**(`svg`: `string`, `options?`: [`SvgSectionOptions`](SvgSectionOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Import a physical SVG rectangle
+
+```ts
+svgSection(
+  '<svg xmlns="http://www.w3.org/2000/svg" width="30mm" height="20mm" viewBox="0 0 30 20"><rect width="30" height="20"/></svg>',
+  { origin: "center" },
+);
+```
+
+## Parameters
+
+<a id="svg"></a>
+
+**`svg`** · `string` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SvgSectionOptions`](SvgSectionOptions.md) · Optional
+
+- [`limits`](SvgSectionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the configured engine policy.
+
+- [`circularSegments`](SvgSectionOptions.md#circularsegments) · `number` · Optional
+
+  Exact circular tessellation count overriding physical sampling.
+
+- [`resolution`](SvgSectionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+- [`origin`](SvgSectionOptions.md#origin) · [`SvgOrigin`](SvgOrigin.md) · Optional
+
+  Place the painted bounds around the origin or preserve document coordinates.
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [SvgSectionOptions](SvgSectionOptions.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/sweep.md

@@ -0,0 +1,92 @@
+# sweep
+
+Sweeps explicit corresponding contours using the selected frame policy. Filled Sections use `section.sweep(path, options)`.
+
+**sweep**(`shape`: [`CorrespondingProfile`](CorrespondingProfile.md), `path`: readonly [`Vector3`](Vector3.md)[], `options?`: [`SweepOptions`](SweepOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Sweep
+
+```ts
+import { matchProfiles, sweep } from "@metamesh/modeling";
+import { rectangleProfile } from "@metamesh/modeling/geometry";
+
+const [profile] = matchProfiles([rectangleProfile({ size: [6, 3] })]);
+sweep(profile!, [[0, 0, 0], [0, 0, 15], [10, 0, 25]], {
+  orientation: { kind: "transport", initialNormal: [0, 1, 0] },
+});
+```
+
+## Parameters
+
+<a id="shape"></a>
+
+**`shape`** · [`CorrespondingProfile`](CorrespondingProfile.md) · Required
+
+
+
+<a id="path"></a>
+
+**`path`** · readonly [`Vector3`](Vector3.md)[] · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SweepOptions`](SweepOptions.md) · Optional
+
+- [`closed`](SweepOptions.md#closed) · `boolean` · Optional
+
+  Join the path's last station to its first. Open paths retain watertight end caps.
+
+- [`limits`](SweepOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling allocation ceilings.
+
+- [`orientation`](SweepOptions.md#orientation) · [`SweepOrientation`](SweepOrientation.md) · Optional
+
+  Explicit frame policy; default transport minimizes rotations, initially projecting +X then +Y then +Z.
+
+- [`resolution`](SweepOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Physical sampling of nonzero twist; inserted stations retain authored station controls.
+
+- [`twistDegrees`](SweepOptions.md#twistdegrees) · `number` · Optional
+
+  Total additional profile rotation in degrees, with progression selected by twistBy.
+
+- [`twistBy`](SweepOptions.md#twistby) · `"length"` \| `"stations"` · Optional
+
+  Twist advances by physical path length (default), or normalized authored station position, including a closed seam gap.
+
+- [`scale`](SweepOptions.md#scale) · `number` \| [`Vector2`](Vector2.md) \| readonly [`Vector2`](Vector2.md)[] · Optional
+
+  Positive uniform/XY scale, or one XY pair per path station. Defaults to one.
+
+- [`seamProfileOffset`](SweepOptions.md#seamprofileoffset) · `number` · Optional
+
+  Corresponding point-index advance at a rotationally equivalent closed seam.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [Solid](Solid.md)
+- [SweepOptions](SweepOptions.md)
+- [Vector3](Vector3.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/textSection.md

@@ -0,0 +1,57 @@
+# textSection
+
+Consumes a previously prepared layout; never shapes or fetches a font.
+
+**textSection**(`layout`: [`VectorTextLayout`](VectorTextLayout.md), `options?`: [`TextSectionOptions`](TextSectionOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Use a prepared text layout
+
+```ts
+// Prepare the exact font and layout before entering build.
+function labelSection(layout: VectorTextLayout) {
+  return textSection(layout);
+}
+```
+
+## Parameters
+
+<a id="layout"></a>
+
+**`layout`** · [`VectorTextLayout`](VectorTextLayout.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`TextSectionOptions`](TextSectionOptions.md) · Optional
+
+- [`limits`](TextSectionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the configured engine policy.
+
+- [`resolution`](TextSectionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [TextSectionOptions](TextSectionOptions.md)
+- [VectorTextLayout](VectorTextLayout.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/threadRidge.md

@@ -0,0 +1,72 @@
+# threadRidge
+
+Helical ridge mesh construction.
+
+**threadRidge**(`options`: [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md) · Required
+
+- [`length`](HelicalThreadRidgeMeshOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`majorDiameter`](HelicalThreadRidgeMeshOptions.md#majordiameter) · `number` · Required
+
+  Nominal major diameter before any caller-owned fit compensation.
+
+- [`profile`](HelicalThreadRidgeMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`ends`](HelicalThreadRidgeMeshOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](HelicalThreadRidgeMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](HelicalThreadRidgeMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](HelicalThreadRidgeMeshOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](HelicalThreadRidgeMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](HelicalThreadRidgeMeshOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](HelicalThreadRidgeMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [HelicalThreadRidgeMeshOptions](HelicalThreadRidgeMeshOptions.md)
+- [Solid](Solid.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.13.0`.