@math.gl/core 4.0.0 → 4.1.0-alpha.1

package/dist/classes/vector3.js

@@ -1,145 +1,138 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// Copyright (c) 2017 Uber Technologies, Inc.
 import { Vector } from "./base/vector.js";
 import { config, isArray } from "../lib/common.js";
 import { checkNumber } from "../lib/validators.js";
+// @ts-ignore gl-matrix types
 import { angle as vec3_angle, cross as vec3_cross, rotateX as vec3_rotateX, rotateY as vec3_rotateY, rotateZ as vec3_rotateZ, transformMat4 as vec3_transformMat4, transformMat3 as vec3_transformMat3, transformQuat as vec3_transformQuat } from "../gl-matrix/vec3.js";
+/* eslint-disable camelcase */
 import { vec3_transformMat2, vec3_transformMat4AsVector } from "../lib/gl-matrix-extras.js";
 const ORIGIN = [0, 0, 0];
 let ZERO;
+/**
+ * Three-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
+ */
 export class Vector3 extends Vector {
-  static get ZERO() {
-    if (!ZERO) {
-      ZERO = new Vector3(0, 0, 0);
-      Object.freeze(ZERO);
-    }
-
-    return ZERO;
-  }
-
-  constructor(x = 0, y = 0, z = 0) {
-    super(-0, -0, -0);
-
-    if (arguments.length === 1 && isArray(x)) {
-      this.copy(x);
-    } else {
-      if (config.debug) {
-        checkNumber(x);
-        checkNumber(y);
-        checkNumber(z);
-      }
-
-      this[0] = x;
-      this[1] = y;
-      this[2] = z;
-    }
-  }
-
-  set(x, y, z) {
-    this[0] = x;
-    this[1] = y;
-    this[2] = z;
-    return this.check();
-  }
-
-  copy(array) {
-    this[0] = array[0];
-    this[1] = array[1];
-    this[2] = array[2];
-    return this.check();
-  }
-
-  fromObject(object) {
-    if (config.debug) {
-      checkNumber(object.x);
-      checkNumber(object.y);
-      checkNumber(object.z);
-    }
-
-    this[0] = object.x;
-    this[1] = object.y;
-    this[2] = object.z;
-    return this.check();
-  }
-
-  toObject(object) {
-    object.x = this[0];
-    object.y = this[1];
-    object.z = this[2];
-    return object;
-  }
-
-  get ELEMENTS() {
-    return 3;
-  }
-
-  get z() {
-    return this[2];
-  }
-
-  set z(value) {
-    this[2] = checkNumber(value);
-  }
-
-  angle(vector) {
-    return vec3_angle(this, vector);
-  }
-
-  cross(vector) {
-    vec3_cross(this, this, vector);
-    return this.check();
-  }
-
-  rotateX({
-    radians,
-    origin = ORIGIN
-  }) {
-    vec3_rotateX(this, this, origin, radians);
-    return this.check();
-  }
-
-  rotateY({
-    radians,
-    origin = ORIGIN
-  }) {
-    vec3_rotateY(this, this, origin, radians);
-    return this.check();
-  }
-
-  rotateZ({
-    radians,
-    origin = ORIGIN
-  }) {
-    vec3_rotateZ(this, this, origin, radians);
-    return this.check();
-  }
-
-  transform(matrix4) {
-    return this.transformAsPoint(matrix4);
-  }
-
-  transformAsPoint(matrix4) {
-    vec3_transformMat4(this, this, matrix4);
-    return this.check();
-  }
-
-  transformAsVector(matrix4) {
-    vec3_transformMat4AsVector(this, this, matrix4);
-    return this.check();
-  }
-
-  transformByMatrix3(matrix3) {
-    vec3_transformMat3(this, this, matrix3);
-    return this.check();
-  }
-
-  transformByMatrix2(matrix2) {
-    vec3_transformMat2(this, this, matrix2);
-    return this.check();
-  }
-
-  transformByQuaternion(quaternion) {
-    vec3_transformQuat(this, this, quaternion);
-    return this.check();
-  }
-
+    static get ZERO() {
+        if (!ZERO) {
+            ZERO = new Vector3(0, 0, 0);
+            Object.freeze(ZERO);
+        }
+        return ZERO;
+    }
+    /**
+     * @class
+     * @param x
+     * @param y
+     * @param z
+     */
+    constructor(x = 0, y = 0, z = 0) {
+        // PERF NOTE: initialize elements as double precision numbers
+        super(-0, -0, -0);
+        if (arguments.length === 1 && isArray(x)) {
+            this.copy(x);
+        }
+        else {
+            // this.set(x, y, z);
+            if (config.debug) {
+                checkNumber(x);
+                checkNumber(y);
+                checkNumber(z);
+            }
+            // @ts-expect-error TS2412: Property '0' of type 'number | [number, number, number]' is not assignable to numeric index type 'number'
+            this[0] = x;
+            this[1] = y;
+            this[2] = z;
+        }
+    }
+    set(x, y, z) {
+        this[0] = x;
+        this[1] = y;
+        this[2] = z;
+        return this.check();
+    }
+    copy(array) {
+        this[0] = array[0];
+        this[1] = array[1];
+        this[2] = array[2];
+        return this.check();
+    }
+    fromObject(object) {
+        if (config.debug) {
+            checkNumber(object.x);
+            checkNumber(object.y);
+            checkNumber(object.z);
+        }
+        this[0] = object.x;
+        this[1] = object.y;
+        this[2] = object.z;
+        return this.check();
+    }
+    toObject(object) {
+        object.x = this[0];
+        object.y = this[1];
+        object.z = this[2];
+        return object;
+    }
+    // Getters/setters
+    get ELEMENTS() {
+        return 3;
+    }
+    get z() {
+        return this[2];
+    }
+    set z(value) {
+        this[2] = checkNumber(value);
+    }
+    // ACCESSORS
+    angle(vector) {
+        return vec3_angle(this, vector);
+    }
+    // MODIFIERS
+    cross(vector) {
+        vec3_cross(this, this, vector);
+        return this.check();
+    }
+    rotateX({ radians, origin = ORIGIN }) {
+        vec3_rotateX(this, this, origin, radians);
+        return this.check();
+    }
+    rotateY({ radians, origin = ORIGIN }) {
+        vec3_rotateY(this, this, origin, radians);
+        return this.check();
+    }
+    rotateZ({ radians, origin = ORIGIN }) {
+        vec3_rotateZ(this, this, origin, radians);
+        return this.check();
+    }
+    // Transforms
+    // transforms as point (4th component is implicitly 1)
+    transform(matrix4) {
+        return this.transformAsPoint(matrix4);
+    }
+    // transforms as point (4th component is implicitly 1)
+    transformAsPoint(matrix4) {
+        vec3_transformMat4(this, this, matrix4);
+        return this.check();
+    }
+    // transforms as vector  (4th component is implicitly 0, ignores translation. slightly faster)
+    transformAsVector(matrix4) {
+        vec3_transformMat4AsVector(this, this, matrix4);
+        return this.check();
+    }
+    transformByMatrix3(matrix3) {
+        vec3_transformMat3(this, this, matrix3);
+        return this.check();
+    }
+    transformByMatrix2(matrix2) {
+        vec3_transformMat2(this, this, matrix2);
+        return this.check();
+    }
+    transformByQuaternion(quaternion) {
+        vec3_transformQuat(this, this, quaternion);
+        return this.check();
+    }
 }
-//# sourceMappingURL=vector3.js.map

package/dist/classes/vector4.d.ts

@@ -1,9 +1,11 @@
-import { NumericArray } from '@math.gl/types';
-import { Vector } from './base/vector';
-import type { Matrix4 } from './matrix4';
+import { NumericArray, NumberArray4 } from '@math.gl/types';
+import { Vector } from "./base/vector.js";
+import type { Matrix4 } from "./matrix4.js";
+/** Helper type that captures array length for a 4 element vector */
+export type Vector4Like = Vector4 | NumberArray4;
 /**
- * Four-element vector class.
- * Subclass of Array<number>
+ * Four-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
  */
 export declare class Vector4 extends Vector {
     static get ZERO(): Vector4;
@@ -38,4 +40,3 @@ export declare class Vector4 extends Vector {
     transformByQuaternion(quaternion: Readonly<NumericArray>): this;
     applyMatrix4(m: Matrix4): this;
 }
-//# sourceMappingURL=vector4.d.ts.map

package/dist/classes/vector4.js

@@ -1,122 +1,116 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// Copyright (c) 2017 Uber Technologies, Inc.
+/* eslint-disable camelcase */
 import { transformMat4 as vec4_transformMat4, transformQuat as vec4_transformQuat } from "../gl-matrix/vec3.js";
 import { vec4_transformMat2, vec4_transformMat3 } from "../lib/gl-matrix-extras.js";
 import { Vector } from "./base/vector.js";
 import { config, isArray } from "../lib/common.js";
 import { checkNumber } from "../lib/validators.js";
 let ZERO;
+/**
+ * Four-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
+ */
 export class Vector4 extends Vector {
-  static get ZERO() {
-    if (!ZERO) {
-      ZERO = new Vector4(0, 0, 0, 0);
-      Object.freeze(ZERO);
-    }
-
-    return ZERO;
-  }
-
-  constructor(x = 0, y = 0, z = 0, w = 0) {
-    super(-0, -0, -0, -0);
-
-    if (isArray(x) && arguments.length === 1) {
-      this.copy(x);
-    } else {
-      if (config.debug) {
-        checkNumber(x);
-        checkNumber(y);
-        checkNumber(z);
-        checkNumber(w);
-      }
-
-      this[0] = x;
-      this[1] = y;
-      this[2] = z;
-      this[3] = w;
-    }
-  }
-
-  set(x, y, z, w) {
-    this[0] = x;
-    this[1] = y;
-    this[2] = z;
-    this[3] = w;
-    return this.check();
-  }
-
-  copy(array) {
-    this[0] = array[0];
-    this[1] = array[1];
-    this[2] = array[2];
-    this[3] = array[3];
-    return this.check();
-  }
-
-  fromObject(object) {
-    if (config.debug) {
-      checkNumber(object.x);
-      checkNumber(object.y);
-      checkNumber(object.z);
-      checkNumber(object.w);
-    }
-
-    this[0] = object.x;
-    this[1] = object.y;
-    this[2] = object.z;
-    this[3] = object.w;
-    return this;
-  }
-
-  toObject(object) {
-    object.x = this[0];
-    object.y = this[1];
-    object.z = this[2];
-    object.w = this[3];
-    return object;
-  }
-
-  get ELEMENTS() {
-    return 4;
-  }
-
-  get z() {
-    return this[2];
-  }
-
-  set z(value) {
-    this[2] = checkNumber(value);
-  }
-
-  get w() {
-    return this[3];
-  }
-
-  set w(value) {
-    this[3] = checkNumber(value);
-  }
-
-  transform(matrix4) {
-    vec4_transformMat4(this, this, matrix4);
-    return this.check();
-  }
-
-  transformByMatrix3(matrix3) {
-    vec4_transformMat3(this, this, matrix3);
-    return this.check();
-  }
-
-  transformByMatrix2(matrix2) {
-    vec4_transformMat2(this, this, matrix2);
-    return this.check();
-  }
-
-  transformByQuaternion(quaternion) {
-    vec4_transformQuat(this, this, quaternion);
-    return this.check();
-  }
-
-  applyMatrix4(m) {
-    m.transform(this, this);
-    return this;
-  }
-
+    static get ZERO() {
+        if (!ZERO) {
+            ZERO = new Vector4(0, 0, 0, 0);
+            Object.freeze(ZERO);
+        }
+        return ZERO;
+    }
+    constructor(x = 0, y = 0, z = 0, w = 0) {
+        // PERF NOTE: initialize elements as double precision numbers
+        super(-0, -0, -0, -0);
+        if (isArray(x) && arguments.length === 1) {
+            this.copy(x);
+        }
+        else {
+            // this.set(x, y, z, w);
+            if (config.debug) {
+                checkNumber(x);
+                checkNumber(y);
+                checkNumber(z);
+                checkNumber(w);
+            }
+            this[0] = x;
+            this[1] = y;
+            this[2] = z;
+            this[3] = w;
+        }
+    }
+    set(x, y, z, w) {
+        this[0] = x;
+        this[1] = y;
+        this[2] = z;
+        this[3] = w;
+        return this.check();
+    }
+    copy(array) {
+        this[0] = array[0];
+        this[1] = array[1];
+        this[2] = array[2];
+        this[3] = array[3];
+        return this.check();
+    }
+    fromObject(object) {
+        if (config.debug) {
+            checkNumber(object.x);
+            checkNumber(object.y);
+            checkNumber(object.z);
+            checkNumber(object.w);
+        }
+        this[0] = object.x;
+        this[1] = object.y;
+        this[2] = object.z;
+        this[3] = object.w;
+        return this;
+    }
+    toObject(object) {
+        object.x = this[0];
+        object.y = this[1];
+        object.z = this[2];
+        object.w = this[3];
+        return object;
+    }
+    // Getters/setters
+    /* eslint-disable no-multi-spaces, brace-style, no-return-assign */
+    get ELEMENTS() {
+        return 4;
+    }
+    get z() {
+        return this[2];
+    }
+    set z(value) {
+        this[2] = checkNumber(value);
+    }
+    get w() {
+        return this[3];
+    }
+    set w(value) {
+        this[3] = checkNumber(value);
+    }
+    transform(matrix4) {
+        vec4_transformMat4(this, this, matrix4);
+        return this.check();
+    }
+    transformByMatrix3(matrix3) {
+        vec4_transformMat3(this, this, matrix3);
+        return this.check();
+    }
+    transformByMatrix2(matrix2) {
+        vec4_transformMat2(this, this, matrix2);
+        return this.check();
+    }
+    transformByQuaternion(quaternion) {
+        vec4_transformQuat(this, this, quaternion);
+        return this.check();
+    }
+    // three.js compatibility
+    applyMatrix4(m) {
+        m.transform(this, this);
+        return this;
+    }
 }
-//# sourceMappingURL=vector4.js.map

package/dist/gl-matrix/common.d.ts

@@ -35,4 +35,3 @@ export const EPSILON: 0.000001;
 export let ARRAY_TYPE: ArrayConstructor | Float32ArrayConstructor;
 export const RANDOM: () => number;
 export const ANGLE_ORDER: "zyx";
-//# sourceMappingURL=common.d.ts.map

package/dist/gl-matrix/common.js

@@ -1,19 +1,51 @@
+// @eslint-disable
+// @ts-nocheck
+/**
+ * Common utilities
+ * @module glMatrix
+ */
+// Configuration Constants
 export const EPSILON = 0.000001;
 export let ARRAY_TYPE = typeof Float32Array !== 'undefined' ? Float32Array : Array;
 export const RANDOM = Math.random;
 export const ANGLE_ORDER = 'zyx';
+/**
+ * Symmetric round
+ * see https://www.npmjs.com/package/round-half-up-symmetric#user-content-detailed-background
+ *
+ * @param {Number} a value to round
+ */
 export function round(a) {
-  if (a >= 0) return Math.round(a);
-  return a % 0.5 === 0 ? Math.floor(a) : Math.round(a);
+    if (a >= 0)
+        return Math.round(a);
+    return a % 0.5 === 0 ? Math.floor(a) : Math.round(a);
 }
+/**
+ * Sets the type of array used when creating new vectors and matrices
+ *
+ * @param {Float32ArrayConstructor | ArrayConstructor} type Array type, such as Float32Array or Array
+ */
 export function setMatrixArrayType(type) {
-  ARRAY_TYPE = type;
+    ARRAY_TYPE = type;
 }
 const degree = Math.PI / 180;
+/**
+ * Convert Degree To Radian
+ *
+ * @param {Number} a Angle in Degrees
+ */
 export function toRadian(a) {
-  return a * degree;
+    return a * degree;
 }
+/**
+ * Tests whether or not the arguments have approximately the same value, within an absolute
+ * or relative tolerance of glMatrix.EPSILON (an absolute tolerance is used for values less
+ * than or equal to 1.0, and a relative tolerance is used for larger values)
+ *
+ * @param {Number} a The first number to test.
+ * @param {Number} b The second number to test.
+ * @returns {Boolean} True if the numbers are approximately equal, false otherwise.
+ */
 export function equals(a, b) {
-  return Math.abs(a - b) <= EPSILON * Math.max(1.0, Math.abs(a), Math.abs(b));
+    return Math.abs(a - b) <= EPSILON * Math.max(1.0, Math.abs(a), Math.abs(b));
 }
-//# sourceMappingURL=common.js.map

package/dist/gl-matrix/mat3.d.ts

@@ -284,4 +284,3 @@ export declare const mul: typeof multiply;
  * @function
  */
 export declare const sub: typeof subtract;
-//# sourceMappingURL=mat3.d.ts.map