@math.gl/core 3.5.7 → 3.6.0-alpha.3

package/src/classes/matrix3.ts

@@ -0,0 +1,253 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+// MIT License
+import Matrix from './base/matrix';
+import {checkVector} from '../lib/validators';
+/* eslint-disable camelcase */
+import {vec4_transformMat3} from '../lib/gl-matrix-extras';
+import * as mat3 from 'gl-matrix/mat3';
+import * as vec2 from 'gl-matrix/vec2';
+import * as vec3 from 'gl-matrix/vec3';
+import {NumericArray} from '@math.gl/types';
+
+enum INDICES {
+  COL0ROW0 = 0,
+  COL0ROW1 = 1,
+  COL0ROW2 = 2,
+  COL1ROW0 = 3,
+  COL1ROW1 = 4,
+  COL1ROW2 = 5,
+  COL2ROW0 = 6,
+  COL2ROW1 = 7,
+  COL2ROW2 = 8
+}
+
+const IDENTITY_MATRIX = Object.freeze([1, 0, 0, 0, 1, 0, 0, 0, 1]);
+
+export default class Matrix3 extends Matrix {
+  static get IDENTITY(): Readonly<Matrix3> {
+    return getIdentityMatrix();
+  }
+
+  static get ZERO(): Readonly<Matrix3> {
+    return getZeroMatrix();
+  }
+
+  get ELEMENTS(): number {
+    return 9;
+  }
+
+  get RANK(): number {
+    return 3;
+  }
+
+  get INDICES(): typeof INDICES {
+    return INDICES;
+  }
+
+  constructor(array?: Readonly<NumericArray>);
+  /** @deprecated */
+  constructor(...args: number[]);
+
+  constructor(array?: number | Readonly<NumericArray>, ...args: number[]) {
+    // PERF NOTE: initialize elements as double precision numbers
+    super(-0, -0, -0, -0, -0, -0, -0, -0, -0);
+    if (arguments.length === 1 && Array.isArray(array)) {
+      this.copy(array);
+    } else if (args.length > 0) {
+      this.copy([array as number, ...args]);
+    } else {
+      this.identity();
+    }
+  }
+
+  copy(array: Readonly<NumericArray>): this {
+    // Element wise copy for performance
+    this[0] = array[0];
+    this[1] = array[1];
+    this[2] = array[2];
+    this[3] = array[3];
+    this[4] = array[4];
+    this[5] = array[5];
+    this[6] = array[6];
+    this[7] = array[7];
+    this[8] = array[8];
+    return this.check();
+  }
+
+  // Constructors
+
+  identity(): this {
+    return this.copy(IDENTITY_MATRIX);
+  }
+
+  /**
+   *
+   * @param object
+   * @returns self
+   */
+  fromObject(object: {[key: string]: any}): this {
+    return this.check();
+  }
+
+  // Calculates a 3x3 matrix from the given quaternion
+  // q quat  Quaternion to create matrix from
+  fromQuaternion(q: Readonly<NumericArray>): this {
+    mat3.fromQuat(this, q);
+    return this.check();
+  }
+
+  /**
+   * accepts column major order, stores in column major order
+   */
+  // eslint-disable-next-line max-params
+  set(
+    m00: number,
+    m10: number,
+    m20: number,
+    m01: number,
+    m11: number,
+    m21: number,
+    m02: number,
+    m12: number,
+    m22: number
+  ): this {
+    this[0] = m00;
+    this[1] = m10;
+    this[2] = m20;
+    this[3] = m01;
+    this[4] = m11;
+    this[5] = m21;
+    this[6] = m02;
+    this[7] = m12;
+    this[8] = m22;
+    return this.check();
+  }
+
+  /**
+   * accepts row major order, stores as column major
+   */
+  // eslint-disable-next-line max-params
+  setRowMajor(
+    m00: number,
+    m01: number,
+    m02: number,
+    m10: number,
+    m11: number,
+    m12: number,
+    m20: number,
+    m21: number,
+    m22: number
+  ): this {
+    this[0] = m00;
+    this[1] = m10;
+    this[2] = m20;
+    this[3] = m01;
+    this[4] = m11;
+    this[5] = m21;
+    this[6] = m02;
+    this[7] = m12;
+    this[8] = m22;
+    return this.check();
+  }
+
+  // Accessors
+
+  determinant(): number {
+    return mat3.determinant(this);
+  }
+
+  // Modifiers
+  transpose(): this {
+    mat3.transpose(this, this);
+    return this.check();
+  }
+
+  /** Invert a matrix. Note that this can fail if the matrix is not invertible */
+  invert(): this {
+    mat3.invert(this, this);
+    return this.check();
+  }
+
+  // Operations
+  multiplyLeft(a: NumericArray): this {
+    mat3.multiply(this, a, this);
+    return this.check();
+  }
+
+  multiplyRight(a: NumericArray): this {
+    mat3.multiply(this, this, a);
+    return this.check();
+  }
+
+  rotate(radians: number): NumericArray {
+    mat3.rotate(this, this, radians);
+    return this.check();
+  }
+
+  scale(factor: NumericArray | number): this {
+    if (Array.isArray(factor)) {
+      mat3.scale(this, this, factor);
+    } else {
+      mat3.scale(this, this, [factor as number, factor as number]);
+    }
+    return this.check();
+  }
+
+  translate(vec: NumericArray): this {
+    mat3.translate(this, this, vec);
+    return this.check();
+  }
+
+  // Transforms
+  transform(vector: Readonly<NumericArray>, result?: NumericArray): NumericArray {
+    switch (vector.length) {
+      case 2:
+        result = vec2.transformMat3(result || [-0, -0], vector, this);
+        break;
+      case 3:
+        result = vec3.transformMat3(result || [-0, -0, -0], vector, this);
+        break;
+      case 4:
+        result = vec4_transformMat3(result || [-0, -0, -0, -0], vector, this);
+        break;
+      default:
+        throw new Error('Illegal vector');
+    }
+    checkVector(result, vector.length);
+    return result;
+  }
+
+  /** @deprecated */
+  transformVector(vector: Readonly<NumericArray>, result?: NumericArray): NumericArray {
+    return this.transform(vector, result);
+  }
+
+  /** @deprecated */
+  transformVector2(vector: Readonly<NumericArray>, result?: NumericArray): NumericArray {
+    return this.transform(vector, result);
+  }
+
+  /** @deprecated */
+  transformVector3(vector: Readonly<NumericArray>, result?: NumericArray): NumericArray {
+    return this.transform(vector, result);
+  }
+}
+
+let ZERO_MATRIX3;
+let IDENTITY_MATRIX3;
+
+function getZeroMatrix(): Readonly<Matrix3> {
+  if (!ZERO_MATRIX3) {
+    ZERO_MATRIX3 = new Matrix3([0, 0, 0, 0, 0, 0, 0, 0, 0]);
+    Object.freeze(ZERO_MATRIX3);
+  }
+  return ZERO_MATRIX3;
+}
+
+function getIdentityMatrix(): Matrix3 {
+  if (!IDENTITY_MATRIX3) {
+    IDENTITY_MATRIX3 = new Matrix3();
+    Object.freeze(IDENTITY_MATRIX3);
+  }
+  return IDENTITY_MATRIX3;
+}