@oliversalzburg/js-utils 0.0.18 → 0.0.19-dev.0

package/{lib/math → math}/matrix3.js

@@ -131,15 +131,15 @@ export class Matrix3 {
     }
     /**
      * Constructs a new {@linkcode Matrix3}.
-     * @param m00 Position `0,0` of this matrix.
-     * @param m10 Position `1,0` of this matrix.
-     * @param m20 Position `2,0` of this matrix.
-     * @param m01 Position `0,1` of this matrix.
-     * @param m11 Position `1,1` of this matrix.
-     * @param m21 Position `2,1` of this matrix.
-     * @param m02 Position `0,2` of this matrix.
-     * @param m12 Position `1,2` of this matrix.
-     * @param m22 Position `2,2` of this matrix.
+     * @param m00 - Position `0,0` of this matrix.
+     * @param m10 - Position `1,0` of this matrix.
+     * @param m20 - Position `2,0` of this matrix.
+     * @param m01 - Position `0,1` of this matrix.
+     * @param m11 - Position `1,1` of this matrix.
+     * @param m21 - Position `2,1` of this matrix.
+     * @param m02 - Position `0,2` of this matrix.
+     * @param m12 - Position `1,2` of this matrix.
+     * @param m22 - Position `2,2` of this matrix.
      */
     constructor(m00 = 1, m10 = 0, m20 = 0, m01 = 0, m11 = 1, m21 = 0, m02 = 0, m12 = 0, m22 = 1) {
         this.m00 = m00;
@@ -154,7 +154,7 @@ export class Matrix3 {
     }
     /**
      * Creates a new {@linkcode Matrix3} from another {@linkcode Matrix3}.
-     * @param matrix The matrix to copy.
+     * @param matrix - The matrix to copy.
      * @returns A new matrix.
      */
     static fromMatrix3(matrix) {
@@ -162,7 +162,7 @@ export class Matrix3 {
     }
     /**
      * Creates a new {@linkcode Matrix3} from a rotation in Euler angles.
-     * @param degrees The rotation in Euler angles.
+     * @param degrees - The rotation in Euler angles.
      * @returns A new matrix.
      */
     static fromEuler(degrees) {
@@ -170,8 +170,8 @@ export class Matrix3 {
     }
     /**
      * Creates a new {@linkcode Matrix3} from a rotation around an axis.
-     * @param axis The axis around which to rotate.
-     * @param degrees The rotation in degrees.
+     * @param axis - The axis around which to rotate.
+     * @param degrees - The rotation in degrees.
      * @returns A new matrix.
      */
     static fromVector3(axis, degrees) {
@@ -179,7 +179,7 @@ export class Matrix3 {
     }
     /**
      * Creates a new {@linkcode Matrix3} from a quaternion.
-     * @param quaternion The quaternion describes the rotation.
+     * @param quaternion - The quaternion describes the rotation.
      * @returns A new matrix.
      */
     static fromQuaternion(quaternion) {
@@ -187,7 +187,7 @@ export class Matrix3 {
     }
     /**
      * Sets the matrix to new values from another matrix.
-     * @param matrix The matrix to copy.
+     * @param matrix - The matrix to copy.
      * @returns This instance.
      */
     set(matrix) {
@@ -196,15 +196,15 @@ export class Matrix3 {
     }
     /**
      * Update the matrix by individual components.
-     * @param m00 Position `0,0` of this matrix.
-     * @param m10 Position `1,0` of this matrix.
-     * @param m20 Position `2,0` of this matrix.
-     * @param m01 Position `0,1` of this matrix.
-     * @param m11 Position `1,1` of this matrix.
-     * @param m21 Position `2,1` of this matrix.
-     * @param m02 Position `0,2` of this matrix.
-     * @param m12 Position `1,2` of this matrix.
-     * @param m22 Position `2,2` of this matrix.
+     * @param m00 - Position `0,0` of this matrix.
+     * @param m10 - Position `1,0` of this matrix.
+     * @param m20 - Position `2,0` of this matrix.
+     * @param m01 - Position `0,1` of this matrix.
+     * @param m11 - Position `1,1` of this matrix.
+     * @param m21 - Position `2,1` of this matrix.
+     * @param m02 - Position `0,2` of this matrix.
+     * @param m12 - Position `1,2` of this matrix.
+     * @param m22 - Position `2,2` of this matrix.
      * @returns This instance.
      */
     setM(m00, m10, m20, m01, m11, m21, m02, m12, m22) {
@@ -221,7 +221,7 @@ export class Matrix3 {
     }
     /**
      * Sets the matrix to a rotation in Euler angles.
-     * @param degrees The rotation in Euler angles.
+     * @param degrees - The rotation in Euler angles.
      * @returns This instance.
      */
     setEuler(degrees) {
@@ -257,8 +257,8 @@ export class Matrix3 {
     }
     /**
      * Sets the matrix to a rotation around an axis.
-     * @param axis The axis around which to rotate.
-     * @param degrees The rotation in degrees.
+     * @param axis - The axis around which to rotate.
+     * @param degrees - The rotation in degrees.
      * @returns This instance.
      */
     setVector3(axis, degrees) {
@@ -284,7 +284,7 @@ export class Matrix3 {
     }
     /**
      * Sets the matrix to a rotation described by a quaternion.
-     * @param quaternion The quaternion describing the rotation.
+     * @param quaternion - The quaternion describing the rotation.
      * @returns This instance.
      */
     setQuaternion(quaternion) {
@@ -358,7 +358,7 @@ export class Matrix3 {
     }
     /**
      * Multiply with another matrix from the right.
-     * @param matrix The matrix to multiply with.
+     * @param matrix - The matrix to multiply with.
      * @returns This instance.
      */
     multiplyR(matrix) {
@@ -384,7 +384,7 @@ export class Matrix3 {
     }
     /**
      * Inversely multiply with another matrix from the right.
-     * @param matrix The matrix to multiply with.
+     * @param matrix - The matrix to multiply with.
      * @returns This instance.
      */
     multiplyInverseR(matrix) {
@@ -410,7 +410,7 @@ export class Matrix3 {
     }
     /**
      * Multiply with another matrix from the left.
-     * @param matrix The matrix to multiply with.
+     * @param matrix - The matrix to multiply with.
      * @returns This instance.
      */
     multiplyL(matrix) {
@@ -436,7 +436,7 @@ export class Matrix3 {
     }
     /**
      * Inversely multiply with another matrix from the right.
-     * @param matrix The matrix to multiply with.
+     * @param matrix - The matrix to multiply with.
      * @returns This instance.
      */
     multiplyInverseL(matrix) {
@@ -462,8 +462,8 @@ export class Matrix3 {
     }
     /**
      * Sets this matrix up as a transformation matrix to look in a given direction.
-     * @param direction The direction to look in.
-     * @param upVector The vector indicating the up direction. If not provided
+     * @param direction - The direction to look in.
+     * @param upVector - The vector indicating the up direction. If not provided
      * a best effort is made to find a good one.
      * @returns This instance.
      */

package/{lib/math → math}/quaternion.d.ts

@@ -9,86 +9,86 @@ import { Vector4 } from "./vector4.js";
 export declare class Quaternion extends Vector4 {
     /**
      * Constructs a new {@linkcode Quaternion}.
-     * @param x The X component.
-     * @param y The Y component.
-     * @param z The Z component.
-     * @param w The W component.
+     * @param x - The X component.
+     * @param y - The Y component.
+     * @param z - The Z component.
+     * @param w - The W component.
      */
     constructor(x?: number, y?: number, z?: number, w?: number);
     /**
      * Creates a new {@linkcode Quaternion} from a rotation matrix.
-     * @param matrix The matrix to construct the quaternion from.
+     * @param matrix - The matrix to construct the quaternion from.
      * @returns A new quaternion.
      */
     static fromMatrix3(matrix: Readonly<Matrix3>): Quaternion;
     /**
      * Creates a new {@linkcode Quaternion} from a rotation in Euler angles.
-     * @param degrees The rotation in Euler angles.
+     * @param degrees - The rotation in Euler angles.
      * @returns A new quaternion.
      */
     static fromEuler(degrees: Readonly<Euler>): Quaternion;
     /**
      * Creates a new {@linkcode Quaternion} from a rotation around an axis.
-     * @param axis The axis around which to rotate.
-     * @param degrees The rotation in degrees.
+     * @param axis - The axis around which to rotate.
+     * @param degrees - The rotation in degrees.
      * @returns A new quaternion.
      */
     static fromVector3(axis: Readonly<Vector3>, degrees: number): Quaternion;
     /**
      * Creates a new {@linkcode Quaternion} from a {@linkcode Vector4}.
-     * @param vector The vector to copy the components from.
+     * @param vector - The vector to copy the components from.
      * @returns A new quaternion.
      */
     static fromVector4(vector: Readonly<Vector4>): Quaternion;
     /**
      * Creates a new {@linkcode Quaternion} from another {@linkcode Quaternion}.
-     * @param quaternion The quaternion to copy.
+     * @param quaternion - The quaternion to copy.
      * @returns A new quaternion.
      */
     static fromQuaternion(quaternion: Readonly<Quaternion>): Quaternion;
     /**
      * Sets the quaternion to the values of another quaternion.
-     * @param quaternion The quaternion to copy.
+     * @param quaternion - The quaternion to copy.
      * @returns This instance.
      */
     set(quaternion: Readonly<Quaternion>): this;
     /**
      * Sets all components of the quaternion to the given value.
-     * @param value The value to assign to the components of the quaternion.
+     * @param value - The value to assign to the components of the quaternion.
      * @returns This instance.
      */
     setValue(value: number): this;
     /**
      * Sets the components of the quaternion to the given values.
-     * @param x The X component for the quaternion.
-     * @param y The Y component for the quaternion.
-     * @param z The Z component for the quaternion.
-     * @param w The W component for the quaternion.
+     * @param x - The X component for the quaternion.
+     * @param y - The Y component for the quaternion.
+     * @param z - The Z component for the quaternion.
+     * @param w - The W component for the quaternion.
      * @returns This instance.
      */
     setXYZW(x: number, y: number, z?: number, w?: number): this;
     /**
      * Sets the quaternion to the rotation of the given matrix.
-     * @param matrix The matrix describing the rotation of the quaternion.
+     * @param matrix - The matrix describing the rotation of the quaternion.
      * @returns This instance.
      */
     setMatrix3(matrix: Readonly<Matrix3>): this;
     /**
      * Sets the quaternion to a rotation in Euler angles.
-     * @param degrees The rotation in Euler angles.
+     * @param degrees - The rotation in Euler angles.
      * @returns This instance.
      */
     setEuler(degrees: Readonly<Euler>): this;
     /**
      * Sets the quaternion to a rotation around an axis.
-     * @param axis The axis around which to rotate.
-     * @param degrees The rotation in degrees.
+     * @param axis - The axis around which to rotate.
+     * @param degrees - The rotation in degrees.
      * @returns This instance.
      */
     setVector3(axis: Readonly<Vector3>, degrees: number): this;
     /**
      * Sets the quaternion to the components of a {@linkcode Vector4}.
-     * @param vector The vector to copy.
+     * @param vector - The vector to copy.
      * @returns This instance.
      */
     setVector4(vector: Readonly<Vector4>): this;
@@ -104,16 +104,16 @@ export declare class Quaternion extends Vector4 {
     invert(): this;
     /**
      * Multiply with another quaternion from the right.
-     * @param quaternion The quaternion to multiply with.
+     * @param quaternion - The quaternion to multiply with.
      * @returns This instance.
      */
     multiplyR(quaternion: Readonly<Quaternion>): this;
     /**
      * Performs spherical linear interpolation between two rotations, and sets this
      * quaternion to the resulting rotation.
-     * @param q1 The initial rotation.
-     * @param q2 The target rotation.
-     * @param t The location on the scale from `0` to `1`.
+     * @param q1 - The initial rotation.
+     * @param q2 - The target rotation.
+     * @param t - The location on the scale from `0` to `1`.
      * @returns This instance.
      */
     slerp(q1: Readonly<Quaternion>, q2: Readonly<Quaternion>, t: number): this;

package/{lib/math → math}/quaternion.js

@@ -6,10 +6,10 @@ import { Vector4 } from "./vector4.js";
 export class Quaternion extends Vector4 {
     /**
      * Constructs a new {@linkcode Quaternion}.
-     * @param x The X component.
-     * @param y The Y component.
-     * @param z The Z component.
-     * @param w The W component.
+     * @param x - The X component.
+     * @param y - The Y component.
+     * @param z - The Z component.
+     * @param w - The W component.
      */
     // eslint-disable-next-line @typescript-eslint/no-useless-constructor
     constructor(x = 0, y = 0, z = 0, w = 0) {
@@ -17,7 +17,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Creates a new {@linkcode Quaternion} from a rotation matrix.
-     * @param matrix The matrix to construct the quaternion from.
+     * @param matrix - The matrix to construct the quaternion from.
      * @returns A new quaternion.
      */
     static fromMatrix3(matrix) {
@@ -25,7 +25,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Creates a new {@linkcode Quaternion} from a rotation in Euler angles.
-     * @param degrees The rotation in Euler angles.
+     * @param degrees - The rotation in Euler angles.
      * @returns A new quaternion.
      */
     static fromEuler(degrees) {
@@ -33,8 +33,8 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Creates a new {@linkcode Quaternion} from a rotation around an axis.
-     * @param axis The axis around which to rotate.
-     * @param degrees The rotation in degrees.
+     * @param axis - The axis around which to rotate.
+     * @param degrees - The rotation in degrees.
      * @returns A new quaternion.
      */
     static fromVector3(axis, degrees) {
@@ -42,7 +42,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Creates a new {@linkcode Quaternion} from a {@linkcode Vector4}.
-     * @param vector The vector to copy the components from.
+     * @param vector - The vector to copy the components from.
      * @returns A new quaternion.
      */
     static fromVector4(vector) {
@@ -50,7 +50,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Creates a new {@linkcode Quaternion} from another {@linkcode Quaternion}.
-     * @param quaternion The quaternion to copy.
+     * @param quaternion - The quaternion to copy.
      * @returns A new quaternion.
      */
     static fromQuaternion(quaternion) {
@@ -58,7 +58,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Sets the quaternion to the values of another quaternion.
-     * @param quaternion The quaternion to copy.
+     * @param quaternion - The quaternion to copy.
      * @returns This instance.
      */
     set(quaternion) {
@@ -70,7 +70,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Sets all components of the quaternion to the given value.
-     * @param value The value to assign to the components of the quaternion.
+     * @param value - The value to assign to the components of the quaternion.
      * @returns This instance.
      */
     setValue(value) {
@@ -82,10 +82,10 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Sets the components of the quaternion to the given values.
-     * @param x The X component for the quaternion.
-     * @param y The Y component for the quaternion.
-     * @param z The Z component for the quaternion.
-     * @param w The W component for the quaternion.
+     * @param x - The X component for the quaternion.
+     * @param y - The Y component for the quaternion.
+     * @param z - The Z component for the quaternion.
+     * @param w - The W component for the quaternion.
      * @returns This instance.
      */
     setXYZW(x, y, z = 0, w = 1) {
@@ -97,7 +97,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Sets the quaternion to the rotation of the given matrix.
-     * @param matrix The matrix describing the rotation of the quaternion.
+     * @param matrix - The matrix describing the rotation of the quaternion.
      * @returns This instance.
      */
     setMatrix3(matrix) {
@@ -132,7 +132,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Sets the quaternion to a rotation in Euler angles.
-     * @param degrees The rotation in Euler angles.
+     * @param degrees - The rotation in Euler angles.
      * @returns This instance.
      */
     setEuler(degrees) {
@@ -152,8 +152,8 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Sets the quaternion to a rotation around an axis.
-     * @param axis The axis around which to rotate.
-     * @param degrees The rotation in degrees.
+     * @param axis - The axis around which to rotate.
+     * @param degrees - The rotation in degrees.
      * @returns This instance.
      */
     setVector3(axis, degrees) {
@@ -166,7 +166,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Sets the quaternion to the components of a {@linkcode Vector4}.
-     * @param vector The vector to copy.
+     * @param vector - The vector to copy.
      * @returns This instance.
      */
     setVector4(vector) {
@@ -202,7 +202,7 @@ export class Quaternion extends Vector4 {
     }
     /**
      * Multiply with another quaternion from the right.
-     * @param quaternion The quaternion to multiply with.
+     * @param quaternion - The quaternion to multiply with.
      * @returns This instance.
      */
     multiplyR(quaternion) {
@@ -223,9 +223,9 @@ export class Quaternion extends Vector4 {
     /**
      * Performs spherical linear interpolation between two rotations, and sets this
      * quaternion to the resulting rotation.
-     * @param q1 The initial rotation.
-     * @param q2 The target rotation.
-     * @param t The location on the scale from `0` to `1`.
+     * @param q1 - The initial rotation.
+     * @param q2 - The target rotation.
+     * @param t - The location on the scale from `0` to `1`.
      * @returns This instance.
      */
     slerp(q1, q2, t) {

package/{lib/math → math}/transformation.d.ts

@@ -19,9 +19,9 @@ export declare class Transformation {
     scale: Vector3;
     /**
      * Construct a new {@linkcode Transformation}.
-     * @param rotation The rotation to apply through the transformation.
-     * @param position The position to apply through the transformation.
-     * @param scale The scale to apply through the transformation.
+     * @param rotation - The rotation to apply through the transformation.
+     * @param position - The position to apply through the transformation.
+     * @param scale - The scale to apply through the transformation.
      */
     constructor(rotation: Readonly<Matrix3>, position: Readonly<Vector3>, scale: Readonly<Vector3>);
 }

package/{lib/math → math}/transformation.js

@@ -19,9 +19,9 @@ export class Transformation {
     scale;
     /**
      * Construct a new {@linkcode Transformation}.
-     * @param rotation The rotation to apply through the transformation.
-     * @param position The position to apply through the transformation.
-     * @param scale The scale to apply through the transformation.
+     * @param rotation - The rotation to apply through the transformation.
+     * @param position - The position to apply through the transformation.
+     * @param scale - The scale to apply through the transformation.
      */
     constructor(rotation, position, scale) {
         this.rotation = Matrix3.fromMatrix3(rotation);