jsketcher/modules/math/vector.ts

import {clamp} from "math/commons";
import {XYZ} from "math/xyz";
import {areEqual, TOLERANCE_SQ} from "math/equality";

export default class Vector implements XYZ {

  x: number;
  y: number;
  z: number;

  constructor(x = 0, y = 0, z = 0) {
    this.x = x || 0;
    this.y = y || 0;
    this.z = z || 0;
  }

  set(x, y, z): Vector {
    this.x = x || 0;
    this.y = y || 0;
    this.z = z || 0;
    return this;
  }

  set3(data: [number, number, number]): Vector {
    this.x = data[0] || 0;
    this.y = data[1] || 0;
    this.z = data[2] || 0;
    return this;
  }

  setV(data: XYZ): Vector {
    this.x = data.x;
    this.y = data.y;
    this.z = data.z;
    return this;
  }

  multiply(scalar: number): Vector {
    return new Vector(this.x * scalar, this.y * scalar, this.z * scalar);
  }

  scale(scalar: number): Vector {
    return this.multiply(scalar);
  }

  _multiply(scalar: number): Vector {
    return this.set(this.x * scalar, this.y * scalar, this.z * scalar);
  }

  _scale(scalar: number): Vector {
    return this._multiply(scalar);
  }

  divide(scalar: number): Vector {
    return new Vector(this.x / scalar, this.y / scalar, this.z / scalar);
  }

  _divide(scalar: number): Vector {
    return this.set(this.x / scalar, this.y / scalar, this.z / scalar);
  }

  dot(vector: XYZ): number {
    return this.x * vector.x + this.y * vector.y + this.z * vector.z;
  }

  copy(): Vector {
    return new Vector(this.x, this.y, this.z);
  }

  length(): number {
    return Math.sqrt(this.x*this.x + this.y*this.y + this.z*this.z);
  };

  lengthSquared(): number {
    return this.dot(this);
  }

  distanceToSquared(a: XYZ): number {
    return this.minus(a).lengthSquared();
  }

  distanceTo(a: XYZ): number {
    return Math.sqrt(this.distanceToSquared(a));
  }

  minus(vector: XYZ): Vector {
    return new Vector(this.x - vector.x, this.y - vector.y, this.z - vector.z);
  }

  _minus(vector: XYZ): Vector {
    this.x -= vector.x;
    this.y -= vector.y;
    this.z -= vector.z;
    return this;
  }

  _minusXYZ(x, y, z): Vector {
    this.x -= x;
    this.y -= y;
    this.z -= z;
    return this;
  }

  plusXYZ(x, y, z): Vector {
    return new Vector(this.x + x, this.y + y, this.z + z);
  }

  plus(vector: XYZ): Vector {
    return new Vector(this.x + vector.x, this.y + vector.y, this.z + vector.z);
  }

  _plus(vector: XYZ): Vector {
    this.x += vector.x;
    this.y += vector.y;
    this.z += vector.z;
    return this;
  }

  normalize(): UnitVector {
    let mag = this.length();
    if (mag === 0.0) {
      return new Vector(0.0, 0.0, 0.0) as UnitVector;
    }
    return new Vector(this.x / mag, this.y / mag, this.z / mag) as UnitVector;
  }

  unit(): UnitVector {
    return this.normalize();
  }

  _normalize(): UnitVector {
    let mag = this.length();
    if (mag === 0.0) {
      return this.set(0, 0, 0) as UnitVector;
    }
    return this.set(this.x / mag, this.y / mag, this.z / mag) as UnitVector;
  };

  _unit(): UnitVector {
    return this._normalize();
  }

  cross(a: XYZ): Vector {
    return this.copy()._cross(a);
  };

  _cross(a: XYZ): Vector {
    return this.set(
      this.y * a.z - this.z * a.y,
      this.z * a.x - this.x * a.z,
      this.x * a.y - this.y * a.x
    );
  };

  negate(): Vector {
    return this.multiply(-1);
  }

  _negate(): Vector {
    return this._multiply(-1);
  }

  _perpXY(): Vector {
    return this.set(-this.y, this.x, this.z);
  }

  toArray(): [number, number, number] {
    return [this.x, this.y, this.z];
  }

  data (): [number, number, number] {
    return this.toArray();
  }

  copyToData(data: [number, number, number]): void {
    data[0] = this.x;
    data[1] = this.y;
    data[2] = this.z;
  }

  angleBetween(vecB: XYZ): number {
    const cosA = clamp(this.dot(vecB), -1, 1);
    const sinA = clamp(this.cross(vecB).length(), -1, 1);
    return Math.atan2(sinA, cosA);
  }

  asUnitVector(): UnitVector {
    if (!areEqual(this.lengthSquared(), 1, TOLERANCE_SQ)) {
      console.error("not unit vector is treated as unit");
    }
    return this as any as UnitVector;
  }

  static fromData(arr: [number, number, number]): Vector {
    return new Vector().set3(arr);
  }
}

const freeze = Object.freeze;

export const ORIGIN = freeze(new Vector(0, 0, 0));

export const AXIS = freeze({
  X: freeze(new Vector(1, 0, 0) as UnitVector),
  Y: freeze(new Vector(0, 1, 0) as UnitVector),
  Z: freeze(new Vector(0, 0, 1) as UnitVector)
});

export interface UnitVector extends Vector {

  __UnitVectorTypeSafetyHolder__: "DO NOT REMOVE. It's used to separate types at compile time, it's never used in runtime";

  negate(): UnitVector;

  _negate(): UnitVector;

  _perpXY(): UnitVector;

  copy(): UnitVector;
}