@metamesh/modeling 0.13.0 → 0.14.0

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

@@ -135,4 +135,4 @@ Outer radius in millimetres; greater than [TubeOptions.innerRadius](#innerradius
 - [PrimitivePlacement](PrimitivePlacement.md)
 - [PrimitivePlacementOptions](PrimitivePlacementOptions.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/Vector2-type.md

@@ -0,0 +1,269 @@
+# Vector2
+
+Immutable XY arithmetic; vector operations return new values and measurements return numbers.
+
+## Properties
+
+### x
+
+
+
+`readonly` **x**: `number`
+
+
+
+X coordinate in the vector's coordinate units.
+
+***
+
+### y
+
+
+
+`readonly` **y**: `number`
+
+
+
+Y coordinate in the vector's coordinate units.
+
+## Methods
+
+### add()
+
+
+
+**add**(`other`: [`Vector2Input`](Vector2Input.md)): `Vector2`
+
+
+
+Adds another vector component-wise.
+
+#### Parameters
+
+<a id="other"></a>
+
+**`other`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`Vector2`
+
+***
+
+### subtract()
+
+
+
+**subtract**(`other`: [`Vector2Input`](Vector2Input.md)): `Vector2`
+
+
+
+Subtracts another vector component-wise.
+
+#### Parameters
+
+<a id="other-1"></a>
+
+**`other`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`Vector2`
+
+***
+
+### scale()
+
+
+
+**scale**(`factor`: `number`): `Vector2`
+
+
+
+Multiplies by a finite dimensionless scalar.
+
+#### Parameters
+
+<a id="factor"></a>
+
+**`factor`** · `number` · Required
+
+
+
+#### Returns
+
+`Vector2`
+
+***
+
+### normalize()
+
+
+
+**normalize**(`epsilon?`: `number`): `Vector2`
+
+
+
+Returns a unit vector; rejects length at or below finite nonnegative `epsilon` (default `1e-12`).
+
+#### Parameters
+
+<a id="epsilon"></a>
+
+**`epsilon`** · `number` · Optional
+
+
+
+#### Returns
+
+`Vector2`
+
+***
+
+### lerp()
+
+
+
+**lerp**(`other`: [`Vector2Input`](Vector2Input.md), `t`: `number`): `Vector2`
+
+
+
+Interpolates toward another vector by finite dimensionless `t`; extrapolation is allowed.
+
+#### Parameters
+
+<a id="other-2"></a>
+
+**`other`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+<a id="t"></a>
+
+**`t`** · `number` · Required
+
+
+
+#### Returns
+
+`Vector2`
+
+***
+
+### dot()
+
+
+
+**dot**(`other`: [`Vector2Input`](Vector2Input.md)): `number`
+
+
+
+Returns the scalar dot product.
+
+#### Parameters
+
+<a id="other-3"></a>
+
+**`other`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`number`
+
+***
+
+### cross()
+
+
+
+**cross**(`other`: [`Vector2Input`](Vector2Input.md)): `number`
+
+
+
+Returns the signed scalar cross product; positive means the other vector is counterclockwise.
+
+#### Parameters
+
+<a id="other-4"></a>
+
+**`other`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`number`
+
+***
+
+### length()
+
+
+
+**length**(): `number`
+
+
+
+Returns Euclidean length in the vector's coordinate units.
+
+#### Returns
+
+`number`
+
+***
+
+### distance()
+
+
+
+**distance**(`other`: [`Vector2Input`](Vector2Input.md)): `number`
+
+
+
+Returns Euclidean distance to another vector in the same coordinate units.
+
+#### Parameters
+
+<a id="other-5"></a>
+
+**`other`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`number`
+
+***
+
+### toArray()
+
+
+
+**toArray**(): [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Returns this value's frozen readonly tuple for interchange; repeated calls do not allocate.
+
+#### Returns
+
+[`Vector2Tuple`](Vector2Tuple.md)
+
+
+## Related APIs
+
+- [Vector2Input](Vector2Input.md)
+- [Vector2Tuple](Vector2Tuple.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,19 @@
+# Vector2Input
+
+An XY tuple or immutable fluent vector accepted by vector operations.
+
+**Vector2Input** = [`Vector2Tuple`](Vector2Tuple.md) \| [`Vector2`](Vector2-type.md)
+
+
+
+
+## Related APIs
+
+- [Vector2](Vector2-type.md)
+- [Vector2Tuple](Vector2Tuple.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,14 @@
+# Vector2Tuple
+
+A two-dimensional Cartesian vector or point.
+
+**Vector2Tuple** = readonly \[`x`: `number`, `y`: `number`\]
+
+
+
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

package/dist/docs/reference/geometry/Vector3-type.md

@@ -0,0 +1,281 @@
+# Vector3
+
+Immutable XYZ arithmetic; vector operations return new values and measurements return numbers.
+
+## Properties
+
+### x
+
+
+
+`readonly` **x**: `number`
+
+
+
+X coordinate in the vector's coordinate units.
+
+***
+
+### y
+
+
+
+`readonly` **y**: `number`
+
+
+
+Y coordinate in the vector's coordinate units.
+
+***
+
+### z
+
+
+
+`readonly` **z**: `number`
+
+
+
+Z coordinate in the vector's coordinate units.
+
+## Methods
+
+### add()
+
+
+
+**add**(`other`: [`Vector3Input`](Vector3Input.md)): `Vector3`
+
+
+
+Adds another vector component-wise.
+
+#### Parameters
+
+<a id="other"></a>
+
+**`other`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+`Vector3`
+
+***
+
+### subtract()
+
+
+
+**subtract**(`other`: [`Vector3Input`](Vector3Input.md)): `Vector3`
+
+
+
+Subtracts another vector component-wise.
+
+#### Parameters
+
+<a id="other-1"></a>
+
+**`other`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+`Vector3`
+
+***
+
+### scale()
+
+
+
+**scale**(`factor`: `number`): `Vector3`
+
+
+
+Multiplies by a finite dimensionless scalar.
+
+#### Parameters
+
+<a id="factor"></a>
+
+**`factor`** · `number` · Required
+
+
+
+#### Returns
+
+`Vector3`
+
+***
+
+### normalize()
+
+
+
+**normalize**(`epsilon?`: `number`): `Vector3`
+
+
+
+Returns a unit vector; rejects length at or below finite nonnegative `epsilon` (default `1e-12`).
+
+#### Parameters
+
+<a id="epsilon"></a>
+
+**`epsilon`** · `number` · Optional
+
+
+
+#### Returns
+
+`Vector3`
+
+***
+
+### lerp()
+
+
+
+**lerp**(`other`: [`Vector3Input`](Vector3Input.md), `t`: `number`): `Vector3`
+
+
+
+Interpolates toward another vector by finite dimensionless `t`; extrapolation is allowed.
+
+#### Parameters
+
+<a id="other-2"></a>
+
+**`other`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+<a id="t"></a>
+
+**`t`** · `number` · Required
+
+
+
+#### Returns
+
+`Vector3`
+
+***
+
+### dot()
+
+
+
+**dot**(`other`: [`Vector3Input`](Vector3Input.md)): `number`
+
+
+
+Returns the scalar dot product.
+
+#### Parameters
+
+<a id="other-3"></a>
+
+**`other`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+`number`
+
+***
+
+### cross()
+
+
+
+**cross**(`other`: [`Vector3Input`](Vector3Input.md)): `Vector3`
+
+
+
+Returns the right-handed cross product as a new vector.
+
+#### Parameters
+
+<a id="other-4"></a>
+
+**`other`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+`Vector3`
+
+***
+
+### length()
+
+
+
+**length**(): `number`
+
+
+
+Returns Euclidean length in the vector's coordinate units.
+
+#### Returns
+
+`number`
+
+***
+
+### distance()
+
+
+
+**distance**(`other`: [`Vector3Input`](Vector3Input.md)): `number`
+
+
+
+Returns Euclidean distance to another vector in the same coordinate units.
+
+#### Parameters
+
+<a id="other-5"></a>
+
+**`other`** · [`Vector3Input`](Vector3Input.md) · Required
+
+
+
+#### Returns
+
+`number`
+
+***
+
+### toArray()
+
+
+
+**toArray**(): [`Vector3Tuple`](Vector3Tuple.md)
+
+
+
+Returns this value's frozen readonly tuple for interchange; repeated calls do not allocate.
+
+#### Returns
+
+[`Vector3Tuple`](Vector3Tuple.md)
+
+
+## Related APIs
+
+- [Vector3Input](Vector3Input.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,19 @@
+# Vector3Input
+
+An XYZ tuple or immutable fluent vector accepted by vector operations.
+
+**Vector3Input** = [`Vector3Tuple`](Vector3Tuple.md) \| [`Vector3`](Vector3-type.md)
+
+
+
+
+## Related APIs
+
+- [Vector3](Vector3-type.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,14 @@
+# Vector3Tuple
+
+A three-dimensional Cartesian vector or point.
+
+**Vector3Tuple** = readonly \[`x`: `number`, `y`: `number`, `z`: `number`\]
+
+
+
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -50,4 +50,4 @@ Alignment datum in degrees counterclockwise from +X; defaults to 90.
 
 Reading direction around the circle; defaults to clockwise.
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -36,4 +36,4 @@ Exact measurements of these paths and their logical text layout.
 - [FittedTextLayout](FittedTextLayout.md)
 - [VectorTextMetrics](VectorTextMetrics.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -108,4 +108,4 @@ Tracking between glyph clusters in millimetres, -100–100; defaults to zero.
 - [VectorTextArcBaseline](VectorTextArcBaseline.md)
 - [VectorTextOptions](VectorTextOptions.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -91,4 +91,4 @@ Number of lines, including empty and trailing lines; empty text occupies one lin
 
 - [Bounds2](Bounds2.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -47,4 +47,4 @@ Tracking between glyph clusters in millimetres, -100–100; defaults to zero.
 
 - [VectorTextLayoutOptions](VectorTextLayoutOptions.md)
 
-Package: `@metamesh/modeling@0.13.0`.
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,36 @@
+# add2
+
+Adds two finite XY vectors component-wise.
+
+`const` **add2**: (`a`: [`Vector2Tuple`](Vector2Tuple.md), `b`: [`Vector2Tuple`](Vector2Tuple.md)) => [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+## Parameters
+
+<a id="a"></a>
+
+**`a`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+
+
+
+<a id="b"></a>
+
+**`b`** · [`Vector2Tuple`](Vector2Tuple.md) · Required
+
+
+
+## Returns
+
+[`Vector2Tuple`](Vector2Tuple.md)
+
+
+## Related APIs
+
+- [Vector2Tuple](Vector2Tuple.md)
+
+## Guides
+
+- [Reusable transforms and vector math](../../guides/concepts.md#reuse-a-transform-across-shapes-and-coordinates)
+
+Package: `@metamesh/modeling@0.14.0`.