@vived/core 1.2.2 → 1.2.4

package/src/ValueObjects/Vector2.ts

@@ -1,209 +0,0 @@
-import { Angle } from ".";
-
-export class Vector2 {
-  /**
-   * Creates a zero vector
-   * @returns Vector [0,0]
-   */
-  public static Zero(): Vector2 {
-    return new Vector2(0, 0);
-  }
-
-  /**
-   * Creates a one vector
-   * @returns Vector [1,1]
-   */
-  public static One(): Vector2 {
-    return new Vector2(1, 1);
-  }
-
-  /**
-   * Checks to see if Vector A equals Vector B
-   * @param a Vector A
-   * @param b Vector B
-   * @returns True if Vector A === Vector B
-   */
-  public static Equal(a: Vector2, b: Vector2): boolean {
-    if (a.x !== b.x) return false;
-    if (a.y !== b.y) return false;
-    return true;
-  }
-
-  /**
-   * Creates a Vector from a Data Transfer Object
-   * @param dto The Data Transfer Object
-   * @returns The Vector
-   */
-  public static FromDTO(dto: { x: number; y: number }): Vector2 {
-    return new Vector2(dto.x, dto.y);
-  }
-
-  /**
-   * Adds Vector B to Vector A
-   * @param a Vector A
-   * @param b Vector B
-   * @returns A + B
-   */
-  public static Add(a: Vector2, b: Vector2): Vector2 {
-    return new Vector2(a.x + b.x, a.y + b.y);
-  }
-
-  /**
-   * Subtracts Vector B from Vector A
-   * @param a Vector A
-   * @param b Vector B
-   * @returns A - B
-   */
-  public static Subtract(a: Vector2, b: Vector2): Vector2 {
-    return new Vector2(a.x - b.x, a.y - b.y);
-  }
-
-  /**
-   * Checks to see if Vector A is close to Vector B
-   * @param a Vector A
-   * @param b Vector B
-   * @param threshold Tolerance to define "close". Defaults to 0.01
-   * @returns True if A and B are close enough
-   */
-  public static Close = (
-    a: Vector2,
-    b: Vector2,
-    threshold: number = 0.01
-  ): boolean => {
-    const diff = Vector2.Subtract(a, b);
-    const diffMag = diff.magnitued;
-
-    if (diffMag < threshold) return true;
-    else return false;
-  };
-
-  /**
-   * Rotates a vector by an angle
-   * @param vec The original vector
-   * @param angle The angle
-   * @returns A new Vector that has been rotated from the original by an angle
-   */
-  public static Rotate = (vec: Vector2, angle: Angle): Vector2 => {
-    const x = vec.x * Math.cos(angle.radians) - vec.y * Math.sin(angle.radians);
-    const y = vec.x * Math.sin(angle.radians) + vec.y * Math.cos(angle.radians);
-    return new Vector2(x, y);
-  };
-
-  /**
-   * Scales a vector uniformly
-   * @param vector The original vector
-   * @param scale Scale factor
-   * @returns A new, scaled vector
-   */
-  public static Scale = (vector: Vector2, scale: number): Vector2 => {
-    const x = scale * vector.x;
-    const y = scale * vector.y;
-    return new Vector2(x, y);
-  };
-
-  /**
-   * Creates a new vector of a given lenght and a unit that is equal to the original vector
-   * @param vector The original vector. This determines the unit of the final vector
-   * @param length The desired length of the final vector
-   * @returns The final vector
-   */
-  public static NewVectorOfLength = (
-    vector: Vector2,
-    length: number
-  ): Vector2 => {
-    const unit = vector.unit;
-    const x = length * unit.x;
-    const y = length * unit.y;
-    return new Vector2(x, y);
-  };
-
-  /**
-   * Calculate the dot product between Vectors A and B
-   * @param a Vector A
-   * @param b Vector B
-   * @returns The Dot product between A and B
-   */
-  public static Dot = (a: Vector2, b: Vector2): number => {
-    return a.x * b.x + a.y * b.y;
-  };
-
-  /**
-   * Calculates the dot product between Vectors A and B
-   * @param a Vector A
-   * @param b Vector B
-   * @returns A . B
-   */
-  public static AngleBetween = (a: Vector2, b: Vector2): Angle => {
-    const dot = Vector2.Dot(a, b);
-    const magnitues = a.magnitued * b.magnitued;
-
-    const angRadians = Math.acos(dot / magnitues);
-
-    return Angle.FromRadians(angRadians);
-  };
-
-  /**
-   * Calculates the Cross product between Vectors A and B
-   * @param a Vector A
-   * @param b Vector B
-   * @returns A X B
-   */
-  public static Cross = (a: Vector2, b: Vector2): number => {
-    return a.x * b.y - a.y * b.x;
-  };
-
-  readonly x: number;
-  readonly y: number;
-
-  /**
-   * Get the magnitude (length) of the vector
-   */
-  get magnitued(): number {
-    const xSqr = this.x * this.x;
-    const ySqr = this.y * this.y;
-
-    const magnitude = Math.sqrt(xSqr + ySqr);
-    return magnitude;
-  }
-
-  /**
-   * Get the unit vector
-   */
-  get unit(): Vector2 {
-    const mag = this.magnitued;
-    if (mag === 0) {
-      return Vector2.Zero();
-    }
-
-    const unitX = this.x / mag;
-    const unitY = this.y / mag;
-    return new Vector2(unitX, unitY);
-  }
-
-  /**
-   * Returns the angle of the direction of this angle in degrees.
-   * A right vector [1,0] will return 0, a left vector [-1,0] will return 180, an up vector [0,1] will return 90 and a down vector [0,-1] will return -90
-   */
-  get theta(): number {
-    return (Math.atan2(this.y, this.x) * 180) / Math.PI;
-  }
-
-  /**
-   * Retuns the vector as an array of numbers [x,y]
-   */
-  get array(): [number, number] {
-    return [this.x, this.y];
-  }
-
-  /**
-   * Get the vector as a Data Transfer Object
-   */
-  get dto(): { x: number; y: number } {
-    return { x: this.x, y: this.y };
-  }
-
-  constructor(x: number, y: number) {
-    this.x = x;
-    this.y = y;
-  }
-}

package/src/ValueObjects/Vector3.test.ts

@@ -1,228 +0,0 @@
-import { Vector3 } from ".";
-import { Angle } from "./Angle";
-import { Matrix } from "./Matrix";
-import { Quaternion } from "./Quaternion";
-
-describe("Vector 3 Value object - Creation", () => {
-  it("Creates a zero vector", () => {
-    const v = Vector3.Zero();
-    expect(v).toEqual(new Vector3(0, 0, 0));
-  });
-  it("Creates a one vector", () => {
-    const v = Vector3.One();
-    expect(v).toEqual(new Vector3(1, 1, 1));
-  });
-
-  it("Creates a vector from an array", () => {
-    const v = Vector3.FromArray([2, 5, 7]);
-    expect(v).toEqual(new Vector3(2, 5, 7));
-  });
-
-  it("Creates a unit right vector", () => {
-    const v = Vector3.Right();
-    expect(v).toEqual(new Vector3(1, 0, 0));
-  });
-
-  it("Creates a right vector with length", () => {
-    const v = Vector3.Right(3);
-    expect(v).toEqual(new Vector3(3, 0, 0));
-  });
-
-  it("Creates a unit left vector", () => {
-    const v = Vector3.Left();
-    expect(v).toEqual(new Vector3(-1, 0, 0));
-  });
-
-  it("Creates a left vector with length", () => {
-    const v = Vector3.Left(3);
-    expect(v).toEqual(new Vector3(-3, 0, 0));
-  });
-
-  it("Creates a unit up vector", () => {
-    const v = Vector3.Up();
-    expect(v).toEqual(new Vector3(0, 1, 0));
-  });
-
-  it("Creates a up vector with length", () => {
-    const v = Vector3.Up(3);
-    expect(v).toEqual(new Vector3(0, 3, 0));
-  });
-
-  it("Creates a unit down vector", () => {
-    const v = Vector3.Down();
-    expect(v).toEqual(new Vector3(0, -1, 0));
-  });
-
-  it("Creates a down vector with length", () => {
-    const v = Vector3.Down(3);
-    expect(v).toEqual(new Vector3(0, -3, 0));
-  });
-
-  it("Creates a unit forward vector", () => {
-    const v = Vector3.Forward();
-    expect(v).toEqual(new Vector3(0, 0, 1));
-  });
-
-  it("Creates a forward vector with length", () => {
-    const v = Vector3.Forward(3);
-    expect(v).toEqual(new Vector3(0, 0, 3));
-  });
-
-  it("Creates a unit backward vector", () => {
-    const v = Vector3.Backward();
-    expect(v).toEqual(new Vector3(0, 0, -1));
-  });
-
-  it("Creates a backward vector with length", () => {
-    const v = Vector3.Backward(3);
-    expect(v).toEqual(new Vector3(0, 0, -3));
-  });
-});
-
-describe("Vector 3 Value object - Static actions", () => {
-  it("Adds two vectors", () => {
-    const v1 = new Vector3(1, 2, 3);
-    const v2 = new Vector3(4, 5, 6);
-
-    const v3 = Vector3.Add(v1, v2);
-    expect(v3).toEqual(new Vector3(5, 7, 9));
-  });
-
-  test("Subtracts two vectors", () => {
-    const v1 = new Vector3(1, 2, 3);
-    const v2 = new Vector3(6, 5, 4);
-
-    const v3 = Vector3.Subtract(v1, v2);
-    expect(v3).toEqual(new Vector3(-5, -3, -1));
-  });
-
-  test("Checks if two vectors are equal", () => {
-    const v1 = new Vector3(1, 2, 3);
-    const v2 = new Vector3(4, 5, 6);
-    const v3 = new Vector3(1, 2, 3);
-    expect(Vector3.Equal(v1, v2)).toEqual(false);
-    expect(Vector3.Equal(v1, v3)).toEqual(true);
-  });
-
-  it("Checks if Vectors are close without a tolerance", () => {
-    const v1 = new Vector3(1, 2, 3);
-    const v2 = new Vector3(1.1, 2.2, 3.3);
-    const v3 = new Vector3(1.001, 2.001, 3.001);
-    expect(Vector3.Close(v1, v2)).toEqual(false);
-    expect(Vector3.Close(v1, v3)).toEqual(true);
-  });
-
-  it("Checks if Vectors are close with a tolerance", () => {
-    const v1 = new Vector3(1, 2, 3);
-    const v2 = new Vector3(1.1, 2.2, 3.3);
-    expect(Vector3.Close(v1, v2, 0.3)).toEqual(false);
-    expect(Vector3.Close(v1, v2, 0.4)).toEqual(true);
-  });
-
-  it("Computes the cross product", () => {
-    // From https://www.symbolab.com/solver/vector-cross-product-calculator
-    const v1 = new Vector3(1, 2, 3);
-    const v2 = new Vector3(4, 5, -6);
-
-    const cross = Vector3.Cross(v1, v2);
-    expect(cross).toEqual(new Vector3(-27, 18, -3));
-  });
-
-  test("Cross product", () => {
-    // From https://www.symbolab.com/solver/vector-cross-product-calculator
-    const v1 = new Vector3(1, 2, 3);
-    const v2 = new Vector3(4, 5, -6);
-
-    const cross = Vector3.Cross(v2, v1);
-    expect(cross).toEqual(new Vector3(27, -18, 3));
-  });
-
-  test("Dot product", () => {
-    // From https://www.calculatorsoup.com/calculators/algebra/dot-product-calculator.php
-    const v1 = new Vector3(1, 5, 3);
-    const v2 = new Vector3(2, 3, 6);
-
-    const dot = Vector3.Dot(v1, v2);
-    expect(dot).toEqual(35);
-  });
-
-  test("New vector of length", () => {
-    const v1 = new Vector3(1, -5, 3);
-    const v2 = Vector3.NewVectorOfLength(v1, 10);
-
-    expect(v2.x).toBeCloseTo(1.69);
-    expect(v2.y).toBeCloseTo(-8.45);
-    expect(v2.z).toBeCloseTo(5.07);
-  });
-});
-
-describe("Vector 3 Value object - parameters", () => {
-  it("Gets the vector components", () => {
-    const v = new Vector3(2, 5, 7);
-    expect(v.x).toEqual(2);
-    expect(v.y).toEqual(5);
-    expect(v.z).toEqual(7);
-  });
-
-  it("Gets the magnitue", () => {
-    // https://www.omnicalculator.com/math/unit-vector
-    const v1 = new Vector3(1, -5, 3);
-    expect(v1.magnitude).toBeCloseTo(5.916);
-  });
-
-  it("Gets the unit vector", () => {
-    // https://www.omnicalculator.com/math/unit-vector
-    const v1 = new Vector3(1, -5, 3);
-
-    expect(v1.unit.x).toBeCloseTo(0.169);
-    expect(v1.unit.y).toBeCloseTo(-0.845);
-    expect(v1.unit.z).toBeCloseTo(0.507);
-  });
-
-  it("Gets the vector as an array", () => {
-    const v1 = new Vector3(1, -5, 3);
-    expect(v1.array).toEqual([1, -5, 3]);
-  });
-
-  it("Lerps", () => {
-    const start = new Vector3(10, 20, 30);
-    const end = new Vector3(20, 30, 40);
-    const lerped = Vector3.Lerp(start, end, 0.5);
-
-    expect(lerped).toEqual(new Vector3(15, 25, 35));
-  });
-
-  it("Transforms a Vector with a matrix", () => {
-    const pos = new Vector3(5, 0, 0);
-    const rot = Quaternion.FromAngleAxis(Vector3.Up(), Angle.FromDegrees(-90));
-    const scale = new Vector3(2, 2, 2);
-    const matrix = Matrix.Compose(scale, rot, pos);
-
-    const transformed = Vector3.Transform(new Vector3(2, 1, -1), matrix);
-    const expected = new Vector3(7, 2, 4);
-
-    expect(Vector3.Close(transformed, expected)).toEqual(true);
-  });
-
-  it("Gets the Data Transfer Object", () => {
-    const vec = new Vector3(1, 2, 3);
-
-    expect(vec.dto).toEqual({
-      x: 1,
-      y: 2,
-      z: 3,
-    });
-  });
-
-  it("Makes a vector from a DTO", () => {
-    const vec = Vector3.FromDTO({
-      x: 1,
-      y: 2,
-      z: 3,
-    });
-
-    expect(vec.x).toEqual(1);
-    expect(vec.y).toEqual(2);
-    expect(vec.z).toEqual(3);
-  });
-});

package/src/ValueObjects/Vector3.ts

@@ -1,269 +0,0 @@
-import { Matrix } from "./Matrix";
-
-export interface Vector3DTO {
-  x: number;
-  y: number;
-  z: number;
-}
-
-export class Vector3 {
-  /**
-   * Creates a zero vector
-   * @returns Vector [0,0,0]
-   */
-  public static Zero() {
-    return new Vector3(0, 0, 0);
-  }
-
-  /**
-   * Creates a vector of ones
-   * @returns Vector [1,1,1]
-   */
-  public static One() {
-    return new Vector3(1, 1, 1);
-  }
-
-  /**
-   * Creates a Right vector (positive X)
-   * @param length optional length of the right unit. Default is 1
-   * @returns Vector [length, 0,0]
-   */
-  public static Right(length = 1) {
-    return new Vector3(length, 0, 0);
-  }
-
-  /**
-   * Creates a Left vector (negative X)
-   * @param length optional length of the left unit. Default is 1
-   * @returns Vector [-length, 0, 0]
-   */
-  public static Left(length = 1) {
-    return new Vector3(-length, 0, 0);
-  }
-
-  /**
-   * Creates an Up vector (positive Y)
-   * @param length optional length of the vector. Default is 1
-   * @returns Vector [0, length, 0]
-   */
-  public static Up(length = 1) {
-    return new Vector3(0, length, 0);
-  }
-
-  /**
-   * Creates a Down vector (negative Y)
-   * @param length optional length of the vector. Default is 1
-   * @returns Vector [0, -length, 0]
-   */
-  public static Down(length = 1) {
-    return new Vector3(0, -length, 0);
-  }
-
-  /**
-   * Creates a Forward vector (positive Z)
-   * @param length optional length of the vector. Default is 1
-   * @returns Vector [0, 0, length]
-   */
-  public static Forward(length = 1) {
-    return new Vector3(0, 0, length);
-  }
-
-  /**
-   * Creates a Backward vector (negative Z)
-   * @param length optional length of the vector. Default is 1
-   * @returns Vector [0, 0, -length]
-   */
-  public static Backward(length = 1) {
-    return new Vector3(0, 0, -length);
-  }
-
-  /**
-   * Creates a Vector from an array of components
-   * @param values The x, y, z components as an array
-   * @returns The Vector
-   */
-  public static FromArray(values: [number, number, number]): Vector3 {
-    return new Vector3(values[0], values[1], values[2]);
-  }
-
-  /**
-   * Creates a Vector from a Data Transfer Object
-   * @param dto The Data Transfer Object
-   * @returns The Vector
-   */
-  public static FromDTO(dto: Vector3DTO): Vector3 {
-    return new Vector3(dto.x, dto.y, dto.z);
-  }
-
-  /**
-   * Adds Vector B to Vector A
-   * @param a Vector A
-   * @param b Vector B
-   * @return Result of A + B
-   */
-  static Add = (a: Vector3, b: Vector3): Vector3 => {
-    return new Vector3(a.x + b.x, a.y + b.y, a.z + b.z);
-  };
-
-  /**
-   * Subtracts Vector B from Vector A
-   * @param a Vector A
-   * @param b Vector B
-   * @return Result of A - B
-   */
-  static Subtract = (a: Vector3, b: Vector3): Vector3 => {
-    return new Vector3(a.x - b.x, a.y - b.y, a.z - b.z);
-  };
-
-  /**
-   * Checks to see if the two vectors are equal
-   * @param a Vector A
-   * @param b Vector B
-   * @return True if the two vectors are equal, otherwise false
-   */
-  static Equal = (a: Vector3, b: Vector3): boolean => {
-    if (a.x === b.x && a.y === b.y && a.z === b.z) return true;
-    else return false;
-  };
-
-  /**
-   * Checks to see if the two vectors are close
-   * @param a Vector A
-   * @param b Vector B
-   * @param tolerance Tolerance for checking. Defaulted to 0.01
-   * @return True if the distance between the two vectors is less than the tolerance, otherwise false
-   */
-  static Close = (a: Vector3, b: Vector3, tolerance = 0.01): boolean => {
-    const diff = Vector3.Subtract(a, b);
-    const diffMag = diff.magnitude;
-
-    if (diffMag < tolerance) return true;
-    else return false;
-  };
-
-  /**
-   * Calculates the Cross Product between two vectors
-   * @param a Vector A
-   * @param b Vector B
-   * @return the cross product between the two vectors
-   */
-  static Cross = (a: Vector3, b: Vector3): Vector3 => {
-    const x = a.y * b.z - a.z * b.y;
-    const y = a.z * b.x - a.x * b.z;
-    const z = a.x * b.y - a.y * b.x;
-    return new Vector3(x, y, z);
-  };
-
-  /**
-   * Calculates the Dot Product between two vectors
-   * @param a Vector A
-   * @param b Vector B
-   * @return the dot product between the two vectors
-   */
-  static Dot = (a: Vector3, b: Vector3): number => {
-    return a.x * b.x + a.y * b.y + a.z * b.z;
-  };
-
-  /**
-   * Create a new vector that will have the same unit as the original vector but set to the desired length
-   * @param vec The original vector
-   * @param length Desired length of the final vector
-   * @return The resulting vector
-   */
-  static NewVectorOfLength = (vec: Vector3, length: number): Vector3 => {
-    const unit = vec.unit;
-    return new Vector3(length * unit.x, length * unit.y, length * unit.z);
-  };
-
-  static Transform = (vector: Vector3, matrix: Matrix): Vector3 => {
-    const m = matrix.m;
-    const rx = vector.x * m[0] + vector.y * m[4] + vector.z * m[8] + m[12];
-    const ry = vector.x * m[1] + vector.y * m[5] + vector.z * m[9] + m[13];
-    const rz = vector.x * m[2] + vector.y * m[6] + vector.z * m[10] + m[14];
-    const rw =
-      1 / (vector.x * m[3] + vector.y * m[7] + vector.z * m[11] + m[15]);
-
-    const x = rx * rw;
-    const y = ry * rw;
-    const z = rz * rw;
-
-    return new Vector3(x, y, z);
-  };
-
-  /**
-   * Linearly interpolates between two vectors
-   * @param initial The starting point
-   * @param final The end point
-   * @param percent Percent of the lerp. 0 will return initial and 1 will return final
-   * @return the LERP result Vector3
-   */
-  static Lerp = (
-    initial: Vector3,
-    final: Vector3,
-    percent: number
-  ): Vector3 => {
-    const x = Vector3.interpolateNumber(initial.x, final.x, percent);
-    const y = Vector3.interpolateNumber(initial.y, final.y, percent);
-    const z = Vector3.interpolateNumber(initial.z, final.z, percent);
-
-    return new Vector3(x, y, z);
-  };
-
-  private static interpolateNumber(a: number, b: number, percent: number) {
-    return a + (b - a) * percent;
-  }
-
-  readonly x: number;
-  readonly y: number;
-  readonly z: number;
-
-  /**
-   * Gets the magnitude of the Vector3
-   * @returns the magnitude of the Vector3
-   */
-  get magnitude(): number {
-    const xSqr = this.x * this.x;
-    const ySqr = this.y * this.y;
-    const zSqr = this.z * this.z;
-
-    const magnitude = Math.sqrt(xSqr + ySqr + zSqr);
-    return magnitude;
-  }
-
-  /**
-   * Gets the unit vector for this Vector3
-   * @returns the unit vector
-   */
-  get unit(): Vector3 {
-    const mag = this.magnitude;
-    if (mag === 0) {
-      return Vector3.Zero();
-    }
-
-    const unitX = this.x / mag;
-    const unitY = this.y / mag;
-    const unitZ = this.z / mag;
-    return new Vector3(unitX, unitY, unitZ);
-  }
-
-  /**
-   * Gets the vector as an array
-   * @returns an array representing the vector
-   */
-  get array(): [number, number, number] {
-    return [this.x, this.y, this.z];
-  }
-
-  /**
-   * Get the vector as a Data Transfer Object
-   */
-  get dto(): Vector3DTO {
-    return { x: this.x, y: this.y, z: this.z };
-  }
-
-  constructor(x: number, y: number, z: number) {
-    this.x = x;
-    this.y = y;
-    this.z = z;
-  }
-}

package/tsconfig.build.json

@@ -1,7 +0,0 @@
-{
-  "files": [],
-  "references": [
-    { "path": "./tsconfig.esm.json" },
-    { "path": "./tsconfig.cjs.json" }
-  ]
-}