@metamesh/modeling 0.13.0 → 0.14.0

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

@@ -0,0 +1,91 @@
+# StrokeOptions
+
+Physical stroke and topology controls shared by pure regions and native Sections.
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit path, circular and expanded-profile allocation ceilings.
+
+***
+
+### closed?
+
+
+
+`readonly` `optional` **closed?**: `boolean`
+
+
+
+Treat the path as a closed non-duplicated loop. Default: `false`.
+
+***
+
+### cap?
+
+
+
+`readonly` `optional` **cap?**: [`StrokePathCap`](StrokePathCap.md)
+
+
+
+End-cap treatment for an open path. Ignored for closed paths. Default: `butt`.
+
+***
+
+### join?
+
+
+
+`readonly` `optional` **join?**: [`StrokePathJoin`](StrokePathJoin.md)
+
+
+
+Corner treatment; miters exceeding SVG's default limit of 4 become bevels. Default: `miter`.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Physical tessellation policy for round caps and joins.
+
+***
+
+### width
+
+
+
+`readonly` **width**: `number`
+
+
+
+Positive total stroke width in millimetres, centered on the sampled path.
+
+
+## Related APIs
+
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.md)
+- [StrokePathCap](StrokePathCap.md)
+- [StrokePathJoin](StrokePathJoin.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/StrokePathCap.md

@@ -0,0 +1,16 @@
+# StrokePathCap
+
+End-cap treatment for an open stroked path.
+
+**StrokePathCap** = `"butt"` \| `"round"` \| `"square"`
+
+
+
+
+## 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/StrokePathJoin.md

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

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

@@ -63,4 +63,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.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -80,7 +80,7 @@ Twist advances by physical path length (default), or normalized authored station
 
 
 
-`readonly` `optional` **scale?**: `number` \| [`Vector2`](Vector2.md) \| readonly [`Vector2`](Vector2.md)[]
+`readonly` `optional` **scale?**: `number` \| [`Vector2Tuple`](Vector2Tuple.md) \| readonly [`Vector2Tuple`](Vector2Tuple.md)[]
 
 
 
@@ -104,7 +104,7 @@ Corresponding point-index advance at a rotationally equivalent closed seam.
 - [GeometryResolution](GeometryResolution.md)
 - [ModelingLimits](ModelingLimits.md)
 - [SweepOrientation](SweepOrientation.md)
-- [Vector2](Vector2.md)
+- [Vector2Tuple](Vector2Tuple.md)
 
 ## Guides
 
@@ -113,4 +113,4 @@ Corresponding point-index advance at a rotationally equivalent closed seam.
 - [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: `@metamesh/modeling@0.14.0`.

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

@@ -2,7 +2,7 @@
 
 Explicit profile-X frame policy; all normals are directed, and selected singular policies reject.
 
-**SweepOrientation** = \{ `kind`: `"transport"`; `initialNormal?`: [`Vector3`](Vector3.md); \} \| \{ `kind`: `"fixed-normal"`; `normal`: [`Vector3`](Vector3.md); \} \| \{ `kind`: `"guide"`; `normal`: [`PathNormalGuide`](PathNormalGuide.md); \} \| \{ `kind`: `"frenet"`; \}
+**SweepOrientation** = \{ `kind`: `"transport"`; `initialNormal?`: [`Vector3Tuple`](Vector3Tuple.md); \} \| \{ `kind`: `"fixed-normal"`; `normal`: [`Vector3Tuple`](Vector3Tuple.md); \} \| \{ `kind`: `"guide"`; `normal`: [`PathNormalGuide`](PathNormalGuide.md); \} \| \{ `kind`: `"frenet"`; \}
 
 
 
@@ -10,7 +10,7 @@ Explicit profile-X frame policy; all normals are directed, and selected singular
 
 ### Type Literal
 
-\{ `kind`: `"transport"`; `initialNormal?`: [`Vector3`](Vector3.md); \}
+\{ `kind`: `"transport"`; `initialNormal?`: [`Vector3Tuple`](Vector3Tuple.md); \}
 
 #### kind
 
@@ -26,7 +26,7 @@ Minimizes frame rotation by parallel transport.
 
 
 
-`readonly` `optional` **initialNormal?**: [`Vector3`](Vector3.md)
+`readonly` `optional` **initialNormal?**: [`Vector3Tuple`](Vector3Tuple.md)
 
 
 
@@ -36,7 +36,7 @@ Initial profile +X guide, projected perpendicular to the first tangent.
 
 ### Type Literal
 
-\{ `kind`: `"fixed-normal"`; `normal`: [`Vector3`](Vector3.md); \}
+\{ `kind`: `"fixed-normal"`; `normal`: [`Vector3Tuple`](Vector3Tuple.md); \}
 
 #### kind
 
@@ -52,7 +52,7 @@ Projects one fixed world-space normal at every path station.
 
 
 
-`readonly` **normal**: [`Vector3`](Vector3.md)
+`readonly` **normal**: [`Vector3Tuple`](Vector3Tuple.md)
 
 
 
@@ -104,7 +104,7 @@ Uses sampled curvature normals; zero-curvature stations reject.
 ## Related APIs
 
 - [PathNormalGuide](PathNormalGuide.md)
-- [Vector3](Vector3.md)
+- [Vector3Tuple](Vector3Tuple.md)
 
 ## Guides
 
@@ -113,4 +113,4 @@ Uses sampled curvature normals; zero-curvature stations reject.
 - [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: `@metamesh/modeling@0.14.0`.

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

@@ -38,4 +38,4 @@ Local physical sampling policy; exact interval counts take precedence.
 - [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: `@metamesh/modeling@0.14.0`.

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

@@ -11,4 +11,4 @@ End shape of a generated helical ridge.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -114,4 +114,4 @@ clips the periodic profile at the face, and `tapered` ramps into the minor envel
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -11,4 +11,4 @@ Direction in which a conventional helical thread advances around +Z.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -11,4 +11,4 @@ Radial envelope toward which a blunt lead-in collapses.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -11,4 +11,4 @@ BOSL2-compatible cross-section scaling curve for a blunt thread lead-in.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -56,7 +56,7 @@ Adjacent axial thread spacing in millimetres.
 
 
 
-`readonly` **points**: readonly [`Vector2`](Vector2.md)[]
+`readonly` **points**: readonly [`Vector2Tuple`](Vector2Tuple.md)[]
 
 
 
@@ -77,10 +77,10 @@ Axial width of the flat at the minor envelope.
 
 ## Related APIs
 
-- [Vector2](Vector2.md)
+- [Vector2Tuple](Vector2Tuple.md)
 
 ## Guides
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -15,4 +15,4 @@ Parameters for a helical ridge before solid construction.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -11,4 +11,4 @@ Nut-edge bevel selection.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -270,4 +270,4 @@ Across-flats width for hex/square or diameter for round, in millimetres.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -95,4 +95,4 @@ Start-aligned circular facet count used by the compensated thread cutter.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -11,4 +11,4 @@ Supported printable nut body shapes.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -242,4 +242,4 @@ Nominal major diameter before male compensation.
 
 - [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -107,4 +107,4 @@ Operation-level physical tessellation policy over the active model-wide policy.
 - [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: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/model/Transform2-type.md

@@ -0,0 +1,256 @@
+# Transform2
+
+Immutable reusable XY placement. Methods apply in written order; angles are degrees.
+
+## Methods
+
+### translate()
+
+
+
+**translate**(`offset`: [`Vector2Input`](Vector2Input.md)): `Transform2`
+
+
+
+Applies a translation in model units after this placement.
+
+#### Parameters
+
+<a id="offset"></a>
+
+**`offset`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### rotate()
+
+
+
+**rotate**(`degrees`: `number`, `options?`: [`Pivot2Options`](Pivot2Options.md)): `Transform2`
+
+
+
+Rotates counterclockwise in degrees about an optional world-space pivot (default origin).
+
+#### Parameters
+
+<a id="degrees"></a>
+
+**`degrees`** · `number` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
+
+- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### scale()
+
+
+
+**scale**(`factors`: `number` \| [`Vector2Input`](Vector2Input.md), `options?`: [`Pivot2Options`](Pivot2Options.md)): `Transform2`
+
+
+
+Scales about an optional world-space pivot; finite nonzero factors may reflect.
+
+#### Parameters
+
+<a id="factors"></a>
+
+**`factors`** · `number` \| [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
+
+- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### andThen()
+
+
+
+**andThen**(`next`: [`Transform2Input`](Transform2Input.md)): `Transform2`
+
+
+
+Applies this placement first, then `next`; neither operand is mutated.
+
+#### Parameters
+
+<a id="next"></a>
+
+**`next`** · [`Transform2Input`](Transform2Input.md) · Required
+
+
+
+#### Returns
+
+`Transform2`
+
+***
+
+### inverse()
+
+
+
+**inverse**(): `Transform2`
+
+
+
+Returns the inverse; singular and numerically unstable transforms throw GeometryError.
+
+#### Returns
+
+`Transform2`
+
+***
+
+### applyPoint()
+
+
+
+**applyPoint**(`point`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
+
+
+
+Transforms a finite point, including translation. Returns a fresh immutable vector.
+
+#### Parameters
+
+<a id="point"></a>
+
+**`point`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector2`](Vector2-type.md)
+
+***
+
+### applyDirection()
+
+
+
+**applyDirection**(`direction`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
+
+
+
+Transforms a finite direction, excluding translation and retaining scale. This is not a normal transform.
+
+#### Parameters
+
+<a id="direction"></a>
+
+**`direction`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector2`](Vector2-type.md)
+
+***
+
+### applyNormal()
+
+
+
+**applyNormal**(`normal`: [`Vector2Input`](Vector2Input.md)): [`Vector2`](Vector2-type.md)
+
+
+
+Applies the inverse transpose and normalizes. Ignores translation; rejects zero normals.
+
+#### Parameters
+
+<a id="normal"></a>
+
+**`normal`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+[`Vector2`](Vector2-type.md)
+
+***
+
+### toMatrix()
+
+
+
+**toMatrix**(): [`Transform2Matrix`](Transform2Matrix.md)
+
+
+
+Returns the frozen canonical row-major 3x3 matrix for interchange.
+
+#### Returns
+
+[`Transform2Matrix`](Transform2Matrix.md)
+
+***
+
+### to3D()
+
+
+
+**to3D**(): [`Transform3`](Transform3-type.md)
+
+
+
+Embeds this placement in XYZ, leaving Z unchanged, for solids and 3D paths.
+
+#### Returns
+
+[`Transform3`](Transform3-type.md)
+
+
+## Related APIs
+
+- [Pivot2Options](Pivot2Options.md)
+- [Transform2Input](Transform2Input.md)
+- [Transform2Matrix](Transform2Matrix.md)
+- [Transform3](Transform3-type.md)
+- [Vector2](Vector2-type.md)
+- [Vector2Input](Vector2Input.md)
+
+## Guides
+
+- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,20 @@
+# Transform2Input
+
+An immutable XY transform or its canonical row-major matrix for interchange.
+
+**Transform2Input** = [`Transform2`](Transform2-type.md) \| [`Transform2Matrix`](Transform2Matrix.md)
+
+
+
+
+## Related APIs
+
+- [Transform2](Transform2-type.md)
+- [Transform2Matrix](Transform2Matrix.md)
+
+## Guides
+
+- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,15 @@
+# Transform2Matrix
+
+A row-major affine 3x3 XY matrix applied to column vectors. Translation occupies indices 2 and 5; the final row is `[0, 0, 1]`.
+
+**Transform2Matrix** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`\]
+
+
+
+
+## Guides
+
+- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.14.0`.