@oliversalzburg/js-utils 0.0.7 → 0.0.9

package/lib/math/vector2.d.ts

@@ -0,0 +1,195 @@
+/**
+ * A vector with 2 components, labeled: `X`, `Y`.
+ * @group Math
+ */
+export declare class Vector2 {
+    /**
+     * The X component of the vector.
+     */
+    x: number;
+    /**
+     * The Y component of the vector.
+     */
+    y: number;
+    /**
+     * Constructs a new {@linkcode Vector2}.
+     * @param x The X component.
+     * @param y The Y component.
+     */
+    constructor(x: number, y: number);
+    /**
+     * Sets the vector to new coordinates.
+     * @param vector The coordinates to set the vector to.
+     * @returns This instance.
+     */
+    set(vector: Vector2): this;
+    /**
+     * Sets the vector to new coordinates.
+     * @param x The new X component for the vector.
+     * @param y The new Y component for the vector.
+     * @returns This instance.
+     */
+    setXY(x: number, y: number): this;
+    /**
+     * Adds another vector to this vector.
+     * @param vector The vector to add to this vector.
+     * @returns This instance.
+     */
+    add(vector: Vector2): this;
+    /**
+     * Adds another vector to this vector.
+     * @param x The value to add to the X component.
+     * @param y The value to add to the Y component.
+     * @returns This instance.
+     */
+    addXY(x: number, y: number): this;
+    /**
+     * Scales another vector and adds it to this vector.
+     * @param vector The vector to add to this vector.
+     * @param scale The scaling to apply to the input vector.
+     * @returns This instance.
+     */
+    addMultiply(vector: Vector2, scale: number): this;
+    /**
+     * Scales another vector and adds it to this vector.
+     * @param x The value to add to the X component.
+     * @param y The value to add to the Y component.
+     * @param scale The scaling to apply to the input vector.
+     * @returns This instance.
+     */
+    addMultiplyXY(x: number, y: number, scale: number): this;
+    /**
+     * Subtracts another vector to this vector.
+     * @param vector The vector to subtract from this vector.
+     * @returns This instance.
+     */
+    subtract(vector: Vector2): this;
+    /**
+     * Subtracts another vector to this vector.
+     * @param x The value to subtract from the X component.
+     * @param y The value to subtract from the Y component.
+     * @returns This instance.
+     */
+    subtractXY(x: number, y: number): this;
+    /**
+     * Multiplies this vector by another vector.
+     * @param vector The vector to multiply with this vector.
+     * @returns This instance.
+     */
+    multiply(vector: Vector2): this;
+    /**
+     * Multiplies this vector by another vector.
+     * @param x The value to multiply with the X component.
+     * @param y The value to multiply with the Y component.
+     * @returns This instance.
+     */
+    multiplyXY(x: number, y: number): this;
+    /**
+     * Multiplies the vector by the given scale.
+     * @param scale The scaling to apply to the vector.
+     * @returns This instance.
+     */
+    multiplyScale(scale: number): this;
+    /**
+     * Divides this vector by another vector.
+     * @param vector The vector to divide this vector with.
+     * @returns This instance.
+     */
+    divide(vector: Vector2): this;
+    /**
+     * Divides this vector by another vector.
+     * @param x The value to divide the X component with.
+     * @param y The value to divide the Y component with.
+     * @returns This instance.
+     */
+    divideXY(x: number, y: number): this;
+    /**
+     * Divides the vector by the given scale.
+     * @param scale The scaling to apply to the vector.
+     * @returns This instance.
+     */
+    divideScale(scale: number): this;
+    /**
+     * Inverts the vector.
+     * @returns This instance.
+     */
+    invertAdd(): this;
+    /**
+     * Inverts the vectors scale.
+     * @returns This instance.
+     */
+    invertMultiply(): this;
+    /**
+     * Clamps the components of the vector at the given boundary.
+     * @param floor The lowest value to allow.
+     * @param ceil The largest value to allow.
+     * @returns This instance.
+     */
+    clamp(floor: number, ceil: number): this;
+    /**
+     * Calculates the length of the vector.
+     * @returns The length of the vector.
+     */
+    length(): number;
+    /**
+     * Normalizes the vector.
+     * @returns This instance.
+     */
+    normalize(): this;
+    /**
+     * Compares two vectors.
+     * @param vector The vector to compare this vector to.
+     * @returns `true` if the vectors are idently, `false` otherwise.
+     */
+    compare(vector: Readonly<Vector2>): boolean;
+    /**
+     * Linearly moves this vector towards a target vector.
+     * @param vector The target vector.
+     * @param t The location on the scale, from `0` to `1`.
+     * @returns This instance.
+     */
+    lerp(vector: Readonly<Vector2>, t: number): this;
+    /**
+     * Rotates the vector by the given angle.
+     * @param angle The angle in degrees.
+     * @returns This instance.
+     */
+    rotate(angle: number): this;
+    /**
+     * Returns the dot product between two vectors.
+     * @param vector The other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dot(vector: Vector2): number;
+    /**
+     * Returns the dot product between two vectors.
+     * @param x The X component of the other vector.
+     * @param y The Y component of the other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dotXY(x: number, y: number): number;
+}
+/**
+ * Adds two vectors and returns a new vector with the result.
+ * @param a The first input vector.
+ * @param b The second input vector.
+ * @returns A new {@linkcode Vector2}.
+ * @group Math
+ */
+export declare const addVector2: (a: Vector2, b: Vector2) => Vector2;
+/**
+ * Multiplies two vectors and returns a new vector with the result.
+ * @param a The first input vector.
+ * @param b The second input vector.
+ * @returns A new {@linkcode Vector2}.
+ * @group Math
+ */
+export declare const multiplyVector2: (a: Vector2, b: Vector2) => Vector2;
+/**
+ * Subtracts two vectors and returns a new vector with the result.
+ * @param a The first input vector.
+ * @param b The second input vector.
+ * @returns A new {@linkcode Vector2}.
+ * @group Math
+ */
+export declare const subtractVector2: (a: Vector2, b: Vector2) => Vector2;

package/lib/math/vector2.js

@@ -0,0 +1,299 @@
+/**
+ * A vector with 2 components, labeled: `X`, `Y`.
+ * @group Math
+ */
+export class Vector2 {
+    /**
+     * The X component of the vector.
+     */
+    x;
+    /**
+     * The Y component of the vector.
+     */
+    y;
+    /**
+     * Constructs a new {@linkcode Vector2}.
+     * @param x The X component.
+     * @param y The Y component.
+     */
+    constructor(x, y) {
+        this.x = x;
+        this.y = y;
+    }
+    /**
+     * Sets the vector to new coordinates.
+     * @param vector The coordinates to set the vector to.
+     * @returns This instance.
+     */
+    set(vector) {
+        return this.setXY(vector.x, vector.y);
+    }
+    /**
+     * Sets the vector to new coordinates.
+     * @param x The new X component for the vector.
+     * @param y The new Y component for the vector.
+     * @returns This instance.
+     */
+    setXY(x, y) {
+        this.x = x;
+        this.y = y;
+        return this;
+    }
+    /**
+     * Adds another vector to this vector.
+     * @param vector The vector to add to this vector.
+     * @returns This instance.
+     */
+    add(vector) {
+        return this.addXY(vector.x, vector.y);
+    }
+    /**
+     * Adds another vector to this vector.
+     * @param x The value to add to the X component.
+     * @param y The value to add to the Y component.
+     * @returns This instance.
+     */
+    addXY(x, y) {
+        this.x += x;
+        this.y += y;
+        return this;
+    }
+    /**
+     * Scales another vector and adds it to this vector.
+     * @param vector The vector to add to this vector.
+     * @param scale The scaling to apply to the input vector.
+     * @returns This instance.
+     */
+    addMultiply(vector, scale) {
+        return this.addMultiplyXY(vector.x, vector.y, scale);
+    }
+    /**
+     * Scales another vector and adds it to this vector.
+     * @param x The value to add to the X component.
+     * @param y The value to add to the Y component.
+     * @param scale The scaling to apply to the input vector.
+     * @returns This instance.
+     */
+    addMultiplyXY(x, y, scale) {
+        this.x += x * scale;
+        this.y += y * scale;
+        return this;
+    }
+    /**
+     * Subtracts another vector to this vector.
+     * @param vector The vector to subtract from this vector.
+     * @returns This instance.
+     */
+    subtract(vector) {
+        return this.subtractXY(vector.x, vector.y);
+    }
+    /**
+     * Subtracts another vector to this vector.
+     * @param x The value to subtract from the X component.
+     * @param y The value to subtract from the Y component.
+     * @returns This instance.
+     */
+    subtractXY(x, y) {
+        this.x -= x;
+        this.y -= y;
+        return this;
+    }
+    /**
+     * Multiplies this vector by another vector.
+     * @param vector The vector to multiply with this vector.
+     * @returns This instance.
+     */
+    multiply(vector) {
+        return this.multiplyXY(vector.x, vector.y);
+    }
+    /**
+     * Multiplies this vector by another vector.
+     * @param x The value to multiply with the X component.
+     * @param y The value to multiply with the Y component.
+     * @returns This instance.
+     */
+    multiplyXY(x, y) {
+        this.x *= x;
+        this.y *= y;
+        return this;
+    }
+    /**
+     * Multiplies the vector by the given scale.
+     * @param scale The scaling to apply to the vector.
+     * @returns This instance.
+     */
+    multiplyScale(scale) {
+        this.x *= scale;
+        this.y *= scale;
+        return this;
+    }
+    /**
+     * Divides this vector by another vector.
+     * @param vector The vector to divide this vector with.
+     * @returns This instance.
+     */
+    divide(vector) {
+        return this.divideXY(vector.x, vector.y);
+    }
+    /**
+     * Divides this vector by another vector.
+     * @param x The value to divide the X component with.
+     * @param y The value to divide the Y component with.
+     * @returns This instance.
+     */
+    divideXY(x, y) {
+        this.x /= x;
+        this.y /= y;
+        return this;
+    }
+    /**
+     * Divides the vector by the given scale.
+     * @param scale The scaling to apply to the vector.
+     * @returns This instance.
+     */
+    divideScale(scale) {
+        this.x /= scale;
+        this.y /= scale;
+        return this;
+    }
+    /**
+     * Inverts the vector.
+     * @returns This instance.
+     */
+    invertAdd() {
+        this.x = -this.x;
+        this.y = -this.y;
+        return this;
+    }
+    /**
+     * Inverts the vectors scale.
+     * @returns This instance.
+     */
+    invertMultiply() {
+        this.x = 1 / this.x;
+        this.y = 1 / this.y;
+        return this;
+    }
+    /**
+     * Clamps the components of the vector at the given boundary.
+     * @param floor The lowest value to allow.
+     * @param ceil The largest value to allow.
+     * @returns This instance.
+     */
+    clamp(floor, ceil) {
+        if (this.x < floor) {
+            this.x = floor;
+        }
+        if (this.x > ceil) {
+            this.x = ceil;
+        }
+        if (this.y < floor) {
+            this.y = floor;
+        }
+        if (this.y > ceil) {
+            this.y = ceil;
+        }
+        return this;
+    }
+    /**
+     * Calculates the length of the vector.
+     * @returns The length of the vector.
+     */
+    length() {
+        return Math.sqrt(this.x * this.x + this.y * this.y);
+    }
+    /**
+     * Normalizes the vector.
+     * @returns This instance.
+     */
+    normalize() {
+        const length = this.length();
+        if (length === 0) {
+            return this;
+        }
+        this.x /= length;
+        this.y /= length;
+        return this;
+    }
+    /**
+     * Compares two vectors.
+     * @param vector The vector to compare this vector to.
+     * @returns `true` if the vectors are idently, `false` otherwise.
+     */
+    compare(vector) {
+        return vector.x === this.x && vector.y === this.y;
+    }
+    /**
+     * Linearly moves this vector towards a target vector.
+     * @param vector The target vector.
+     * @param t The location on the scale, from `0` to `1`.
+     * @returns This instance.
+     */
+    lerp(vector, t) {
+        const tn = 1.0 - t;
+        this.x = this.x * tn + vector.x * t;
+        this.y = this.y * tn + vector.y * t;
+        return this;
+    }
+    /**
+     * Rotates the vector by the given angle.
+     * @param angle The angle in degrees.
+     * @returns This instance.
+     */
+    rotate(angle) {
+        angle = -angle * (Math.PI / 180);
+        const cos = Math.cos(angle);
+        const sin = Math.sin(angle);
+        this.x = this.x * cos - this.y * sin;
+        this.y = this.x * sin + this.y * cos;
+        return this;
+    }
+    /**
+     * Returns the dot product between two vectors.
+     * @param vector The other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dot(vector) {
+        return this.dotXY(vector.x, vector.y);
+    }
+    /**
+     * Returns the dot product between two vectors.
+     * @param x The X component of the other vector.
+     * @param y The Y component of the other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dotXY(x, y) {
+        return this.x * x + this.y * y;
+    }
+}
+/**
+ * Adds two vectors and returns a new vector with the result.
+ * @param a The first input vector.
+ * @param b The second input vector.
+ * @returns A new {@linkcode Vector2}.
+ * @group Math
+ */
+export const addVector2 = (a, b) => {
+    return new Vector2(a.x * b.x, a.y * b.y);
+};
+/**
+ * Multiplies two vectors and returns a new vector with the result.
+ * @param a The first input vector.
+ * @param b The second input vector.
+ * @returns A new {@linkcode Vector2}.
+ * @group Math
+ */
+export const multiplyVector2 = (a, b) => {
+    return new Vector2(a.x * b.x, a.y * b.y);
+};
+/**
+ * Subtracts two vectors and returns a new vector with the result.
+ * @param a The first input vector.
+ * @param b The second input vector.
+ * @returns A new {@linkcode Vector2}.
+ * @group Math
+ */
+export const subtractVector2 = (a, b) => {
+    return new Vector2(a.x - b.x, a.y - b.y);
+};
+//# sourceMappingURL=vector2.js.map

package/lib/math/vector2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector2.js","sourceRoot":"","sources":["../../source/math/vector2.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,OAAO;IAClB;;OAEG;IACH,CAAC,CAAS;IAEV;;OAEG;IACH,CAAC,CAAS;IAEV;;;;OAIG;IACH,YAAY,CAAS,EAAE,CAAS;QAC9B,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,MAAe;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,CAAS,EAAE,CAAS;QACxB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,MAAe;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,CAAS,EAAE,CAAS;QACxB,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,MAAe,EAAE,KAAa;QACxC,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,CAAS,EAAE,CAAS,EAAE,KAAa;QAC/C,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAe;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,CAAS,EAAE,CAAS;QAC7B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,MAAe;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,CAAS,EAAE,CAAS;QAC7B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAa;QACzB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC;QAChB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAe;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,CAAS,EAAE,CAAS;QAC3B,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,KAAa;QACvB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC;QAChB,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACjB,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAa,EAAE,IAAY;QAC/B,IAAI,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE;YAClB,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC;SAChB;QACD,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE;YACjB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;SACf;QACD,IAAI,IAAI,CAAC,CAAC,GAAG,KAAK,EAAE;YAClB,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC;SAChB;QACD,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE;YACjB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;SACf;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAE7B,IAAI,MAAM,KAAK,CAAC,EAAE;YAChB,OAAO,IAAI,CAAC;SACb;QAED,IAAI,CAAC,CAAC,IAAI,MAAM,CAAC;QACjB,IAAI,CAAC,CAAC,IAAI,MAAM,CAAC;QAEjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,MAAyB;QAC/B,OAAO,MAAM,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,MAAyB,EAAE,CAAS;QACvC,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAa;QAClB,KAAK,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC5B,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QACrC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,MAAe;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,CAAS,EAAE,CAAS;QACxB,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE;IAC5D,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE;IACjE,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE;IACjE,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC"}

package/lib/math/vector3.d.ts

@@ -0,0 +1,46 @@
+/**
+ * A vector with 3 components, labeled: `X`, `Y`, `Z`.
+ * @group Math
+ */
+export declare class Vector3 {
+    /**
+     * The X component of the vector.
+     */
+    x: number;
+    /**
+     * The Y component of the vector.
+     */
+    y: number;
+    /**
+     * The Z component of the vector.
+     */
+    z: number;
+    /**
+     * Constructs a new {@linkcode Vector3}.
+     * @param x The X component.
+     * @param y The Y component.
+     * @param z The Z component.
+     */
+    constructor(x: number, y: number, z: number);
+    /**
+     * Sets the vector to new coordinates.
+     * @param x The new X component for the vector.
+     * @param y The new Y component for the vector.
+     * @param z The new Z component for the vector.
+     */
+    setXYZ(x: number, y: number, z: number): void;
+    /**
+     * Returns the dot product between two vectors.
+     * @param vector The other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dot(vector: Vector3): number;
+    /**
+     * Returns the dot product between two vectors.
+     * @param x The X component of the other vector.
+     * @param y The Y component of the other vector.
+     * @param z The Z component of the other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dotXYZ(x: number, y: number, z: number): number;
+}

package/lib/math/vector3.js

@@ -0,0 +1,59 @@
+/**
+ * A vector with 3 components, labeled: `X`, `Y`, `Z`.
+ * @group Math
+ */
+export class Vector3 {
+    /**
+     * The X component of the vector.
+     */
+    x;
+    /**
+     * The Y component of the vector.
+     */
+    y;
+    /**
+     * The Z component of the vector.
+     */
+    z;
+    /**
+     * Constructs a new {@linkcode Vector3}.
+     * @param x The X component.
+     * @param y The Y component.
+     * @param z The Z component.
+     */
+    constructor(x, y, z) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+    }
+    /**
+     * Sets the vector to new coordinates.
+     * @param x The new X component for the vector.
+     * @param y The new Y component for the vector.
+     * @param z The new Z component for the vector.
+     */
+    setXYZ(x, y, z) {
+        this.x = x;
+        this.y = y;
+        this.z = z;
+    }
+    /**
+     * Returns the dot product between two vectors.
+     * @param vector The other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dot(vector) {
+        return this.dotXYZ(vector.x, vector.y, vector.z);
+    }
+    /**
+     * Returns the dot product between two vectors.
+     * @param x The X component of the other vector.
+     * @param y The Y component of the other vector.
+     * @param z The Z component of the other vector.
+     * @returns The dot product between the two vectors.
+     */
+    dotXYZ(x, y, z) {
+        return this.x * x + this.y * y + this.z * z;
+    }
+}
+//# sourceMappingURL=vector3.js.map

package/lib/math/vector3.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vector3.js","sourceRoot":"","sources":["../../source/math/vector3.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,OAAO;IAClB;;OAEG;IACH,CAAC,CAAS;IAEV;;OAEG;IACH,CAAC,CAAS;IAEV;;OAEG;IACH,CAAC,CAAS;IAEV;;;;;OAKG;IACH,YAAY,CAAS,EAAE,CAAS,EAAE,CAAS;QACzC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS;QACpC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,MAAe;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS;QACpC,OAAO,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;CACF"}

package/lib/nil.d.ts

@@ -26,6 +26,7 @@ export declare function isNil<T>(subject: Maybe<T>): subject is Nil;
 export declare function is<T>(nilable: Maybe<T>, InstanceType: ConstructorOf<T>): nilable is T;
 /**
  * Thrown when an unexpected nil value was encountered.
+ * @group Errors
  */
 export declare class UnexpectedNilError extends Error {
     /**

package/lib/nil.js

@@ -20,6 +20,7 @@ export function is(nilable, InstanceType) {
 }
 /**
  * Thrown when an unexpected nil value was encountered.
+ * @group Errors
  */
 export class UnexpectedNilError extends Error {
     /**

package/lib/nil.js.map

@@ -1 +1 @@
-{"version":3,"file":"nil.js","sourceRoot":"","sources":["../source/nil.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAI,OAAiB;IACxC,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,EAAE,CAAI,OAAiB,EAAE,YAA8B;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,YAAY,CAAC;AAC5D,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;;;OAGG;IACH,YAAY,OAAO,GAAG,sBAAsB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAI,OAAiB,EAAE,YAAqB;IACnE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,CAAC,YAAY,CAAC,CAAC;KAC5C;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"nil.js","sourceRoot":"","sources":["../source/nil.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,MAAM,UAAU,KAAK,CAAI,OAAiB;IACxC,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,CAAC;AACnD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,EAAE,CAAI,OAAiB,EAAE,YAA8B;IACrE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,YAAY,YAAY,CAAC;AAC5D,CAAC;AAED;;;GAGG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAC3C;;;OAGG;IACH,YAAY,OAAO,GAAG,sBAAsB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAI,OAAiB,EAAE,YAAqB;IACnE,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,kBAAkB,CAAC,YAAY,CAAC,CAAC;KAC5C;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}