@metamesh/modeling 0.14.0 → 0.15.0

package/dist/docs/reference/geometry/Path3.md

@@ -1,14 +0,0 @@
-# Path3
-
-An ordered, open sequence of three-dimensional points.
-
-**Path3** = readonly [`Vector3Tuple`](Vector3Tuple.md)[]
-
-
-
-
-## Related APIs
-
-- [Vector3Tuple](Vector3Tuple.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/PrimitivePlacement.md

@@ -1,31 +0,0 @@
-# PrimitivePlacement
-
-Placement shared by solid and filled-section factories.
-
-## Extended by
-
-- [`BoxOptions`](BoxOptions.md)
-- [`TorusOptions`](TorusOptions.md)
-- [`TubeOptions`](TubeOptions.md)
-
-## Properties
-
-### placement?
-
-
-
-`readonly` `optional` **placement?**: [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md)
-
-
-
-Applied after local construction; Section placement must preserve the XY plane.
-
-
-## Related APIs
-
-- [BoxOptions](BoxOptions.md)
-- [PrimitivePlacementOptions](PrimitivePlacementOptions.md)
-- [TorusOptions](TorusOptions.md)
-- [TubeOptions](TubeOptions.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/PrimitivePlacementOptions.md

@@ -1,83 +0,0 @@
-# PrimitivePlacementOptions
-
-Maps an explicit or named shape-local attachment anchor onto a world-space anchor.
-
-## Properties
-
-### source
-
-
-
-`readonly` **source**: `string` \| [`Anchor3`](Anchor3.md)
-
-
-
-Shape-local source frame or a named primitive anchor such as bottom.
-
-***
-
-### target
-
-
-
-`readonly` **target**: [`Anchor3`](Anchor3.md)
-
-
-
-World-space target frame in millimetres.
-
-***
-
-### alignment?
-
-
-
-`readonly` `optional` **alignment?**: `"opposed"` \| `"same"`
-
-
-
-Align outward directions face-to-face or in parallel. Defaults to opposed.
-
-***
-
-### gap?
-
-
-
-`readonly` `optional` **gap?**: `number`
-
-
-
-Finite separation along the target direction in millimetres. Defaults to zero.
-
-***
-
-### spinDegrees?
-
-
-
-`readonly` `optional` **spinDegrees?**: `number`
-
-
-
-Finite additional roll around the attached direction in degrees. Defaults to zero.
-
-***
-
-### tolerance?
-
-
-
-`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)
-
-
-
-Explicit numeric comparison overrides for anchor normalization.
-
-
-## Related APIs
-
-- [Anchor3](Anchor3.md)
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/StrokePathCap.md

@@ -1,7 +0,0 @@
-# StrokePathCap
-
-End-cap treatment for an open stroked path.
-
-**StrokePathCap** = `"butt"` \| `"round"` \| `"square"`
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/StrokePathJoin.md

@@ -1,7 +0,0 @@
-# StrokePathJoin
-
-Join treatment where adjacent stroked path segments meet.
-
-**StrokePathJoin** = `"bevel"` \| `"miter"` \| `"round"`
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/closestPointOnPath.md

@@ -1,110 +0,0 @@
-# closestPointOnPath
-
-Finds the closest position anywhere on an open XY path or closed contour.
-
-## Call Signature
-
-
-
-**closestPointOnPath**(`path`: [`Path2`](Path2.md), `point`: [`Vector2Tuple`](Vector2Tuple.md), `options?`: [`ClosestPointOnPathOptions`](ClosestPointOnPathOptions.md)): [`ClosestPointOnPathResult`](ClosestPointOnPathResult.md)\<[`Vector2Tuple`](Vector2Tuple.md)\>
-
-
-
-## Example: Find a point on a closed boundary
-
-```ts
-closestPointOnPath([[0, 0], [10, 0], [10, 10]], [4, -2], { closed: true });
-```
-
-Finds the closest position anywhere on an open XY path or closed contour.
-
-Open paths need two points; closed paths need three and omit the duplicated seam.
-Repeated vertices are treated as zero-length edges. Inputs and derived distances must be
-finite. Only the final result is allocated, so scanning a dense boundary creates no per-edge objects.
-This measures the sampled boundary, not its filled interior or an underlying analytic curve.
-
-### Parameters
-
-<a id="path"></a>
-
-**`path`** · [`Path2`](Path2.md) · Required
-
-
-
-<a id="point"></a>
-
-**`point`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`ClosestPointOnPathOptions`](ClosestPointOnPathOptions.md) · Optional
-
-- [`closed`](ClosestPointOnPathOptions.md#closed) · `boolean` · Optional
-
-  Include the last-to-first edge without duplicating the seam point. Defaults to false.
-
-- [`limits`](ClosestPointOnPathOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
-
-  Explicit path point ceiling; defaults to the package sampling limits.
-
-
-
-### Returns
-
-[`ClosestPointOnPathResult`](ClosestPointOnPathResult.md)\<[`Vector2Tuple`](Vector2Tuple.md)\>
-
-## Call Signature
-
-
-
-**closestPointOnPath**(`path`: [`Path3`](Path3.md), `point`: [`Vector3Tuple`](Vector3Tuple.md), `options?`: [`ClosestPointOnPathOptions`](ClosestPointOnPathOptions.md)): [`ClosestPointOnPathResult`](ClosestPointOnPathResult.md)\<[`Vector3Tuple`](Vector3Tuple.md)\>
-
-
-
-Finds the closest position on an open XYZ path or explicitly closed spatial loop.
-
-### Parameters
-
-<a id="path-1"></a>
-
-**`path`** · [`Path3`](Path3.md) · Required
-
-
-
-<a id="point-1"></a>
-
-**`point`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
-
-
-
-<a id="options-1"></a>
-
-**`options`** · [`ClosestPointOnPathOptions`](ClosestPointOnPathOptions.md) · Optional
-
-- [`closed`](ClosestPointOnPathOptions.md#closed) · `boolean` · Optional
-
-  Include the last-to-first edge without duplicating the seam point. Defaults to false.
-
-- [`limits`](ClosestPointOnPathOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
-
-  Explicit path point ceiling; defaults to the package sampling limits.
-
-
-
-### Returns
-
-[`ClosestPointOnPathResult`](ClosestPointOnPathResult.md)\<[`Vector3Tuple`](Vector3Tuple.md)\>
-
-
-## Related APIs
-
-- [ClosestPointOnPathOptions](ClosestPointOnPathOptions.md)
-- [ClosestPointOnPathResult](ClosestPointOnPathResult.md)
-- [Path2](Path2.md)
-- [Path3](Path3.md)
-- [Vector2Tuple](Vector2Tuple.md)
-- [Vector3Tuple](Vector3Tuple.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/cumulativePathLengths.md

@@ -1,33 +0,0 @@
-# cumulativePathLengths
-
-Returns cumulative arc length for finite points under maxPathPoints (default 100000); rejects overflowing length.
-
-`const` **cumulativePathLengths**: (`path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `limits?`: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>) => readonly `number`[]
-
-
-
-## Parameters
-
-<a id="path"></a>
-
-**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
-
-
-
-<a id="limits"></a>
-
-**`limits`** · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
-
-
-
-## Returns
-
-readonly `number`[]
-
-
-## Related APIs
-
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [Vector3Tuple](Vector3Tuple.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/measureTriangleMesh.md

@@ -1,55 +0,0 @@
-# measureTriangleMesh
-
-Measures bounds, surface area, and signed volume without changing the mesh.
-
-**measureTriangleMesh**(`mesh`: [`TriangleMesh`](TriangleMesh.md), `options?`: [`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md)): [`TriangleMeshMeasurements`](TriangleMeshMeasurements.md)
-
-
-
-Signed volume is meaningful for a consistently wound closed mesh. Set
-`requireClosed` when measurements will be used as manufacturing assertions.
-
-## Parameters
-
-<a id="mesh"></a>
-
-**`mesh`** · [`TriangleMesh`](TriangleMesh.md) · Required
-
-Mesh to validate and measure.
-
-
-
-<a id="options"></a>
-
-**`options`** · [`TriangleMeshValidationOptions`](TriangleMeshValidationOptions.md) · Optional
-
-Validation policy applied before measurement.
-
-- [`allowEmpty`](TriangleMeshValidationOptions.md#allowempty) · `boolean` · Optional
-
-  Permit an empty position and index buffer. Defaults to `false`.
-
-- [`requireClosed`](TriangleMeshValidationOptions.md#requireclosed) · `boolean` · Optional
-
-  Require two oppositely wound faces per edge; geometric self-intersections are not detected.
-
-- [`tolerance`](TriangleMeshValidationOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-  Numeric comparison overrides used for zero-area triangle detection.
-
-
-
-## Returns
-
-[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md)
-
-Immutable deterministic scalar and bounds measurements.
-
-
-## Related APIs
-
-- [TriangleMesh](TriangleMesh.md)
-- [TriangleMeshMeasurements](TriangleMeshMeasurements.md)
-- [TriangleMeshValidationOptions](TriangleMeshValidationOptions.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/pathLength.md

@@ -1,33 +0,0 @@
-# pathLength
-
-Returns total sampled 3D path length, or zero for an empty path.
-
-`const` **pathLength**: (`path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `limits?`: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>) => `number`
-
-
-
-## Parameters
-
-<a id="path"></a>
-
-**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
-
-
-
-<a id="limits"></a>
-
-**`limits`** · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
-
-
-
-## Returns
-
-`number`
-
-
-## Related APIs
-
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [Vector3Tuple](Vector3Tuple.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/strokePathRegion.md

@@ -1,63 +0,0 @@
-# strokePathRegion
-
-Converts a sampled millimetre path into the filled region covered by a centered stroke.
-
-**strokePathRegion**(`path`: [`Path2`](Path2.md), `options`: [`StrokePathRegionOptions`](StrokePathRegionOptions.md)): [`RegionData`](RegionData.md)
-
-
-
-Closed paths omit a duplicated seam point. Zero-length sampled segments are ignored, while the
-effective path must still contain visible length. Round caps and joins use deterministic physical
-resolution. Bevels fill the outer corner triangle; miters extend the outer edges to their
-intersection, falling back to bevels above SVG's default miter limit of 4.
-
-## Parameters
-
-<a id="path"></a>
-
-**`path`** · [`Path2`](Path2.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`StrokePathRegionOptions`](StrokePathRegionOptions.md) · Required
-
-- [`width`](StrokePathRegionOptions.md#width) · `number` · Required
-
-  Positive total stroke width in millimetres, centered on the sampled path.
-
-- [`limits`](StrokePathRegionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
-
-  Explicit path, circular and expanded-profile allocation ceilings.
-
-- [`closed`](StrokePathRegionOptions.md#closed) · `boolean` · Optional
-
-  Treat the path as a closed non-duplicated loop. Default: `false`.
-
-- [`cap`](StrokePathRegionOptions.md#cap) · [`StrokePathCap`](StrokePathCap.md) · Optional
-
-  End-cap treatment for an open path. Ignored for closed paths. Default: `butt`.
-
-- [`join`](StrokePathRegionOptions.md#join) · [`StrokePathJoin`](StrokePathJoin.md) · Optional
-
-  Corner treatment; miters exceeding SVG's default limit of 4 become bevels. Default: `miter`.
-
-- [`resolution`](StrokePathRegionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
-
-  Physical tessellation policy for round caps and joins.
-
-
-
-## Returns
-
-[`RegionData`](RegionData.md)
-
-
-## Related APIs
-
-- [Path2](Path2.md)
-- [RegionData](RegionData.md)
-- [StrokePathRegionOptions](StrokePathRegionOptions.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/transformContour.md

@@ -1,42 +0,0 @@
-# transformContour
-
-Applies a canonical affine XY transform to a closed loop and preserves its original winding.
-
-**transformContour**(`loop`: [`Contour`](Contour.md), `transform`: [`Transform2Input`](Transform2Input.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Contour`](Contour.md)
-
-
-
-Reflections reverse the point order automatically through normalization.
-
-## Parameters
-
-<a id="loop"></a>
-
-**`loop`** · [`Contour`](Contour.md) · Required
-
-
-
-<a id="transform"></a>
-
-**`transform`** · [`Transform2Input`](Transform2Input.md) · Required
-
-
-
-<a id="tolerance"></a>
-
-**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-
-
-## Returns
-
-[`Contour`](Contour.md)
-
-
-## Related APIs
-
-- [Contour](Contour.md)
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [Transform2Input](Transform2Input.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/transformPath2.md

@@ -1,40 +0,0 @@
-# transformPath2
-
-Applies a canonical affine XY transform to a 2D path without changing point order.
-
-**transformPath2**(`path`: [`Path2`](Path2.md), `transform`: [`Transform2Input`](Transform2Input.md), `tolerance?`: [`GeometryToleranceOptions`](GeometryToleranceOptions.md)): [`Path2`](Path2.md)
-
-
-
-## Parameters
-
-<a id="path"></a>
-
-**`path`** · [`Path2`](Path2.md) · Required
-
-
-
-<a id="transform"></a>
-
-**`transform`** · [`Transform2Input`](Transform2Input.md) · Required
-
-
-
-<a id="tolerance"></a>
-
-**`tolerance`** · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
-
-
-
-## Returns
-
-[`Path2`](Path2.md)
-
-
-## Related APIs
-
-- [GeometryToleranceOptions](GeometryToleranceOptions.md)
-- [Path2](Path2.md)
-- [Transform2Input](Transform2Input.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/transformPath3.md

@@ -1,33 +0,0 @@
-# transformPath3
-
-Applies an affine transform to a 3D path without mutating its points.
-
-**transformPath3**(`path`: [`Path3`](Path3.md), `placement`: [`Transform3Input`](Transform3Input.md)): [`Path3`](Path3.md)
-
-
-
-## Parameters
-
-<a id="path"></a>
-
-**`path`** · [`Path3`](Path3.md) · Required
-
-
-
-<a id="placement"></a>
-
-**`placement`** · [`Transform3Input`](Transform3Input.md) · Required
-
-
-
-## Returns
-
-[`Path3`](Path3.md)
-
-
-## Related APIs
-
-- [Path3](Path3.md)
-- [Transform3Input](Transform3Input.md)
-
-Package: `@metamesh/modeling@0.14.0`.

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

@@ -1,20 +0,0 @@
-# Path2
-
-An ordered, open sequence of two-dimensional points.
-
-**Path2** = readonly [`Vector2Tuple`](Vector2Tuple.md)[]
-
-
-
-
-## Related APIs
-
-- [Vector2Tuple](Vector2Tuple.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.14.0`.

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

@@ -1,40 +0,0 @@
-# rayCast
-
-Copies intersections along the finite directed origin-to-endpoint segment.
-
-**rayCast**(`solid`: [`Solid`](Solid.md), `origin`: [`Vector3Tuple`](Vector3Tuple.md), `endpoint`: [`Vector3Tuple`](Vector3Tuple.md)): readonly [`SolidRayHit`](SolidRayHit.md)[]
-
-
-
-## Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-<a id="origin"></a>
-
-**`origin`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
-
-
-
-<a id="endpoint"></a>
-
-**`endpoint`** · [`Vector3Tuple`](Vector3Tuple.md) · Required
-
-
-
-## Returns
-
-readonly [`SolidRayHit`](SolidRayHit.md)[]
-
-
-## Related APIs
-
-- [Solid](Solid.md)
-- [SolidRayHit](SolidRayHit.md)
-- [Vector3Tuple](Vector3Tuple.md)
-
-Package: `@metamesh/modeling@0.14.0`.

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

@@ -1,27 +0,0 @@
-# toTriangleMesh
-
-Copies a handle to manufacturing mesh buffers.
-
-**toTriangleMesh**(`solid`: [`Solid`](Solid.md)): [`TriangleMesh`](TriangleMesh.md)
-
-
-
-## Parameters
-
-<a id="solid"></a>
-
-**`solid`** · [`Solid`](Solid.md) · Required
-
-
-
-## Returns
-
-[`TriangleMesh`](TriangleMesh.md)
-
-
-## Related APIs
-
-- [Solid](Solid.md)
-- [TriangleMesh](TriangleMesh.md)
-
-Package: `@metamesh/modeling@0.14.0`.

package/dist/geometry/paths/path.js

@@ -1,32 +0,0 @@
-import { length3, subtract3 } from "../math/vector3.js";
-import { assertSamplingCount, resolveGeometrySamplingLimits, } from "../sampling-limits.js";
-/** Returns cumulative arc length for finite points under maxPathPoints (default 100000); rejects overflowing length. */
-export const cumulativePathLengths = (path, limits = {}) => {
-    assertSamplingCount(path.length, "cumulativePathLengths", resolveGeometrySamplingLimits(limits).maxPathPoints);
-    if (path.length === 0) {
-        return [];
-    }
-    for (const point of path) {
-        if (!point.every(Number.isFinite)) {
-            throw new Error("Path coordinates must be finite.");
-        }
-    }
-    const cumulative = [0];
-    for (let index = 1; index < path.length; index += 1) {
-        const previous = path[index - 1];
-        const point = path[index];
-        if (previous === undefined || point === undefined) {
-            throw new Error("Path indexing invariant failed.");
-        }
-        const distance = cumulative[index - 1] + length3(subtract3(point, previous));
-        if (!Number.isFinite(distance)) {
-            throw new Error("Path cumulative length must be finite.");
-        }
-        cumulative.push(distance);
-    }
-    return cumulative;
-};
-/**
- * Returns total sampled 3D path length, or zero for an empty path.
- */
-export const pathLength = (path, limits = {}) => cumulativePathLengths(path, limits).at(-1) ?? 0;