toosoon-utils 4.1.9 → 4.2.1

package/lib/constants.d.ts

@@ -4,7 +4,6 @@ export declare const TWO_PI: number;
 export declare const TAU: number;
 export declare const HALF_PI: number;
 export declare const QUARTER_PI: number;
-export declare const TAU_EPSILON: number;
 export declare const W3CX11: {
     aliceblue: number;
     antiquewhite: number;

package/lib/constants.js

@@ -2,12 +2,14 @@
 // Maths
 // *********************
 export const EPSILON = 1e-10;
+// *********************
+// Geometry
+// *********************
 export const PI = Math.PI;
 export const TWO_PI = PI * 2;
 export const TAU = PI * 2;
 export const HALF_PI = PI / 2;
 export const QUARTER_PI = PI / 4;
-export const TAU_EPSILON = TAU - EPSILON;
 // *********************
 // Colors
 // *********************

package/lib/extras/color-scale/ColorScale.d.ts

@@ -40,7 +40,7 @@ export default class ColorScale {
      */
     constructor(input: ColorRepresentation, target: ColorRepresentation, length?: number, settings?: ColorScaleSettings);
     /**
-     * Static method for generating a color scale
+     * Generate a color scale
      *
      * @param {ColorRepresentation} input     Input color representation
      * @param {ColorRepresentation} target    Target color representation
@@ -50,7 +50,7 @@ export default class ColorScale {
      */
     static generate(input: ColorRepresentation, target: ColorRepresentation, length: number, settings?: ColorScaleSettings): Array<[number, number, number]>;
     /**
-     * Static method for interpolating between colors
+     * Interpolate between colors
      *
      * @param {[number,number,number]} inputColor  Input color
      * @param {[number,number,number]} targetColor Target color

package/lib/extras/color-scale/ColorScale.js

@@ -24,7 +24,7 @@ export default class ColorScale {
         this.colors = ColorScale.generate(input, target, length, settings);
     }
     /**
-     * Static method for generating a color scale
+     * Generate a color scale
      *
      * @param {ColorRepresentation} input     Input color representation
      * @param {ColorRepresentation} target    Target color representation
@@ -43,7 +43,7 @@ export default class ColorScale {
         return colors;
     }
     /**
-     * Static method for interpolating between colors
+     * Interpolate between colors
      *
      * @param {[number,number,number]} inputColor  Input color
      * @param {[number,number,number]} targetColor Target color

package/lib/extras/curves/ArcCurve.d.ts

@@ -11,9 +11,9 @@ export default class ArcCurve extends EllipseCurve {
      * @param {number} cx X-axis coordinate of the center of the circle
      * @param {number} cy Y-axis coordinate of the center of the circle
      * @param {number} radius Radius of the circle
-     * @param {number} [startAngle] Rotation angle of the arc (in radians)
-     * @param {number} [endAngle]   Rotation angle of the arc (in radians)
-     * @param {boolean} [counterclockwise] Flag indicating the direction of the arc
+     * @param {number} [startAngle=0]  Start angle of the arc (in radians)
+     * @param {number} [endAngle=2*PI] End angle of the arc (in radians)
+     * @param {boolean} [counterclockwise=false] Flag indicating the direction of the arc
      */
     constructor(cx: number, cy: number, radius: number, startAngle?: number, endAngle?: number, counterclockwise?: boolean);
 }

package/lib/extras/curves/ArcCurve.js

@@ -1,3 +1,4 @@
+import { TWO_PI } from '../../constants';
 import EllipseCurve from './EllipseCurve';
 /**
  * Utility class for manipulating arcs
@@ -11,11 +12,11 @@ export default class ArcCurve extends EllipseCurve {
      * @param {number} cx X-axis coordinate of the center of the circle
      * @param {number} cy Y-axis coordinate of the center of the circle
      * @param {number} radius Radius of the circle
-     * @param {number} [startAngle] Rotation angle of the arc (in radians)
-     * @param {number} [endAngle]   Rotation angle of the arc (in radians)
-     * @param {boolean} [counterclockwise] Flag indicating the direction of the arc
+     * @param {number} [startAngle=0]  Start angle of the arc (in radians)
+     * @param {number} [endAngle=2*PI] End angle of the arc (in radians)
+     * @param {boolean} [counterclockwise=false] Flag indicating the direction of the arc
      */
-    constructor(cx, cy, radius, startAngle, endAngle, counterclockwise) {
+    constructor(cx, cy, radius, startAngle = 0, endAngle = TWO_PI, counterclockwise = false) {
         super(cx, cy, radius, radius, 0, startAngle, endAngle, counterclockwise);
     }
 }

package/lib/extras/curves/CatmullRomCurve.d.ts

@@ -1,4 +1,5 @@
-import type { Point } from '../../types';
+import type { Point2 } from '../../types';
+import { Vector2 } from '../geometry';
 import Curve from './Curve';
 /**
  * Utility class for manipulating Catmull-Rom curves
@@ -7,7 +8,7 @@ import Curve from './Curve';
  * @class CatmullRomCurve
  * @extends Curve
  */
-export default class CatmullRomCurve extends Curve {
+export default class CatmullRomCurve extends Curve<Vector2> {
     readonly type: string;
     /**
      * X-axis coordinate of the start point
@@ -53,10 +54,24 @@ export default class CatmullRomCurve extends Curve {
      */
     constructor(x1: number, y1: number, cp1x: number, cp1y: number, cp2x: number, cp2y: number, x2: number, y2: number);
     /**
-     * Interpolate a point on the Catmull-Rom curve
+     * Interpolate a point on this curve
      *
      * @param {number} t Normalized time value to interpolate
-     * @returns {Point} Interpolated coordinates on the curve
+     * @returns {Vector2} Interpolated coordinates on this curve
      */
-    getPoint(t: number): Point;
+    getPoint(t: number): Vector2;
+    /**
+     * Interpolate a point on a Catmull-Rom curve
+     *
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @returns {Point2} Interpolated coordinates on the curve
+     */
+    static interpolate(t: number, x1: number, y1: number, cp1x: number, cp1y: number, cp2x: number, cp2y: number, x2: number, y2: number): Point2;
 }

package/lib/extras/curves/CatmullRomCurve.js

@@ -1,4 +1,5 @@
-import { catmullRom } from '../../geometry';
+import { catmullRom } from '../../maths';
+import { Vector2 } from '../geometry';
 import Curve from './Curve';
 /**
  * Utility class for manipulating Catmull-Rom curves
@@ -63,13 +64,30 @@ export default class CatmullRomCurve extends Curve {
         this.y2 = y2;
     }
     /**
-     * Interpolate a point on the Catmull-Rom curve
+     * Interpolate a point on this curve
      *
      * @param {number} t Normalized time value to interpolate
-     * @returns {Point} Interpolated coordinates on the curve
+     * @returns {Vector2} Interpolated coordinates on this curve
      */
     getPoint(t) {
-        const point = catmullRom(t, this.x1, this.y1, this.cp1x, this.cp1y, this.cp2x, this.cp2y, this.x2, this.y2);
-        return point;
+        return new Vector2(...CatmullRomCurve.interpolate(t, this.x1, this.y1, this.cp1x, this.cp1y, this.cp2x, this.cp2y, this.x2, this.y2));
+    }
+    /**
+     * Interpolate a point on a Catmull-Rom curve
+     *
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @returns {Point2} Interpolated coordinates on the curve
+     */
+    static interpolate(t, x1, y1, cp1x, cp1y, cp2x, cp2y, x2, y2) {
+        const x = catmullRom(t, x1, cp1x, cp2x, x2);
+        const y = catmullRom(t, y1, cp1y, cp2y, y2);
+        return [x, y];
     }
 }

package/lib/extras/curves/CatmullRomCurve3.d.ts

@@ -0,0 +1,101 @@
+import type { Point3 } from '../../types';
+import { Vector3 } from '../geometry';
+import Curve from './Curve';
+/**
+ * Utility class for manipulating Catmull-Rom 3D curves
+ *
+ * @exports
+ * @class CatmullRomCurve3
+ * @extends Curve
+ */
+export default class CatmullRomCurve3 extends Curve<Vector3> {
+    readonly type: string;
+    /**
+     * X-axis coordinate of the start point
+     */
+    x1: number;
+    /**
+     * Y-axis coordinate of the start point
+     */
+    y1: number;
+    /**
+     * Z-axis coordinate of the start point
+     */
+    z1: number;
+    /**
+     * X-axis coordinate of the first control point
+     */
+    cp1x: number;
+    /**
+     * Y-axis coordinate of the first control point
+     */
+    cp1y: number;
+    /**
+     * Z-axis coordinate of the first control point
+     */
+    cp1z: number;
+    /**
+     * X-axis coordinate of the second control point
+     */
+    cp2x: number;
+    /**
+     * Y-axis coordinate of the second control point
+     */
+    cp2y: number;
+    /**
+     * Z-axis coordinate of the second control point
+     */
+    cp2z: number;
+    /**
+     * X-axis coordinate of the end point
+     */
+    x2: number;
+    /**
+     * Y-axis coordinate of the end point
+     */
+    y2: number;
+    /**
+     * Z-axis coordinate of the end point
+     */
+    z2: number;
+    /**
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} z1   Z-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp1z Z-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} cp2z Z-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @param {number} z2   Z-axis coordinate of the end point
+     */
+    constructor(x1: number, y1: number, z1: number, cp1x: number, cp1y: number, cp1z: number, cp2x: number, cp2y: number, cp2z: number, x2: number, y2: number, z2: number);
+    /**
+     * Interpolate a point on this curve
+     *
+     * @param {number} t Normalized time value to interpolate
+     * @returns {Vector2} Interpolated coordinates on this curve
+     */
+    getPoint(t: number): Vector3;
+    /**
+     * Interpolate a point on a Catmull-Rom curve
+     *
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} z1   Z-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp1z Z-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} cp2z Z-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @param {number} z2   Z-axis coordinate of the end point
+     * @returns {Point3} Interpolated coordinates on the curve
+     */
+    static interpolate(t: number, x1: number, y1: number, z1: number, cp1x: number, cp1y: number, cp1z: number, cp2x: number, cp2y: number, cp2z: number, x2: number, y2: number, z2: number): Point3;
+}

package/lib/extras/curves/CatmullRomCurve3.js

@@ -0,0 +1,122 @@
+import { catmullRom } from '../../maths';
+import { Vector3 } from '../geometry';
+import Curve from './Curve';
+/**
+ * Utility class for manipulating Catmull-Rom 3D curves
+ *
+ * @exports
+ * @class CatmullRomCurve3
+ * @extends Curve
+ */
+export default class CatmullRomCurve3 extends Curve {
+    type = 'CatmullRomCurve3';
+    /**
+     * X-axis coordinate of the start point
+     */
+    x1;
+    /**
+     * Y-axis coordinate of the start point
+     */
+    y1;
+    /**
+     * Z-axis coordinate of the start point
+     */
+    z1;
+    /**
+     * X-axis coordinate of the first control point
+     */
+    cp1x;
+    /**
+     * Y-axis coordinate of the first control point
+     */
+    cp1y;
+    /**
+     * Z-axis coordinate of the first control point
+     */
+    cp1z;
+    /**
+     * X-axis coordinate of the second control point
+     */
+    cp2x;
+    /**
+     * Y-axis coordinate of the second control point
+     */
+    cp2y;
+    /**
+     * Z-axis coordinate of the second control point
+     */
+    cp2z;
+    /**
+     * X-axis coordinate of the end point
+     */
+    x2;
+    /**
+     * Y-axis coordinate of the end point
+     */
+    y2;
+    /**
+     * Z-axis coordinate of the end point
+     */
+    z2;
+    /**
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} z1   Z-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp1z Z-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} cp2z Z-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @param {number} z2   Z-axis coordinate of the end point
+     */
+    constructor(x1, y1, z1, cp1x, cp1y, cp1z, cp2x, cp2y, cp2z, x2, y2, z2) {
+        super();
+        this.x1 = x1;
+        this.y1 = y1;
+        this.z1 = z1;
+        this.cp1x = cp1x;
+        this.cp1y = cp1y;
+        this.cp1z = cp1z;
+        this.cp2x = cp2x;
+        this.cp2y = cp2y;
+        this.cp2z = cp2z;
+        this.x2 = x2;
+        this.y2 = y2;
+        this.z2 = z2;
+    }
+    /**
+     * Interpolate a point on this curve
+     *
+     * @param {number} t Normalized time value to interpolate
+     * @returns {Vector2} Interpolated coordinates on this curve
+     */
+    getPoint(t) {
+        return new Vector3(...CatmullRomCurve3.interpolate(t, this.x1, this.y1, this.z1, this.cp1x, this.cp1y, this.cp1z, this.cp2x, this.cp2y, this.cp2z, this.x2, this.y2, this.z2));
+    }
+    /**
+     * Interpolate a point on a Catmull-Rom curve
+     *
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} z1   Z-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp1z Z-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} cp2z Z-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @param {number} z2   Z-axis coordinate of the end point
+     * @returns {Point3} Interpolated coordinates on the curve
+     */
+    static interpolate(t, x1, y1, z1, cp1x, cp1y, cp1z, cp2x, cp2y, cp2z, x2, y2, z2) {
+        const x = catmullRom(t, x1, cp1x, cp2x, x2);
+        const y = catmullRom(t, y1, cp1y, cp2y, y2);
+        const z = catmullRom(t, z1, cp1z, cp2z, z2);
+        return [x, y, z];
+    }
+}

package/lib/extras/curves/CubicBezierCurve.d.ts

@@ -1,4 +1,5 @@
-import type { Point } from '../../types';
+import type { Point2 } from '../../types';
+import { Vector2 } from '../geometry';
 import Curve from './Curve';
 /**
  * Utility class for manipulating Cubic Bézier curves
@@ -7,7 +8,7 @@ import Curve from './Curve';
  * @class CubicBezierCurve
  * @extends Curve
  */
-export default class CubicBezierCurve extends Curve {
+export default class CubicBezierCurve extends Curve<Vector2> {
     readonly type: string;
     /**
      * X-axis coordinate of the start point
@@ -53,10 +54,24 @@ export default class CubicBezierCurve extends Curve {
      */
     constructor(x1: number, y1: number, cp1x: number, cp1y: number, cp2x: number, cp2y: number, x2: number, y2: number);
     /**
-     * Interpolate a point on the Cubic Bézier curve
+     * Interpolate a point on this curve
      *
      * @param {number} t Normalized time value to interpolate
-     * @returns {Point} Interpolated coordinates on the curve
+     * @returns {Vector2} Interpolated coordinates on this curve
      */
-    getPoint(t: number): Point;
+    getPoint(t: number): Vector2;
+    /**
+     * Interpolate a point on a Cubic Bézier curve
+     *
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @returns {Point2} Interpolated coordinates on the curve
+     */
+    static interpolate(t: number, x1: number, y1: number, cp1x: number, cp1y: number, cp2x: number, cp2y: number, x2: number, y2: number): Point2;
 }

package/lib/extras/curves/CubicBezierCurve.js

@@ -1,4 +1,5 @@
-import { cubicBezier } from '../../geometry';
+import { cubicBezier } from '../../maths';
+import { Vector2 } from '../geometry';
 import Curve from './Curve';
 /**
  * Utility class for manipulating Cubic Bézier curves
@@ -63,13 +64,30 @@ export default class CubicBezierCurve extends Curve {
         this.y2 = y2;
     }
     /**
-     * Interpolate a point on the Cubic Bézier curve
+     * Interpolate a point on this curve
      *
      * @param {number} t Normalized time value to interpolate
-     * @returns {Point} Interpolated coordinates on the curve
+     * @returns {Vector2} Interpolated coordinates on this curve
      */
     getPoint(t) {
-        const point = cubicBezier(t, this.x1, this.y1, this.cp1x, this.cp1y, this.cp2x, this.cp2y, this.x2, this.y2);
-        return point;
+        return new Vector2(...CubicBezierCurve.interpolate(t, this.x1, this.y1, this.cp1x, this.cp1y, this.cp2x, this.cp2y, this.x2, this.y2));
+    }
+    /**
+     * Interpolate a point on a Cubic Bézier curve
+     *
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @returns {Point2} Interpolated coordinates on the curve
+     */
+    static interpolate(t, x1, y1, cp1x, cp1y, cp2x, cp2y, x2, y2) {
+        const x = cubicBezier(t, x1, cp1x, cp2x, x2);
+        const y = cubicBezier(t, y1, cp1y, cp2y, y2);
+        return [x, y];
     }
 }

package/lib/extras/curves/CubicBezierCurve3.d.ts

@@ -0,0 +1,101 @@
+import type { Point3 } from '../../types';
+import { Vector3 } from '../geometry';
+import Curve from './Curve';
+/**
+ * Utility class for manipulating Cubic Bézier 3D curves
+ *
+ * @exports
+ * @class CubicBezierCurve3
+ * @extends Curve
+ */
+export default class CubicBezierCurve3 extends Curve<Vector3> {
+    readonly type: string;
+    /**
+     * X-axis coordinate of the start point
+     */
+    x1: number;
+    /**
+     * Y-axis coordinate of the start point
+     */
+    y1: number;
+    /**
+     * Z-axis coordinate of the start point
+     */
+    z1: number;
+    /**
+     * X-axis coordinate of the first control point
+     */
+    cp1x: number;
+    /**
+     * Y-axis coordinate of the first control point
+     */
+    cp1y: number;
+    /**
+     * Z-axis coordinate of the first control point
+     */
+    cp1z: number;
+    /**
+     * X-axis coordinate of the second control point
+     */
+    cp2x: number;
+    /**
+     * Y-axis coordinate of the second control point
+     */
+    cp2y: number;
+    /**
+     * Z-axis coordinate of the second control point
+     */
+    cp2z: number;
+    /**
+     * X-axis coordinate of the end point
+     */
+    x2: number;
+    /**
+     * Y-axis coordinate of the end point
+     */
+    y2: number;
+    /**
+     * Z-axis coordinate of the end point
+     */
+    z2: number;
+    /**
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} z1   Z-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp1z Z-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} cp2z Z-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @param {number} z2   Z-axis coordinate of the end point
+     */
+    constructor(x1: number, y1: number, z1: number, cp1x: number, cp1y: number, cp1z: number, cp2x: number, cp2y: number, cp2z: number, x2: number, y2: number, z2: number);
+    /**
+     * Interpolate a point on this curve
+     *
+     * @param {number} t Normalized time value to interpolate
+     * @returns {Vector3} Interpolated coordinates on this curve
+     */
+    getPoint(t: number): Vector3;
+    /**
+     * Interpolate a point on a 3D Cubic Bézier curve
+     *
+     * @param {number} x1   X-axis coordinate of the start point
+     * @param {number} y1   Y-axis coordinate of the start point
+     * @param {number} z1   Z-axis coordinate of the start point
+     * @param {number} cp1x X-axis coordinate of the first control point
+     * @param {number} cp1y Y-axis coordinate of the first control point
+     * @param {number} cp1z Z-axis coordinate of the first control point
+     * @param {number} cp2x X-axis coordinate of the second control point
+     * @param {number} cp2y Y-axis coordinate of the second control point
+     * @param {number} cp2z Z-axis coordinate of the second control point
+     * @param {number} x2   X-axis coordinate of the end point
+     * @param {number} y2   Y-axis coordinate of the end point
+     * @param {number} z2   Z-axis coordinate of the end point
+     * @returns {Point2} Interpolated coordinates on the curve
+     */
+    static interpolate(t: number, x1: number, y1: number, z1: number, cp1x: number, cp1y: number, cp1z: number, cp2x: number, cp2y: number, cp2z: number, x2: number, y2: number, z2: number): Point3;
+}