@math.gl/core 3.6.3 → 4.0.0-alpha.2

package/src/gl-matrix/wip/types.d.ts

@@ -0,0 +1,93 @@
+// @ts-nocheck
+/* eslint-disable */
+
+interface IndexedCollection extends Iterable<number> {
+  readonly length: number;
+  [index: number]: number;
+}
+
+// prettier-ignore
+declare type mat2 =
+  | [number, number, 
+     number, number]
+  | IndexedCollection;
+
+// prettier-ignore
+declare type mat2d =
+  | [number, number, 
+     number, number, 
+     number, number]
+  | IndexedCollection;
+
+// prettier-ignore
+declare type mat3 =
+  | [number, number, number, 
+     number, number, number, 
+     number, number, number]
+  | IndexedCollection;
+
+// prettier-ignore
+declare type mat4 =
+  | [number, number, number, number,
+     number, number, number, number,
+     number, number, number, number,
+     number, number, number, number]
+  | IndexedCollection;
+
+declare type quat = [number, number, number, number] | IndexedCollection;
+
+// prettier-ignore
+declare type quat2 =
+  | [number, number, number, number, 
+    number, number, number, number]
+  | IndexedCollection;
+
+declare type vec2 = [number, number] | IndexedCollection;
+declare type vec3 = [number, number, number] | IndexedCollection;
+declare type vec4 = [number, number, number, number] | IndexedCollection;
+
+// prettier-ignore
+declare type ReadonlyMat2 =
+  | readonly [
+      number, number,
+      number, number
+    ]
+  | IndexedCollection;
+
+// prettier-ignore
+declare type ReadonlyMat2d =
+  | readonly [
+      number, number,
+      number, number,
+      number, number
+    ]
+  | IndexedCollection;
+
+// prettier-ignore
+declare type ReadonlyMat3 =
+  | readonly [
+      number, number, number,
+      number, number, number,
+      number, number, number
+    ]
+  | IndexedCollection;
+
+// prettier-ignore
+declare type ReadonlyMat4 =
+  | readonly [
+      number, number, number, number,
+      number, number, number, number,
+      number, number, number, number,
+      number, number, number, number
+    ]
+  | IndexedCollection;
+
+declare type ReadonlyQuat = readonly [number, number, number, number] | IndexedCollection;
+
+declare type ReadonlyQuat2 =
+  | readonly [number, number, number, number, number, number, number, number]
+  | IndexedCollection;
+
+declare type ReadonlyVec2 = readonly [number, number] | IndexedCollection;
+declare type ReadonlyVec3 = readonly [number, number, number] | IndexedCollection;
+declare type ReadonlyVec4 = readonly [number, number, number, number] | IndexedCollection;

package/src/index.ts

@@ -3,23 +3,25 @@
 // types
 export type {TypedArray, NumericArray} from '@math.gl/types';
 
+export type {isTypedArray, isNumericArray} from '@math.gl/types';
+
 // classes
-export {default as Vector2} from './classes/vector2';
-export {default as Vector3} from './classes/vector3';
-export {default as Vector4} from './classes/vector4';
-export {default as Matrix3} from './classes/matrix3';
-export {default as Matrix4} from './classes/matrix4';
-export {default as Quaternion} from './classes/quaternion';
+export {Vector2} from './classes/vector2';
+export {Vector3} from './classes/vector3';
+export {Vector4} from './classes/vector4';
+export {Matrix3} from './classes/matrix3';
+export {Matrix4} from './classes/matrix4';
+export {Quaternion} from './classes/quaternion';
 
 // experimental
-export {default as SphericalCoordinates} from './classes/spherical-coordinates';
-export {default as Pose} from './classes/pose';
-export {default as Euler} from './classes/euler';
+export {SphericalCoordinates} from './classes/spherical-coordinates';
+export {Pose} from './classes/pose';
+export {Euler} from './classes/euler';
 
-export {default as _MathUtils} from './lib/math-utils';
+export * as _MathUtils from './lib/math-utils';
 
 // lib
-export {default as assert} from './lib/assert';
+export {assert} from './lib/assert';
 
 export {
   // math.gl global utility methods
@@ -47,6 +49,6 @@ export {
 } from './lib/common';
 
 // DEPRECATED
-export {default as _SphericalCoordinates} from './classes/spherical-coordinates';
-export {default as _Pose} from './classes/pose';
-export {default as _Euler} from './classes/euler';
+export {SphericalCoordinates as _SphericalCoordinates} from './classes/spherical-coordinates';
+export {Pose as _Pose} from './classes/pose';
+export {Euler as _Euler} from './classes/euler';

package/src/lib/assert.ts

@@ -1,4 +1,4 @@
-export default function assert(condition: unknown, message?: string): void {
+export function assert(condition: unknown, message?: string): void {
   if (!condition) {
     throw new Error(`math.gl assertion ${message}`);
   }

package/src/lib/common.ts

@@ -1,9 +1,11 @@
-// Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
-import {NumericArray} from '@math.gl/types';
-import assert from './assert';
+// math.gl, MIT license
 
-import type MathArray from '../classes/base/math-array';
+import type {NumericArray} from '@math.gl/types';
+
+import type {MathArray} from '../classes/base/math-array';
+
+const RADIANS_TO_DEGREES = (1 / Math.PI) * 180;
+const DEGREES_TO_RADIANS = (1 / 180) * Math.PI;
 
 export type ConfigurationOptions = {
   EPSILON: number;
@@ -15,25 +17,33 @@ export type ConfigurationOptions = {
   _cartographicRadians?: boolean;
 };
 
-const RADIANS_TO_DEGREES = (1 / Math.PI) * 180;
-const DEGREES_TO_RADIANS = (1 / 180) * Math.PI;
-
-// TODO - remove
-export const config: ConfigurationOptions = {
+const DEFAULT_CONFIG: Required<ConfigurationOptions> = {
   EPSILON: 1e-12,
   debug: false,
   precision: 4,
   printTypes: false,
   printDegrees: false,
-  printRowMajor: true
+  printRowMajor: true,
+  _cartographicRadians: false
 };
 
-export function configure(options?: Partial<ConfigurationOptions>): ConfigurationOptions {
+// We use a global field to store the config
+declare global {
+  // eslint-disable-next-line no-var
+  var mathgl: {
+    config: Required<ConfigurationOptions>;
+  };
+}
+
+// Configuration is truly global as of v3.6 to ensure single config even if multiple copies of math.gl
+// Multiple copies of config can be quite tricky to debug...
+globalThis.mathgl = globalThis.mathgl || {config: {...DEFAULT_CONFIG}};
+
+export const config = globalThis.mathgl.config;
+
+export function configure(options: Partial<ConfigurationOptions>): ConfigurationOptions {
   // Only copy existing keys
-  for (const key in options) {
-    assert(key in config);
-    config[key] = options[key];
-  }
+  Object.assign(config, options);
   return config;
 }
 
@@ -55,8 +65,8 @@ export function formatValue(
 /**
  * Check if value is an "array"
  * Returns `true` if value is either an array or a typed array
- *
  * Note: returns `false` for `ArrayBuffer` and `DataView` instances
+ * @note isTypedArray and isNumericArray are often more useful in TypeScript
  */
 export function isArray(value: unknown): boolean {
   return Array.isArray(value) || (ArrayBuffer.isView(value) && !(value instanceof DataView));
@@ -281,7 +291,8 @@ function round(value: number): number {
 // If the array has a clone function, calls it, otherwise returns a copy
 function duplicateArray(array: NumericArray): NumericArray {
   // @ts-expect-error We check for math.gl class methods
-  return array.clone ? array.clone() : (new Array(array.length) as number[]);
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+  return array.clone ? (array.clone() as NumericArray) : (new Array(array.length) as number[]);
 }
 
 // If the argument value is an array, applies the func element wise,
@@ -295,7 +306,8 @@ function map(
     const array = value as NumericArray;
     result = result || duplicateArray(array);
     for (let i = 0; i < result.length && i < array.length; ++i) {
-      result[i] = func(value[i], i, result);
+      const val = typeof value === 'number' ? value : value[i];
+      result[i] = func(val, i, result);
     }
     return result;
   }

package/src/lib/math-utils.ts

@@ -1,30 +1,28 @@
 // NOTE: Added to make Cesium-derived test cases work
 // TODO: Determine if/how to keep
-export default {
-  EPSILON1: 1e-1,
-  EPSILON2: 1e-2,
-  EPSILON3: 1e-3,
-  EPSILON4: 1e-4,
-  EPSILON5: 1e-5,
-  EPSILON6: 1e-6,
-  EPSILON7: 1e-7,
-  EPSILON8: 1e-8,
-  EPSILON9: 1e-9,
-  EPSILON10: 1e-10,
-  EPSILON11: 1e-11,
-  EPSILON12: 1e-12,
-  EPSILON13: 1e-13,
-  EPSILON14: 1e-14,
-  EPSILON15: 1e-15,
-  EPSILON16: 1e-16,
-  EPSILON17: 1e-17,
-  EPSILON18: 1e-18,
-  EPSILON19: 1e-19,
-  EPSILON20: 1e-20,
+export const EPSILON1 = 1e-1;
+export const EPSILON2 = 1e-2;
+export const EPSILON3 = 1e-3;
+export const EPSILON4 = 1e-4;
+export const EPSILON5 = 1e-5;
+export const EPSILON6 = 1e-6;
+export const EPSILON7 = 1e-7;
+export const EPSILON8 = 1e-8;
+export const EPSILON9 = 1e-9;
+export const EPSILON10 = 1e-10;
+export const EPSILON11 = 1e-11;
+export const EPSILON12 = 1e-12;
+export const EPSILON13 = 1e-13;
+export const EPSILON14 = 1e-14;
+export const EPSILON15 = 1e-15;
+export const EPSILON16 = 1e-16;
+export const EPSILON17 = 1e-17;
+export const EPSILON18 = 1e-18;
+export const EPSILON19 = 1e-19;
+export const EPSILON20 = 1e-20;
 
-  PI_OVER_TWO: Math.PI / 2,
-  PI_OVER_FOUR: Math.PI / 4,
-  PI_OVER_SIX: Math.PI / 6,
+export const PI_OVER_TWO = Math.PI / 2;
+export const PI_OVER_FOUR = Math.PI / 4;
+export const PI_OVER_SIX = Math.PI / 6;
 
-  TWO_PI: Math.PI * 2
-};
+export const TWO_PI = Math.PI * 2;

package/src/lib/validators.ts

@@ -33,9 +33,9 @@ export function validateVector(v: NumberArray, length: number): boolean {
   return true;
 }
 
-export function checkNumber(value: any): number {
+export function checkNumber(value: unknown): number {
   if (!Number.isFinite(value)) {
-    throw new Error(`Invalid number ${value}`);
+    throw new Error(`Invalid number ${JSON.stringify(value)}`);
   }
   return value as number;
 }
@@ -51,7 +51,7 @@ export function checkVector<T extends NumberArray>(
   return v;
 }
 
-const map = {};
+const map: Record<string, boolean> = {};
 
 export function deprecated(method: string, version: string): void {
   if (!map[method]) {

package/dist/es5/classes/base/math-array.js

@@ -1,348 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-
-var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
-
-var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
-
-var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
-
-var _common = require("../../lib/common");
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
-function _extendableBuiltin(cls) {
-  function ExtendableBuiltin() {
-    var instance = Reflect.construct(cls, Array.from(arguments));
-    Object.setPrototypeOf(instance, Object.getPrototypeOf(this));
-    return instance;
-  }
-
-  ExtendableBuiltin.prototype = Object.create(cls.prototype, {
-    constructor: {
-      value: cls,
-      enumerable: false,
-      writable: true,
-      configurable: true
-    }
-  });
-
-  if (Object.setPrototypeOf) {
-    Object.setPrototypeOf(ExtendableBuiltin, cls);
-  } else {
-    ExtendableBuiltin.__proto__ = cls;
-  }
-
-  return ExtendableBuiltin;
-}
-
-var MathArray = function (_extendableBuiltin2) {
-  (0, _inherits2.default)(MathArray, _extendableBuiltin2);
-
-  var _super = _createSuper(MathArray);
-
-  function MathArray() {
-    (0, _classCallCheck2.default)(this, MathArray);
-    return _super.apply(this, arguments);
-  }
-
-  (0, _createClass2.default)(MathArray, [{
-    key: "clone",
-    value: function clone() {
-      return new this.constructor().copy(this);
-    }
-  }, {
-    key: "fromArray",
-    value: function fromArray(array) {
-      var offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] = array[i + offset];
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "toArray",
-    value: function toArray() {
-      var targetArray = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-      var offset = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
-
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        targetArray[offset + i] = this[i];
-      }
-
-      return targetArray;
-    }
-  }, {
-    key: "from",
-    value: function from(arrayOrObject) {
-      return Array.isArray(arrayOrObject) ? this.copy(arrayOrObject) : this.fromObject(arrayOrObject);
-    }
-  }, {
-    key: "to",
-    value: function to(arrayOrObject) {
-      if (arrayOrObject === this) {
-        return this;
-      }
-
-      return (0, _common.isArray)(arrayOrObject) ? this.toArray(arrayOrObject) : this.toObject(arrayOrObject);
-    }
-  }, {
-    key: "toTarget",
-    value: function toTarget(target) {
-      return target ? this.to(target) : this;
-    }
-  }, {
-    key: "toFloat32Array",
-    value: function toFloat32Array() {
-      return new Float32Array(this);
-    }
-  }, {
-    key: "toString",
-    value: function toString() {
-      return this.formatString(_common.config);
-    }
-  }, {
-    key: "formatString",
-    value: function formatString(opts) {
-      var string = '';
-
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        string += (i > 0 ? ', ' : '') + (0, _common.formatValue)(this[i], opts);
-      }
-
-      return "".concat(opts.printTypes ? this.constructor.name : '', "[").concat(string, "]");
-    }
-  }, {
-    key: "equals",
-    value: function equals(array) {
-      if (!array || this.length !== array.length) {
-        return false;
-      }
-
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        if (!(0, _common.equals)(this[i], array[i])) {
-          return false;
-        }
-      }
-
-      return true;
-    }
-  }, {
-    key: "exactEquals",
-    value: function exactEquals(array) {
-      if (!array || this.length !== array.length) {
-        return false;
-      }
-
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        if (this[i] !== array[i]) {
-          return false;
-        }
-      }
-
-      return true;
-    }
-  }, {
-    key: "negate",
-    value: function negate() {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] = -this[i];
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "lerp",
-    value: function lerp(a, b, t) {
-      if (t === undefined) {
-        return this.lerp(this, a, b);
-      }
-
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        var ai = a[i];
-        this[i] = ai + t * (b[i] - ai);
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "min",
-    value: function min(vector) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] = Math.min(vector[i], this[i]);
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "max",
-    value: function max(vector) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] = Math.max(vector[i], this[i]);
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "clamp",
-    value: function clamp(minVector, maxVector) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] = Math.min(Math.max(this[i], minVector[i]), maxVector[i]);
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "add",
-    value: function add() {
-      for (var _len = arguments.length, vectors = new Array(_len), _key = 0; _key < _len; _key++) {
-        vectors[_key] = arguments[_key];
-      }
-
-      for (var _i = 0, _vectors = vectors; _i < _vectors.length; _i++) {
-        var _vector = _vectors[_i];
-
-        for (var i = 0; i < this.ELEMENTS; ++i) {
-          this[i] += _vector[i];
-        }
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "subtract",
-    value: function subtract() {
-      for (var _len2 = arguments.length, vectors = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
-        vectors[_key2] = arguments[_key2];
-      }
-
-      for (var _i2 = 0, _vectors2 = vectors; _i2 < _vectors2.length; _i2++) {
-        var _vector2 = _vectors2[_i2];
-
-        for (var i = 0; i < this.ELEMENTS; ++i) {
-          this[i] -= _vector2[i];
-        }
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "scale",
-    value: function scale(_scale) {
-      if (typeof _scale === 'number') {
-        for (var i = 0; i < this.ELEMENTS; ++i) {
-          this[i] *= _scale;
-        }
-      } else {
-        for (var _i3 = 0; _i3 < this.ELEMENTS && _i3 < _scale.length; ++_i3) {
-          this[_i3] *= _scale[_i3];
-        }
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "multiplyByScalar",
-    value: function multiplyByScalar(scalar) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] *= scalar;
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "check",
-    value: function check() {
-      if (_common.config.debug && !this.validate()) {
-        throw new Error("math.gl: ".concat(this.constructor.name, " some fields set to invalid numbers'"));
-      }
-
-      return this;
-    }
-  }, {
-    key: "validate",
-    value: function validate() {
-      var valid = this.length === this.ELEMENTS;
-
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        valid = valid && Number.isFinite(this[i]);
-      }
-
-      return valid;
-    }
-  }, {
-    key: "sub",
-    value: function sub(a) {
-      return this.subtract(a);
-    }
-  }, {
-    key: "setScalar",
-    value: function setScalar(a) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] = a;
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "addScalar",
-    value: function addScalar(a) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] += a;
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "subScalar",
-    value: function subScalar(a) {
-      return this.addScalar(-a);
-    }
-  }, {
-    key: "multiplyScalar",
-    value: function multiplyScalar(scalar) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] *= scalar;
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "divideScalar",
-    value: function divideScalar(a) {
-      return this.multiplyByScalar(1 / a);
-    }
-  }, {
-    key: "clampScalar",
-    value: function clampScalar(min, max) {
-      for (var i = 0; i < this.ELEMENTS; ++i) {
-        this[i] = Math.min(Math.max(this[i], min), max);
-      }
-
-      return this.check();
-    }
-  }, {
-    key: "elements",
-    get: function get() {
-      return this;
-    }
-  }]);
-  return MathArray;
-}(_extendableBuiltin(Array));
-
-exports.default = MathArray;
-//# sourceMappingURL=math-array.js.map