@metamesh/modeling 0.17.0 → 0.18.0

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

@@ -1,44 +0,0 @@
-# immutableMesh
-
-Copies mesh buffers into immutable data; geometric validation still occurs when modeling or finalizing.
-
-**immutableMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md)): [`ImmutableTriangleMesh`](ImmutableTriangleMesh.md)
-
-
-
-## Example
-
-```ts
-import { generate, immutableMesh } from "@metamesh/modeling";
-import { heightfieldMesh } from "@metamesh/modeling/geometry";
-const model = generate(({ computed, part }) => {
-  const surface = computed("surface", () => immutableMesh(heightfieldMesh({
-    size: [10, 10], segments: [8, 8], height: () => 2,
-  })));
-  return [part("surface", surface)];
-});
-```
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-
-
-## Returns
-
-[`ImmutableTriangleMesh`](ImmutableTriangleMesh.md)
-
-
-## Related APIs
-
-- [ImmutableTriangleMesh](ImmutableTriangleMesh.md)
-- [TriangleMesh](TriangleMesh.md)
-
-## Guides
-
-- [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,38 +0,0 @@
-# inspectSection
-
-Copies lightweight section measurements.
-
-**inspectSection**(`section`: [`Section`](Section.md)): [`SectionInspection`](SectionInspection.md)
-
-
-
-## Example: Check filled area
-
-```ts
-const facts = inspectSection(rectangle({ size: [20, 10] }));
-facts.area; // 200 mm²
-```
-
-## Parameters
-
-<a id="section"></a>
-
-**`section`** · [`Section`](Section.md) · Required
-
-
-
-## Returns
-
-[`SectionInspection`](SectionInspection.md)
-
-
-## Related APIs
-
-- [Section](Section.md)
-- [SectionInspection](SectionInspection.md)
-
-## Guides
-
-- [Solid inspection](../../guides/recipes.md#solid-inspection)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,38 +0,0 @@
-# inspectSolid
-
-Reads immutable native facts once per solid; temporary components are owned by the build.
-
-**inspectSolid**(`solid`: [`Solid`](Solid.md)): [`SolidInspection`](SolidInspection.md)
-
-
-
-## Example: Check dimensions and volume
-
-```ts
-const facts = inspectSolid(box({ size: [30, 20, 6] }));
-facts.volume; // 3600 mm³
-```
-
-## Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-## Returns
-
-[`SolidInspection`](SolidInspection.md)
-
-
-## Related APIs
-
-- [Solid](Solid.md)
-- [SolidInspection](SolidInspection.md)
-
-## Guides
-
-- [Solid inspection](../../guides/recipes.md#solid-inspection)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,39 +0,0 @@
-# isEmpty
-
-Checks whether a solid or filled section contains no geometry during host execution.
-
-**isEmpty**(`shape`: [`Solid`](Solid.md) \| [`Section`](Section.md)): `boolean`
-
-
-
-## Example: Check a missed intersection
-
-```ts
-const body = box({ size: 10 });
-const distant = box({ size: 10 }).translate([30, 0, 0]);
-const empty = intersect([body, distant]);
-const missed = isEmpty(empty); // true
-```
-
-Accepts a 3D Solid or 2D Section handle, not a finalized model or raw triangle mesh.
-Useful after a Boolean operation whose inputs may not overlap; no mesh is extracted.
-
-## Parameters
-
-<a id="shape"></a>
-
-**`shape`** · [`Solid`](Solid.md) \| [`Section`](Section.md) · Required
-
-
-
-## Returns
-
-`boolean`
-
-
-## Related APIs
-
-- [Section](Section.md)
-- [Solid](Solid.md)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,54 +0,0 @@
-# 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.17.0`.

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

@@ -1,66 +0,0 @@
-# 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.17.0`.

package/dist/geometry/profiles/profiles.js

@@ -1,71 +0,0 @@
-import { resolveCircularSampling } from "../circular-sampling.js";
-import { GeometryError } from "../errors.js";
-import { requireFiniteProfileValues, requireProfileVertexCount } from "./validation.js";
-export { rectangleContour } from "./rectangle.js";
-/**
- * Creates an immutable centered CCW circle with +X seam and vertex or face radial sizing.
- *
- * @example Explicit circular point data
- * ```ts
- * circleContour({ diameter: 20, segments: 32 });
- * ```
- */
-export const circleContour = (options) => {
-    const operation = "circleContour";
-    const { segments, vertexRadius } = resolveCircularSampling(options);
-    requireProfileVertexCount(segments, 3, operation, options.limits);
-    return Object.freeze(Array.from({ length: segments }, (_, index) => {
-        const angle = (Math.PI * 2 * index) / segments;
-        return Object.freeze([vertexRadius * Math.cos(angle), vertexRadius * Math.sin(angle)]);
-    }));
-};
-/**
- * Creates a centered CCW point loop with vertex or face radial sizing and an implicit seam.
- *
- * @example Hexagon sized to its faces
- * ```ts
- * regularPolygonContour({ radius: 10, sides: 6, sizing: "face" });
- * ```
- */
-export const regularPolygonContour = (options) => {
-    const operation = "regularPolygonContour";
-    const { radius, sides, rotation = 0, sizing = "vertex" } = options;
-    requireFiniteProfileValues([radius, rotation], operation);
-    if (!(radius > 0)) {
-        throw new GeometryError("INVALID_ARGUMENT", "Polygon radius must be positive.", { operation });
-    }
-    requireProfileVertexCount(sides, 3, operation, options.limits);
-    if (sizing !== "vertex" && sizing !== "face")
-        throw new GeometryError("INVALID_ARGUMENT", "Polygon sizing must be vertex or face.", {
-            operation,
-        });
-    const sampledRadius = sizing === "face" ? radius / Math.cos(Math.PI / sides) : radius;
-    requireFiniteProfileValues([sampledRadius], operation);
-    const rotationRadians = ((rotation % 360) * Math.PI) / 180;
-    return Array.from({ length: sides }, (_, index) => {
-        const angle = rotationRadians + (Math.PI * 2 * index) / sides;
-        return [sampledRadius * Math.cos(angle), sampledRadius * Math.sin(angle)];
-    });
-};
-/**
- * Creates a centered CCW alternating-radius star within the selected profile sampling ceiling.
- *
- * @example Five-point outline
- * ```ts
- * starContour(12, 5, 6);
- * ```
- */
-export const starContour = (outerRadius, points, innerRadius = outerRadius / 2, limits = {}) => {
-    const operation = "starContour";
-    requireFiniteProfileValues([outerRadius, innerRadius], operation);
-    if (!(outerRadius > 0) || !(innerRadius > 0) || innerRadius >= outerRadius) {
-        throw new GeometryError("INVALID_ARGUMENT", "Star radii must be positive, with the inner radius smaller than the outer.", { operation });
-    }
-    requireProfileVertexCount(points, 3, operation, limits);
-    requireProfileVertexCount(points * 2, 6, operation, limits);
-    return Array.from({ length: points * 2 }, (_, index) => {
-        const radius = index % 2 === 0 ? outerRadius : innerRadius;
-        const angle = (Math.PI * index) / points;
-        return [radius * Math.cos(angle), radius * Math.sin(angle)];
-    });
-};