toosoon-utils 4.2.2 → 4.3.0

package/lib/extras/geometry/Vector2.d.ts

@@ -19,6 +19,7 @@ export default class Vector2 implements Vector<Vec2> {
      * Y-axis value of this vector
      */
     y: number;
+    [Symbol.iterator](): Iterator<number>;
     /**
      * @param {number} [x=0] X-axis value
      * @param {number} [y=0] Y-axis value
@@ -35,7 +36,7 @@ export default class Vector2 implements Vector<Vec2> {
     /**
      * Set a given scalar value to all values of this vector
      *
-     * @param {number} scalar Value to set for all vector values
+     * @param {number} scalar Value to set for all values
      * @returns {this}
      */
     setScalar(scalar: number): this;
@@ -193,19 +194,26 @@ export default class Vector2 implements Vector<Vec2> {
      */
     rotateAround(center: Vec2, angle: number): this;
     /**
-     * Interpolate this vector values between a given vector and this vector
+     * Linearly interpolate this vector values towards a given vector values
      *
-     * @param {Vector2|Point2} vector Vector to interpolate values towards
      * @param {number} t Normalized time value to interpolate
+     * @param {Vector2|Point2} vector Vector to interpolate values towards
      * @returns {this}
      */
-    lerp([x, y]: Vec2, t: number): this;
+    lerp(t: number, [x, y]: Vec2): this;
     /**
      * Convert this vector to a unit vector
      *
      * @returns {this}
      */
     normalize(): this;
+    /**
+     * Transform this vector by a given matrix
+     *
+     * @param {DOMMatrix} matrix Matrix to apply
+     * @returns {this}
+     */
+    applyMatrix(matrix: DOMMatrix): this;
     /**
      * Set this vector values to the same direction but with a given length
      *
@@ -304,7 +312,7 @@ export default class Vector2 implements Vector<Vec2> {
      * Set this vector values from a given array
      *
      * @param {number[]} values Values to set
-     * @returns
+     * @returns {this}
      */
     fromArray([x, y]: number[]): this;
     /**
@@ -328,6 +336,16 @@ export default class Vector2 implements Vector<Vec2> {
      * @returns {Vector2}
      */
     clone(): Vector2;
+    /**
+     * X-axis value of this vector
+     */
+    set width(width: number);
+    get width(): number;
+    /**
+     * Y-axis value of this vector
+     */
+    set height(height: number);
+    get height(): number;
     /**
      * Add two vectors
      *
@@ -370,7 +388,7 @@ export default class Vector2 implements Vector<Vec2> {
      */
     static rotate([vx, vy]: Vec2, [cx, cy]: Vec2, angle: number): Point2;
     /**
-     * Interpolate a point between two vectors
+     * Linearly interpolate a point between two vectors
      *
      * @param {number} t Normalized time value to interpolate
      * @param {Vector2|Point2} min Minimum boundaries
@@ -471,10 +489,5 @@ export default class Vector2 implements Vector<Vec2> {
      * @returns {Point2}
      */
     static fromCircularCoords(angle: number, radius?: number): Point2;
-    set width(width: number);
-    get width(): number;
-    set height(height: number);
-    get height(): number;
-    [Symbol.iterator](): Iterator<number>;
 }
 export {};

package/lib/extras/geometry/Vector2.js

@@ -18,6 +18,10 @@ export default class Vector2 {
      * Y-axis value of this vector
      */
     y;
+    *[Symbol.iterator]() {
+        yield this.x;
+        yield this.y;
+    }
     /**
      * @param {number} [x=0] X-axis value
      * @param {number} [y=0] Y-axis value
@@ -41,7 +45,7 @@ export default class Vector2 {
     /**
      * Set a given scalar value to all values of this vector
      *
-     * @param {number} scalar Value to set for all vector values
+     * @param {number} scalar Value to set for all values
      * @returns {this}
      */
     setScalar(scalar) {
@@ -306,13 +310,13 @@ export default class Vector2 {
         return this.set(...Vector2.rotate(this, center, angle));
     }
     /**
-     * Interpolate this vector values between a given vector and this vector
+     * Linearly interpolate this vector values towards a given vector values
      *
-     * @param {Vector2|Point2} vector Vector to interpolate values towards
      * @param {number} t Normalized time value to interpolate
+     * @param {Vector2|Point2} vector Vector to interpolate values towards
      * @returns {this}
      */
-    lerp([x, y], t) {
+    lerp(t, [x, y]) {
         this.x += (x - this.x) * t;
         this.y += (y - this.y) * t;
         return this;
@@ -325,6 +329,18 @@ export default class Vector2 {
     normalize() {
         return this.divideScalar(this.length() || 1);
     }
+    /**
+     * Transform this vector by a given matrix
+     *
+     * @param {DOMMatrix} matrix Matrix to apply
+     * @returns {this}
+     */
+    applyMatrix(matrix) {
+        const { x, y } = matrix.transformPoint({ x: this.x, y: this.y });
+        this.x = x;
+        this.y = y;
+        return this;
+    }
     /**
      * Set this vector values to the same direction but with a given length
      *
@@ -455,7 +471,7 @@ export default class Vector2 {
      * Set this vector values from a given array
      *
      * @param {number[]} values Values to set
-     * @returns
+     * @returns {this}
      */
     fromArray([x, y]) {
         this.x = x;
@@ -491,6 +507,24 @@ export default class Vector2 {
     clone() {
         return new Vector2(this.x, this.y);
     }
+    /**
+     * X-axis value of this vector
+     */
+    set width(width) {
+        this.x = width;
+    }
+    get width() {
+        return this.x;
+    }
+    /**
+     * Y-axis value of this vector
+     */
+    set height(height) {
+        this.y = height;
+    }
+    get height() {
+        return this.y;
+    }
     /**
      * Add two vectors
      *
@@ -557,7 +591,7 @@ export default class Vector2 {
         return [x, y];
     }
     /**
-     * Interpolate a point between two vectors
+     * Linearly interpolate a point between two vectors
      *
      * @param {number} t Normalized time value to interpolate
      * @param {Vector2|Point2} min Minimum boundaries
@@ -627,7 +661,7 @@ export default class Vector2 {
      * @returns {number} Computed Euclidean distance
      */
     static distance(vector1, vector2) {
-        return Math.sqrt(Vector2.squaredDistance(vector1, vector2));
+        return Math.sqrt(this.squaredDistance(vector1, vector2));
     }
     /**
      * Calculate the squared distance between two vectors
@@ -690,20 +724,4 @@ export default class Vector2 {
         const y = radius * Math.sin(angle);
         return [x, y];
     }
-    set width(width) {
-        this.x = width;
-    }
-    get width() {
-        return this.x;
-    }
-    set height(height) {
-        this.y = height;
-    }
-    get height() {
-        return this.y;
-    }
-    *[Symbol.iterator]() {
-        yield this.x;
-        yield this.y;
-    }
 }

package/lib/extras/geometry/Vector3.d.ts

@@ -23,6 +23,7 @@ export default class Vector3 implements Vector<Vec3> {
      * Z-axis value of this vector
      */
     z: number;
+    [Symbol.iterator](): Iterator<number>;
     /**
      * @param {number} [x=0] X-axis value
      * @param {number} [y=0] Y-axis value
@@ -198,19 +199,26 @@ export default class Vector3 implements Vector<Vec3> {
      */
     negate(): this;
     /**
-     * Interpolate this vector values between a given vector and this vector
+     * Linearly interpolate this vector values towards a given vector values
      *
-     * @param {Vector3|Point3} vector Vector to interpolate values towards
      * @param {number} t Normalized time value to interpolate
+     * @param {Vector3|Point3} vector Vector to interpolate values towards
      * @returns {this}
      */
-    lerp([x, y, z]: Vec3, t: number): this;
+    lerp(t: number, [x, y, z]: Vec3): this;
     /**
      * Convert this vector to a unit vector
      *
      * @returns {this}
      */
     normalize(): this;
+    /**
+     * Transform this vector by a given matrix
+     *
+     * @param {DOMMatrix} matrix Matrix to apply
+     * @returns {this}
+     */
+    applyMatrix(matrix: DOMMatrix): this;
     /**
      * Set this vector values to the same direction but with a given length
      *
@@ -377,7 +385,7 @@ export default class Vector3 implements Vector<Vec3> {
      */
     static divide([x1, y1, z1]: Vec3, [x2, y2, z2]: Vec3): Point3;
     /**
-     * Interpolate a point between two vectors
+     * Linearly interpolate a point between two vectors
      *
      * @param {number} t Normalized time value to interpolate
      * @param {Vector3|Point3} min Minimum boundaries
@@ -481,6 +489,5 @@ export default class Vector3 implements Vector<Vec3> {
      * @returns {Point3}
      */
     static fromCylindricalCoords(theta: number, y: number, radius?: number): Point3;
-    [Symbol.iterator](): Iterator<number>;
 }
 export {};

package/lib/extras/geometry/Vector3.js

@@ -22,6 +22,11 @@ export default class Vector3 {
      * Z-axis value of this vector
      */
     z;
+    *[Symbol.iterator]() {
+        yield this.x;
+        yield this.y;
+        yield this.z;
+    }
     /**
      * @param {number} [x=0] X-axis value
      * @param {number} [y=0] Y-axis value
@@ -339,13 +344,13 @@ export default class Vector3 {
         return this;
     }
     /**
-     * Interpolate this vector values between a given vector and this vector
+     * Linearly interpolate this vector values towards a given vector values
      *
-     * @param {Vector3|Point3} vector Vector to interpolate values towards
      * @param {number} t Normalized time value to interpolate
+     * @param {Vector3|Point3} vector Vector to interpolate values towards
      * @returns {this}
      */
-    lerp([x, y, z], t) {
+    lerp(t, [x, y, z]) {
         this.x += (x - this.x) * t;
         this.y += (y - this.y) * t;
         this.z += (z - this.z) * t;
@@ -359,6 +364,19 @@ export default class Vector3 {
     normalize() {
         return this.divideScalar(this.length() || 1);
     }
+    /**
+     * Transform this vector by a given matrix
+     *
+     * @param {DOMMatrix} matrix Matrix to apply
+     * @returns {this}
+     */
+    applyMatrix(matrix) {
+        const { x, y, z } = matrix.transformPoint({ x: this.x, y: this.y, z: this.z });
+        this.x = x;
+        this.y = y;
+        this.z = z;
+        return this;
+    }
     /**
      * Set this vector values to the same direction but with a given length
      *
@@ -605,7 +623,7 @@ export default class Vector3 {
         return [x, y, z];
     }
     /**
-     * Interpolate a point between two vectors
+     * Linearly interpolate a point between two vectors
      *
      * @param {number} t Normalized time value to interpolate
      * @param {Vector3|Point3} min Minimum boundaries
@@ -678,7 +696,7 @@ export default class Vector3 {
      * @returns {number} Computed Euclidean distance
      */
     static distance(vector1, vector2) {
-        return Math.sqrt(Vector3.squaredDistance(vector1, vector2));
+        return Math.sqrt(this.squaredDistance(vector1, vector2));
     }
     /**
      * Calculate the squared distance between two vectors
@@ -757,9 +775,4 @@ export default class Vector3 {
         const z = radius * Math.cos(theta);
         return [x, y, z];
     }
-    *[Symbol.iterator]() {
-        yield this.x;
-        yield this.y;
-        yield this.z;
-    }
 }

package/lib/extras/paths/Path.d.ts

@@ -7,13 +7,13 @@ import { type Vector, Vector2, Vector3 } from '../geometry';
  * @class Path
  * @extends Curve
  */
-export default class Path<V extends Vector = Vector2 | Vector3, S extends Curve<V> = Curve<V>> extends Curve<V> {
+export default class Path<V extends Vector = Vector2 | Vector3, C extends Curve<V> = Curve<V>> extends Curve<V> {
     readonly isPath = true;
     readonly type: string;
     /**
      * Array of curves composing this path
      */
-    subpaths: S[];
+    curves: C[];
     /**
      * Array of points composing this path
      */
@@ -30,7 +30,7 @@ export default class Path<V extends Vector = Vector2 | Vector3, S extends Curve<
      *
      * @param {Curve} curve Curve to add
      */
-    add(curve: S): void;
+    add(curve: C): void;
     /**
      * Interpolate a point on this path
      *

package/lib/extras/paths/Path.js

@@ -12,7 +12,7 @@ export default class Path extends Curve {
     /**
      * Array of curves composing this path
      */
-    subpaths = [];
+    curves = [];
     /**
      * Array of points composing this path
      */
@@ -31,7 +31,7 @@ export default class Path extends Curve {
      * @param {Curve} curve Curve to add
      */
     add(curve) {
-        this.subpaths.push(curve);
+        this.curves.push(curve);
     }
     /**
      * Interpolate a point on this path
@@ -46,7 +46,7 @@ export default class Path extends Curve {
         while (i < curveLengths.length) {
             if (curveLengths[i] >= d) {
                 const delta = curveLengths[i] - d;
-                const curve = this.subpaths[i];
+                const curve = this.curves[i];
                 const segmentLength = curve.getLength();
                 const u = segmentLength === 0 ? 0 : 1 - delta / segmentLength;
                 return curve.getPointAt(u);
@@ -54,7 +54,7 @@ export default class Path extends Curve {
             i++;
         }
         console.warn(`Path.getPoint()`, `No point found in curve.`, this);
-        return this.subpaths[0].getPoint(0);
+        return this.curves[0].getPoint(0);
     }
     /**
      * Compute the curve shape into an array of points
@@ -65,8 +65,8 @@ export default class Path extends Curve {
     getPoints(divisions = 40) {
         const points = [];
         let lastPoint = null;
-        for (let i = 0; i < this.subpaths.length; i++) {
-            const curve = this.subpaths[i];
+        for (let i = 0; i < this.curves.length; i++) {
+            const curve = this.curves[i];
             let resolution = divisions;
             if (curve instanceof LineCurve || curve instanceof LineCurve3) {
                 resolution = 1;
@@ -80,7 +80,7 @@ export default class Path extends Curve {
             else if (curve instanceof EllipseCurve) {
                 resolution *= 2;
             }
-            const pts = this.subpaths[i].getPoints(resolution);
+            const pts = this.curves[i].getPoints(resolution);
             for (let j = 0; j < pts.length; j++) {
                 const point = pts[j];
                 if (point?.equals(lastPoint))
@@ -127,13 +127,13 @@ export default class Path extends Curve {
      * @returns {number[]}
      */
     getCurveLengths() {
-        if (this._cacheArcLengths.length === this.subpaths.length) {
+        if (this._cacheArcLengths.length === this.curves.length) {
             return this._cacheArcLengths;
         }
         const lengths = [];
         let sums = 0;
-        for (let i = 0, j = this.subpaths.length; i < j; i++) {
-            sums += this.subpaths[i].getLength();
+        for (let i = 0, j = this.curves.length; i < j; i++) {
+            sums += this.curves[i].getLength();
             lengths.push(sums);
         }
         this._cacheArcLengths = lengths;

package/lib/extras/paths/PathContext.d.ts

@@ -10,14 +10,8 @@ import Path from './Path';
  * @implements CanvasRenderingContext2D
  */
 export default class PathContext extends Path<Vector2> implements CanvasRenderingContext2D {
-    /**
-     * Path current position
-     */
-    currentPosition: Vector2;
-    /**
-     * Path current transformation matrix
-     */
-    currentTransform: DOMMatrix;
+    protected _currentPosition: Vector2;
+    protected _currentTransform: DOMMatrix;
     private _transformStack;
     /**
      * Create a path from a given list of points
@@ -139,7 +133,7 @@ export default class PathContext extends Path<Vector2> implements CanvasRenderin
     arc(cx: number, cy: number, radius: number, startAngle: number, endAngle: number, counterclockwise?: boolean): this;
     /**
      * Draw an Arc curve from the current position, tangential to the 2 segments created by both control points
-     * Add an instance of {@link ArcCurve} to this path
+     * Add an instance of {@link EllipseCurve} to this path
      *
      * @param {number} x1 X-axis coordinate of the first control point
      * @param {number} y1 Y-axis coordinate of the first control point
@@ -185,22 +179,18 @@ export default class PathContext extends Path<Vector2> implements CanvasRenderin
     reset(): void;
     protected _hasCurrentPosition(): boolean;
     protected _setCurrentPosition(x: number, y: number): this;
-    protected _transformPoint(point: Point2, matrix?: DOMMatrix): Point2;
-    protected _transformPoints(points: Point2[], matrix?: DOMMatrix): Point2[];
-    protected _transformVector(vector: Point2, matrix?: DOMMatrix): Point2;
-    protected _transformEllipse(cx: number, cy: number, rx: number, ry: number, rotation: number, matrix?: DOMMatrix): [number, number, number, number, number];
-    protected _inversePoint(point: Point2): Point2;
+    protected _transformPoint(point: Point2): Point2;
+    protected _transformPoints(points: Point2[]): Point2[];
+    protected _transformVector(vector: Point2): Point2;
+    protected _transformEllipse(cx: number, cy: number, rx: number, ry: number, rotation: number): [number, number, number, number, number];
     protected get _translateX(): number;
     protected get _translateY(): number;
     protected get _scaleX(): number;
     protected get _scaleY(): number;
     protected get _rotation(): number;
-    protected get _skewX(): number;
-    protected get _skewY(): number;
     protected get _isTranslated(): boolean;
     protected get _isScaled(): boolean;
     protected get _isRotated(): boolean;
-    protected get _isSkewed(): boolean;
     protected get _isUniform(): boolean;
     protected get _isIdentity(): boolean;
     canvas: CanvasRenderingContext2D['canvas'];