@fimbul-works/vec 1.1.0 → 2.0.0

package/dist/cjs/vec4.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Documentation for 4D Vector class.
+ * @module Vec4
+ */
 /**
  * Represents a 4D vector with various operations.
  */
@@ -5,24 +9,24 @@ export declare class Vec4 {
     #private;
     /**
      * Creates a new Vec4 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 w - The w-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.
+     * @param {number} w - The w-coordinate of the vector.
      */
     constructor(x?: number, y?: number, z?: number, w?: number);
     /**
      * Adds two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns A new Vec3 instance representing the sum.
+     * @param {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {Vec4} A new Vec4 instance representing the sum.
      */
     static add(v: Vec4, w: Vec4): Vec4;
     /**
      * 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 {Vec4} v - The vector to subtract from.
+     * @param {Vec4} w - The vector to subtract.
+     * @returns {Vec4} A new Vec4 instance representing the difference.
      */
     static subtract(v: Vec4, w: Vec4): Vec4;
     /**
@@ -41,52 +45,52 @@ export declare class Vec4 {
     static divide(v: Vec4, w: Vec4): Vec4;
     /**
      * 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {number} The angle between the vectors in radians.
      */
     static angleBetween(v: Vec4, w: Vec4): number;
     /**
      * Calculates the Euclidean distance between two vectors.
-     * @param v - The first vector.
-     * @param w - The second vector.
-     * @returns The distance between the vectors.
+     * @param {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {number} The distance between the vectors.
      */
     static distance(v: Vec4, w: Vec4): 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {number} The Chebyshev distance between the vectors.
      */
     static distanceChebyshev(v: Vec4, w: Vec4): 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {number} The Manhattan distance between the vectors.
      */
     static distanceManhattan(v: Vec4, w: Vec4): 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @param {number} p - The order of the Minkowski distance.
+     * @returns {number} The Minkowski distance between the vectors.
      */
     static distanceMinkowski(v: Vec4, w: Vec4, 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {number} The squared distance between the vectors.
      */
     static distanceSq(v: Vec4, w: Vec4): 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {number} The dot product of the two vectors.
      */
     static dot(v: Vec4, w: Vec4): number;
     /**
@@ -99,9 +103,11 @@ export declare class Vec4 {
     static reflect(v: Vec4, normal: Vec4): Vec4;
     /**
      * Creates an immutable Vec4-like object.
-     * @param x - The x-coordinate of the vector.
-     * @param y - The y-coordinate of the vector.
-     * @returns An immutable object with Vec4-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.
+     * @param {number} w - The w-coordinate of the vector.
+     * @returns {Readonly<{ x: number; y: number; z: number; w: number; xyzw: readonly number[]; r: number; g: number; b: number; a: number; rgba: readonly number[]; magnitude: number; magnitudeSq: number; angleW: number; angleX: number; angleY: number; angleZ: number; isInfinite: boolean; isNaN: boolean; isZero: boolean }>} An immutable object with Vec4-like properties.
      */
     static immutable(x?: number, y?: number, z?: number, w?: number): {
         readonly x: number;
@@ -126,67 +132,67 @@ export declare class Vec4 {
     };
     /**
      * Checks if a vector has infinite components.
-     * @param v - The vector to check.
-     * @returns True if the vector has infinite components, false otherwise.
+     * @param {Vec4} v - The vector to check.
+     * @returns {boolean} True if the vector has infinite components, false otherwise.
      */
     static isInfinite(v: Vec4): 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 {Vec4} v - The vector to check.
+     * @returns {boolean} True if the vector has NaN components, false otherwise.
      */
     static isNaN(v: Vec4): boolean;
     /**
      * Checks if a vector is zero.
-     * @param v - The vector to check.
-     * @returns True if the vector is zero, false otherwise.
+     * @param {Vec4} v - The vector to check.
+     * @returns {boolean} True if the vector is zero, false otherwise.
      */
     static isZero(v: Vec4): 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @param {number} t - The interpolation parameter (0 to 1).
+     * @returns {Vec4} A new Vec4 instance representing the interpolated vector.
      */
     static lerp(v: Vec4, w: Vec4, t: number): Vec4;
     /**
      * Negates a vector.
-     * @param v - The vector to negate.
-     * @returns A new Vec2 instance representing the negated vector.
+     * @param {Vec4} v - The vector to negate.
+     * @returns {Vec4} A new Vec4 instance representing the negated vector.
      */
     static negate(v: Vec4): Vec4;
     /**
      * Normalizes a vector.
-     * @param v - The vector to normalize.
-     * @returns A new Vec2 instance representing the normalized vector.
+     * @param {Vec4} v - The vector to normalize.
+     * @returns {Vec4} A new Vec4 instance representing the normalized vector.
      */
     static normalize(v: Vec4): Vec4;
     /**
      * 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 {Vec4} v - The vector to project.
+     * @param {Vec4} w - The vector to project onto.
+     * @returns {Vec4} A new Vec4 instance representing the projected vector.
      */
     static project(v: Vec4, w: Vec4): Vec4;
     /**
      * Creates a random unit vector.
-     * @param random - A function that returns a random number between 0 and 1.
-     * @returns A new Vec4 instance representing a random unit vector.
+     * @param {() => number} random - A function that returns a random number between 0 and 1.
+     * @returns {Vec4} A new Vec4 instance representing a random unit vector.
      */
     static random(random?: () => number): Vec4;
     /**
      * 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {boolean} True if the vectors are equal, false otherwise.
      */
     static satisfyEquality(v: Vec4, w: Vec4): 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 {Vec4} v - The first vector.
+     * @param {Vec4} w - The second vector.
+     * @returns {boolean} True if the vectors are opposite, false otherwise.
      */
     static satisfyOpposition(v: Vec4, w: Vec4): boolean;
     /**
@@ -199,14 +205,14 @@ export declare class Vec4 {
     static equals(v: Vec4, w: Vec4, epsilon?: number): boolean;
     /**
      * Scales a vector by a scalar value.
-     * @param v - The vector to scale.
-     * @param c - The scalar value.
-     * @returns A new Vec2 instance representing the scaled vector.
+     * @param {Vec4} v - The vector to scale.
+     * @param {number} c - The scalar value.
+     * @returns {Vec4} A new Vec4 instance representing the scaled vector.
      */
     static scale(v: Vec4, c: number): Vec4;
     /**
      * Creates a zero vector.
-     * @returns A new Vec4 instance representing a zero vector.
+     * @returns {Vec4} A new Vec4 instance representing a zero vector.
      */
     static zero(): Vec4;
     /**
@@ -216,12 +222,14 @@ export declare class Vec4 {
     static one(): Vec4;
     /**
      * Creates a Vec4 from an array.
-     * @returns A new Vec4 instance.
+     * @param {[number, number, number, number] | number[]} arr - An array containing the x, y, z, and w coordinates.
+     * @returns {Vec4} A new Vec4 instance.
      */
     static fromArray(arr: [number, number, number, number] | number[]): Vec4;
     /**
      * Creates a Vec4 from an object with x, y, z and w properties.
-     * @returns A new Vec4 instance.
+     * @param {{ x: number; y: number; z: number; w: number }} obj - An object with x, y, z, and w properties.
+     * @returns {Vec4} A new Vec4 instance.
      */
     static fromObject(obj: {
         x: number;
@@ -242,102 +250,112 @@ export declare class Vec4 {
     }): Vec4;
     /**
      * 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 z-component of the vector.
-     * @param y - The new z-component.
+     * @param {number} y - The new z-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 the w-component of the vector.
-     * @returns The w-component.
+     * @returns {number} The w-component.
      */
     get w(): number;
     /**
      * Sets the w-component of the vector.
-     * @param w - The new w-component.
+     * @param {number} w - The new w-component.
+     * @returns {void}
      */
     set w(w: number);
     /**
      * Gets a copy of the vector's components as an array.
-     * @returns An array containing the x, y, z and w components of the vector.
+     * @returns {[number, number, number, number]} An array containing the x, y, z and w components of the vector.
      */
     get xyzw(): [number, number, number, number];
     /**
      * Sets both components of the vector at once.
-     * @param xyzw - An array containing the new x, y and z components.
+     * @param {[number, number, number, number]} xyzw - An array containing the new x, y, z and w components.
+     * @returns {void}
      */
     set xyzw(xyzw: [number, 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 the Alpha-component of the color.
-     * @returns The Alpha-component.
+     * @returns {number} The Alpha-component.
      */
     get a(): number;
     /**
      * Sets the Alpha-component of the Color.
-     * @param b - The new Alpha-component.
+     * @param {number} a - The new Alpha-component.
+     * @returns {void}
      */
     set a(a: number);
     /**
      * Gets a copy of the vector's components as an array.
-     * @returns An array containing the Red, Green, Blue and Alpha components of the Color.
+     * @returns {[number, number, number, number]} An array containing the Red, Green, Blue and Alpha components of the Color.
      */
     get rgba(): [number, number, number, number];
     /**
      * Sets all components of the Color at once.
-     * @param rgba - An array containing the new Red, Green and Blue components.
+     * @param {[number, number, number, number]} rgba - An array containing the new Red, Green, Blue and Alpha components.
+     * @returns {void}
      */
     set rgba(rgba: [number, number, number, number]);
     /**
@@ -378,8 +396,8 @@ export declare class Vec4 {
     set magnitude(m: number);
     /**
      * Adds another vector to this vector.
-     * @param v - The vector to add.
-     * @returns This Vec4 instance for method chaining.
+     * @param {Vec4} v - The vector to add.
+     * @returns {this} This Vec4 instance for method chaining.
      */
     add(v: Vec4): this;
     /**
@@ -408,14 +426,14 @@ export declare class Vec4 {
     angleBetween(v: Vec4): number;
     /**
      * Clamps the magnitude of this vector between a minimum and maximum value.
-     * @param min - The minimum magnitude.
-     * @param max - The maximum magnitude.
-     * @returns This Vec4 instance for method chaining.
+     * @param {number} min - The minimum magnitude.
+     * @param {number} max - The maximum magnitude.
+     * @returns {this} This Vec4 instance for method chaining.
      */
     clamp(min: number, max: number): this;
     /**
      * Creates a copy of this vector.
-     * @returns A new Vec4 instance with the same components.
+     * @returns {Vec4} A new Vec4 instance with the same components.
      */
     clone(): Vec4;
     /**
@@ -432,21 +450,21 @@ export declare class Vec4 {
     distance(v: Vec4): number;
     /**
      * Calculates the Chebyshev distance between this vector and another vector.
-     * @param v - The first vector.
-     * @returns The Chebyshev distance between the vectors.
+     * @param {Vec4} v - The other vector.
+     * @returns {number} The Chebyshev distance between the vectors.
      */
     distanceChebyshev(v: Vec4): number;
     /**
      * Calculates the Manhattan distance between this vector and another vector.
-     * @param v - The other vector.
-     * @returns The Manhattan distance between the vectors.
+     * @param {Vec4} v - The other vector.
+     * @returns {number} The Manhattan distance between the vectors.
      */
     distanceManhattan(v: Vec4): number;
     /**
-     * Calculates the Minkowski distance between  thisvector and another vector.
-     * @param v - The other vector.
-     * @param p - The order of the Minkowski distance.
-     * @returns The Minkowski distance between the vectors.
+     * Calculates the Minkowski distance between this vector and another vector.
+     * @param {Vec4} v - The other vector.
+     * @param {number} p - The order of the Minkowski distance.
+     * @returns {number} The Minkowski distance between the vectors.
      */
     distanceMinkowski(v: Vec4, p: number): number;
     /**