@fimbul-works/vec 1.1.0 → 2.0.0

package/dist/cjs/index.d.ts

@@ -1,3 +1,7 @@
+export * from "./2d/index.js";
+export * from "./3d/index.js";
+export * from "./4d/index.js";
+export * from "./slerp.js";
 export * from "./vec2.js";
 export * from "./vec3.js";
 export * from "./vec4.js";

package/dist/cjs/index.js

@@ -14,6 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./2d/index.js"), exports);
+__exportStar(require("./3d/index.js"), exports);
+__exportStar(require("./4d/index.js"), exports);
+__exportStar(require("./slerp.js"), exports);
 __exportStar(require("./vec2.js"), exports);
 __exportStar(require("./vec3.js"), exports);
 __exportStar(require("./vec4.js"), exports);

package/dist/cjs/package.json

@@ -1 +1 @@
-{"type":"commonjs"}
+{"type":"commonjs"} pnpm build:docs

package/dist/cjs/slerp.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Documentation for spherical linear interpolation functions.
+ * @module Slerp
+ */
+/**
+ * Spherical linear interpolation for angles (in radians).
+ * Handles wrapping around 2π correctly.
+ * @param {number} from - Start angle in radians
+ * @param {number} to - End angle in radians
+ * @param {number} t - Interpolation factor (0-1)
+ * @returns {number} Interpolated angle
+ */
+export declare const slerp: (from: number, to: number, t: number) => number;
+/**
+ * Spherical linear interpolation for angles (in degrees).
+ * @param {number} from - Start angle in degrees
+ * @param {number} to - End angle in degrees
+ * @param {number} t - Interpolation factor (0-1)
+ * @returns {number} Interpolated angle
+ */
+export declare const slerpDegrees: (from: number, to: number, t: number) => number;

package/dist/cjs/slerp.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * Documentation for spherical linear interpolation functions.
+ * @module Slerp
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.slerpDegrees = exports.slerp = void 0;
+const PI2 = 2 * Math.PI;
+const PI3 = 3 * Math.PI;
+/**
+ * Spherical linear interpolation for angles (in radians).
+ * Handles wrapping around 2π correctly.
+ * @param {number} from - Start angle in radians
+ * @param {number} to - End angle in radians
+ * @param {number} t - Interpolation factor (0-1)
+ * @returns {number} Interpolated angle
+ */
+const slerp = (from, to, t) => from + (((((to - from) % PI2) + PI3) % PI2) - Math.PI) * t;
+exports.slerp = slerp;
+/**
+ * Spherical linear interpolation for angles (in degrees).
+ * @param {number} from - Start angle in degrees
+ * @param {number} to - End angle in degrees
+ * @param {number} t - Interpolation factor (0-1)
+ * @returns {number} Interpolated angle
+ */
+const slerpDegrees = (from, to, t) => from + (((((to - from) % 360) + 540) % 360) - 180) * t;
+exports.slerpDegrees = slerpDegrees;

package/dist/cjs/vec2.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Documentation for 2D Vector class.
+ * @module Vec2
+ */
 /**
  * Represents a 2D vector with various operations.
  */
@@ -5,8 +9,8 @@ export declare class Vec2 {
     #private;
     /**
      * Creates a new Vec2 instance.
-     * @param x - The x-coordinate of the vector.
-     * @param y - The y-coordinate of the vector.
+     * @param {number} x - The x-coordinate of the vector.
+     * @param {number} y - The y-coordinate of the vector.
      */
     constructor(x?: number, y?: number);
     /**
@@ -218,12 +222,14 @@ export declare class Vec2 {
     static one(): Vec2;
     /**
      * Creates a Vec2 from an array.
-     * @returns A new Vec2 instance.
+     * @param {[number, number] | number[]} arr - An array containing the x and y coordinates.
+     * @returns {Vec2} A new Vec2 instance.
      */
     static fromArray(arr: [number, number] | number[]): Vec2;
     /**
      * Creates a Vec2 from an object with x and y properties.
-     * @returns A new Vec2 instance.
+     * @param {{ x: number; y: number }} obj - An object with x and y properties.
+     * @returns {Vec2} A new Vec2 instance.
      */
     static fromObject(obj: {
         x: number;

package/dist/cjs/vec2.js

@@ -1,4 +1,8 @@
 "use strict";
+/**
+ * Documentation for 2D Vector class.
+ * @module Vec2
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Vec2 = void 0;
 const { PI, sin, cos, atan2, sqrt, abs } = Math;
@@ -13,8 +17,9 @@ class Vec2 {
     /**
      * Computes and updates the magnitude of the vector.
      * @private
-     * @param x - The x-component of the vector.
-     * @param y - The y-component of the vector.
+     * @param {number} x - The x-component of the vector.
+     * @param {number} y - The y-component of the vector.
+     * @returns {void}
      */
     #computeMagnitude(x = this.#xy[0], y = this.#xy[1]) {
         if (x !== this.#prevXY[0] || y !== this.#prevXY[1]) {
@@ -25,8 +30,8 @@ class Vec2 {
     }
     /**
      * Creates a new Vec2 instance.
-     * @param x - The x-coordinate of the vector.
-     * @param y - The y-coordinate of the vector.
+     * @param {number} x - The x-coordinate of the vector.
+     * @param {number} y - The y-coordinate of the vector.
      */
     constructor(x = 0, y = x) {
         this.#xy[0] = x;
@@ -361,14 +366,16 @@ class Vec2 {
     }
     /**
      * Creates a Vec2 from an array.
-     * @returns A new Vec2 instance.
+     * @param {[number, number] | number[]} arr - An array containing the x and y coordinates.
+     * @returns {Vec2} A new Vec2 instance.
      */
     static fromArray(arr) {
         return new Vec2(arr[0] ?? 0, arr[1] ?? 0);
     }
     /**
      * Creates a Vec2 from an object with x and y properties.
-     * @returns A new Vec2 instance.
+     * @param {{ x: number; y: number }} obj - An object with x and y properties.
+     * @returns {Vec2} A new Vec2 instance.
      */
     static fromObject(obj) {
         return new Vec2(obj.x, obj.y);

package/dist/cjs/vec3.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Documentation for 3D Vector class.
+ * @module Vec3
+ */
 /**
  * Represents a 3D vector with various operations.
  */
@@ -5,23 +9,23 @@ export declare class Vec3 {
     #private;
     /**
      * Creates a new Vec3 instance.
-     * @param x - The x-coordinate of the vector.
-     * @param y - The y-coordinate of the vector.
-     * @param z - The z-coordinate of the vector.
+     * @param {number} x - The x-coordinate of the vector.
+     * @param {number} y - The y-coordinate of the vector.
+     * @param {number} z - The z-coordinate of the vector.
      */
     constructor(x?: number, y?: number, z?: number);
     /**
      * Adds two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns A new Vec3 instance representing the sum.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {Vec3} A new Vec3 instance representing the sum.
      */
     static add(v: Vec3, w: Vec3): Vec3;
     /**
      * Subtracts one vector from another.
-     * @param v - The vector to subtract from.
-     * @param w - The vector to subtract.
-     * @returns A new Vec2 instance representing the difference.
+     * @param {Vec3} v - The vector to subtract from.
+     * @param {Vec3} w - The vector to subtract.
+     * @returns {Vec3} A new Vec3 instance representing the difference.
      */
     static subtract(v: Vec3, w: Vec3): Vec3;
     /**
@@ -40,16 +44,16 @@ export declare class Vec3 {
     static divide(v: Vec3, w: Vec3): Vec3;
     /**
      * Calculates the angle between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The angle between the vectors in radians.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {number} The angle between the vectors in radians.
      */
     static angleBetween(v: Vec3, w: Vec3): number;
     /**
      * Calculates the cross product of two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The cross product of the two vectors.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {Vec3} The cross product of the two vectors.
      */
     static cross(v: Vec3, w: Vec3): Vec3;
     /**
@@ -62,68 +66,69 @@ export declare class Vec3 {
     static reflect(v: Vec3, normal: Vec3): Vec3;
     /**
      * Calculates the Euclidean distance between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The distance between the vectors.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {number} The distance between the vectors.
      */
     static distance(v: Vec3, w: Vec3): number;
     /**
      * Calculates the Chebyshev distance between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The Chebyshev distance between the vectors.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {number} The Chebyshev distance between the vectors.
      */
     static distanceChebyshev(v: Vec3, w: Vec3): number;
     /**
      * Calculates the Manhattan distance between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The Manhattan distance between the vectors.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {number} The Manhattan distance between the vectors.
      */
     static distanceManhattan(v: Vec3, w: Vec3): number;
     /**
      * Calculates the Minkowski distance between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @param p - The order of the Minkowski distance.
-     * @returns The Minkowski distance between the vectors.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @param {number} p - The order of the Minkowski distance.
+     * @returns {number} The Minkowski distance between the vectors.
      */
     static distanceMinkowski(v: Vec3, w: Vec3, p: number): number;
     /**
      * Calculates the squared Euclidean distance between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The squared distance between the vectors.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {number} The squared distance between the vectors.
      */
     static distanceSq(v: Vec3, w: Vec3): number;
     /**
      * Calculates the dot product of two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The dot product of the two vectors.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {number} The dot product of the two vectors.
      */
     static dot(v: Vec3, w: Vec3): number;
     /**
      * Creates a Vec3 from cylindrical coordinates.
-     * @param r - Radial distance from the z-axis
-     * @param phi - Azimuthal angle in the x-y plane from the x-axis
-     * @param z - Height above the x-y plane
-     * @returns New Vec3 instance
+     * @param {number} r - Radial distance from the z-axis
+     * @param {number} phi - Azimuthal angle in the x-y plane from the x-axis
+     * @param {number} z - Height above the x-y plane
+     * @returns {Vec3} New Vec3 instance
      */
     static fromCylindricalCoords(r: number, phi: number, z: number): Vec3;
     /**
      * Creates a Vec3 from spherical coordinates.
-     * @param r - Radial distance from origin
-     * @param theta - Polar angle from the z-axis
-     * @param phi - Azimuthal angle in the x-y plane from the x-axis
-     * @returns New Vec3 instance
+     * @param {number} r - Radial distance from origin
+     * @param {number} theta - Polar angle from the z-axis
+     * @param {number} phi - Azimuthal angle in the x-y plane from the x-axis
+     * @returns {Vec3} New Vec3 instance
      */
     static fromSphericalCoords(r: number, theta: number, phi: number): Vec3;
     /**
      * Creates an immutable Vec3-like object.
-     * @param x - The x-coordinate of the vector.
-     * @param y - The y-coordinate of the vector.
-     * @returns An immutable object with Vec3-like properties.
+     * @param {number} x - The x-coordinate of the vector.
+     * @param {number} y - The y-coordinate of the vector.
+     * @param {number} z - The z-coordinate of the vector.
+     * @returns {Readonly<{ x: number; y: number; z: number; xyz: readonly number[]; r: number; g: number; b: number; rgb: readonly number[]; magnitude: number; magnitudeSq: number; angleX: number; angleY: number; angleZ: number; isInfinite: boolean; isNaN: boolean; isZero: boolean }>} An immutable object with Vec3-like properties.
      */
     static immutable(x?: number, y?: number, z?: number): {
         readonly x: number;
@@ -145,67 +150,67 @@ export declare class Vec3 {
     };
     /**
      * Checks if a vector has infinite components.
-     * @param v - The vector to check.
-     * @returns True if the vector has infinite components, false otherwise.
+     * @param {Vec3} v - The vector to check.
+     * @returns {boolean} True if the vector has infinite components, false otherwise.
      */
     static isInfinite(v: Vec3): boolean;
     /**
      * Checks if a vector has NaN components.
-     * @param v - The vector to check.
-     * @returns True if the vector has NaN components, false otherwise.
+     * @param {Vec3} v - The vector to check.
+     * @returns {boolean} True if the vector has NaN components, false otherwise.
      */
     static isNaN(v: Vec3): boolean;
     /**
      * Checks if a vector is zero.
-     * @param v - The vector to check.
-     * @returns True if the vector is zero, false otherwise.
+     * @param {Vec3} v - The vector to check.
+     * @returns {boolean} True if the vector is zero, false otherwise.
      */
     static isZero(v: Vec3): boolean;
     /**
      * Performs linear interpolation between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @param t - The interpolation parameter (0 to 1).
-     * @returns A new Vec2 instance representing the interpolated vector.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @param {number} t - The interpolation parameter (0 to 1).
+     * @returns {Vec3} A new Vec3 instance representing the interpolated vector.
      */
     static lerp(v: Vec3, w: Vec3, t: number): Vec3;
     /**
      * Negates a vector.
-     * @param v - The vector to negate.
-     * @returns A new Vec2 instance representing the negated vector.
+     * @param {Vec3} v - The vector to negate.
+     * @returns {Vec3} A new Vec3 instance representing the negated vector.
      */
     static negate(v: Vec3): Vec3;
     /**
      * Normalizes a vector.
-     * @param v - The vector to normalize.
-     * @returns A new Vec2 instance representing the normalized vector.
+     * @param {Vec3} v - The vector to normalize.
+     * @returns {Vec3} A new Vec3 instance representing the normalized vector.
      */
     static normalize(v: Vec3): Vec3;
     /**
      * Projects one vector onto another.
-     * @param v - The vector to project.
-     * @param w - The vector to project onto.
-     * @returns A new Vec2 instance representing the projected vector.
+     * @param {Vec3} v - The vector to project.
+     * @param {Vec3} w - The vector to project onto.
+     * @returns {Vec3} A new Vec3 instance representing the projected vector.
      */
     static project(v: Vec3, w: Vec3): Vec3;
     /**
      * Creates a random unit vector.
-     * @param random - A function that returns a random number between 0 and 1.
-     * @returns A new Vec3 instance representing a random unit vector.
+     * @param {() => number} random - A function that returns a random number between 0 and 1.
+     * @returns {Vec3} A new Vec3 instance representing a random unit vector.
      */
     static random(random?: () => number): Vec3;
     /**
      * Checks if two vectors are equal.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns True if the vectors are equal, false otherwise.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {boolean} True if the vectors are equal, false otherwise.
      */
     static satisfyEquality(v: Vec3, w: Vec3): boolean;
     /**
      * Checks if two vectors are opposite.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns True if the vectors are opposite, false otherwise.
+     * @param {Vec3} v - The first vector.
+     * @param {Vec3} w - The second vector.
+     * @returns {boolean} True if the vectors are opposite, false otherwise.
      */
     static satisfyOpposition(v: Vec3, w: Vec3): boolean;
     /**
@@ -218,14 +223,14 @@ export declare class Vec3 {
     static equals(v: Vec3, w: Vec3, epsilon?: number): boolean;
     /**
      * Scales a vector by a scalar value.
-     * @param v - The vector to scale.
-     * @param c - The scalar value.
-     * @returns A new Vec3 instance representing the scaled vector.
+     * @param {Vec3} v - The vector to scale.
+     * @param {number} c - The scalar value.
+     * @returns {Vec3} A new Vec3 instance representing the scaled vector.
      */
     static scale(v: Vec3, c: number): Vec3;
     /**
      * Creates a zero vector.
-     * @returns A new Vec3 instance representing a zero vector.
+     * @returns {Vec3} A new Vec3 instance representing a zero vector.
      */
     static zero(): Vec3;
     /**
@@ -235,12 +240,14 @@ export declare class Vec3 {
     static one(): Vec3;
     /**
      * Creates a Vec3 from an array.
-     * @returns A new Vec3 instance.
+     * @param {[number, number, number] | number[]} arr - An array containing the x, y, and z coordinates.
+     * @returns {Vec3} A new Vec3 instance.
      */
     static fromArray(arr: [number, number, number] | number[]): Vec3;
     /**
      * Creates a Vec3 from an object with x, y and z properties.
-     * @returns A new Vec3 instance.
+     * @param {{ x: number; y: number; z: number }} obj - An object with x, y, and z properties.
+     * @returns {Vec3} A new Vec3 instance.
      */
     static fromObject(obj: {
         x: number;
@@ -259,82 +266,90 @@ export declare class Vec3 {
     }): Vec3;
     /**
      * Gets the x-component of the vector.
-     * @returns The x-component.
+     * @returns {number} The x-component.
      */
     get x(): number;
     /**
      * Sets the x-component of the vector.
-     * @param x - The new x-component.
+     * @param {number} x - The new x-component.
+     * @returns {void}
      */
     set x(x: number);
     /**
      * Gets the y-component of the vector.
-     * @returns The y-component.
+     * @returns {number} The y-component.
      */
     get y(): number;
     /**
      * Sets the y-component of the vector.
-     * @param y - The new y-component.
+     * @param {number} y - The new y-component.
+     * @returns {void}
      */
     set y(y: number);
     /**
      * Gets the z-component of the vector.
-     * @returns The z-component.
+     * @returns {number} The z-component.
      */
     get z(): number;
     /**
      * Sets the z-component of the vector.
-     * @param z - The new z-component.
+     * @param {number} z - The new z-component.
+     * @returns {void}
      */
     set z(z: number);
     /**
      * Gets a copy of the vector's components as an array.
-     * @returns An array containing the x, y and z components of the vector.
+     * @returns {[number, number, number]} An array containing the x, y and z components of the vector.
      */
     get xyz(): [number, number, number];
     /**
      * Sets all components of the vector at once.
-     * @param xyz - An array containing the new x, y and z components.
+     * @param {[number, number, number]} xyz - An array containing the new x, y and z components.
+     * @returns {void}
      */
     set xyz(xyz: [number, number, number]);
     /**
      * Gets the Red-component of a Color.
-     * @returns The Red-component.
+     * @returns {number} The Red-component.
      */
     get r(): number;
     /**
      * Sets the Red-component of a Color.
-     * @param r - The new Red-component.
+     * @param {number} r - The new Red-component.
+     * @returns {void}
      */
     set r(r: number);
     /**
      * Gets the Green-component of a Color.
-     * @returns The Green-component.
+     * @returns {number} The Green-component.
      */
     get g(): number;
     /**
      * Sets the Green-component of the Color.
-     * @param g - The new Green-component.
+     * @param {number} g - The new Green-component.
+     * @returns {void}
      */
     set g(g: number);
     /**
      * Gets the Blue-component of the color.
-     * @returns The Blue-component.
+     * @returns {number} The Blue-component.
      */
     get b(): number;
     /**
      * Sets the Blue-component of the Color.
-     * @param b - The new Blue-component.
+     * @param {number} b - The new Blue-component.
+     * @returns {void}
      */
     set b(b: number);
     /**
      * Gets a copy of the vector's components as an array.
-     * @returns An array containing the x, y and z components of the vector.
+     * @returns {[number, number, number]} An array containing the x, y and z components of the vector.
      */
     get rgb(): [number, number, number];
     /**
      * Sets all components of the Color at once.
-     * @param rgb - An array containing the new Red, Green and Blue components.
+     * @param {[number, number, number]} rgb - An array containing the new Red, Green and Blue components.
+     * @returns {void}
      */
     set rgb(rgb: [number, number, number]);
     /**
@@ -370,8 +385,8 @@ export declare class Vec3 {
     set magnitude(m: number);
     /**
      * Adds another vector to this vector.
-     * @param v - The vector to add.
-     * @returns This Vec3 instance for method chaining.
+     * @param {Vec3} v - The vector to add.
+     * @returns {this} This Vec3 instance for method chaining.
      */
     add(v: Vec3): this;
     /**
@@ -407,7 +422,7 @@ export declare class Vec3 {
     clamp(min: number, max: number): this;
     /**
      * Creates a copy of this vector.
-     * @returns A new Vec3 instance with the same components.
+     * @returns {Vec3} A new Vec3 instance with the same components.
      */
     clone(): Vec3;
     /**
@@ -418,14 +433,14 @@ export declare class Vec3 {
     copy(v: Vec3): this;
     /**
      * Calculates the dot product of this vector with another vector.
-     * @param v - The other vector.
-     * @returns The dot product of the vectors.
+     * @param {Vec3} v - The other vector.
+     * @returns {number} The dot product of the vectors.
      */
     dot(v: Vec3): number;
     /**
      * Calculates cross product between this vector and another vector.
-     * @param v - The other vector.
-     * @returns The distance between the vectors.
+     * @param {Vec3} v - The other vector.
+     * @returns {this} This Vec3 instance for method chaining.
      */
     cross(v: Vec3): this;
     /**
@@ -443,21 +458,21 @@ export declare class Vec3 {
     distance(v: Vec3): number;
     /**
      * Calculates the Chebyshev distance between vector and another vector.
-     * @param v - The other vector.
-     * @returns The Chebyshev distance between the vectors.
+     * @param {Vec3} v - The other vector.
+     * @returns {number} The Chebyshev distance between the vectors.
      */
     distanceChebyshev(v: Vec3): number;
     /**
      * Calculates the Manhattan distance between vector and another vector.
-     * @param v - The other vector.
-     * @returns The Manhattan distance between the vectors.
+     * @param {Vec3} v - The other vector.
+     * @returns {number} The Manhattan distance between the vectors.
      */
     distanceManhattan(v: Vec3): number;
     /**
      * Calculates the Minkowski distance between this vector and another vector.
-     * @param v - The other vector.
-     * @param p - The order of the Minkowski distance.
-     * @returns The Minkowski distance between the vectors.
+     * @param {Vec3} v - The other vector.
+     * @param {number} p - The order of the Minkowski distance.
+     * @returns {number} The Minkowski distance between the vectors.
      */
     distanceMinkowski(v: Vec3, p: number): number;
     /**