@math.gl/core 3.5.6 → 3.6.0-alpha.1

package/src/lib/common.ts

@@ -0,0 +1,283 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+// MIT License
+import {NumericArray} from '@math.gl/types';
+import assert from './assert';
+
+export type ConfigurationOptions = {
+  EPSILON?: number;
+  debug?: boolean;
+  precision?: number;
+  printTypes?: boolean;
+  printDegrees?: boolean;
+  printRowMajor?: boolean;
+  _cartographicRadians?: boolean;
+};
+
+const RADIANS_TO_DEGREES = (1 / Math.PI) * 180;
+const DEGREES_TO_RADIANS = (1 / 180) * Math.PI;
+
+// TODO - remove
+/* eslint-disable no-shadow */
+export const config: ConfigurationOptions = {};
+
+config.EPSILON = 1e-12;
+config.debug = false;
+config.precision = 4;
+config.printTypes = false;
+config.printDegrees = false;
+config.printRowMajor = true;
+
+export function configure(options: ConfigurationOptions = {}): ConfigurationOptions {
+  // Only copy existing keys
+  for (const key in options) {
+    assert(key in config);
+    config[key] = options[key];
+  }
+  return config;
+}
+
+/**
+ * Formats a value into a string
+ * @param value
+ * @param param1
+ * @returns
+ */
+export function formatValue(
+  value: number,
+  {precision = config.precision || 4}: ConfigurationOptions = {}
+): string {
+  value = round(value);
+  // get rid of trailing zeros
+  return `${parseFloat(value.toPrecision(precision))}`;
+}
+
+/**
+ * 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
+ */
+export function isArray(value: unknown): boolean {
+  return Array.isArray(value) || (ArrayBuffer.isView(value) && !(value instanceof DataView));
+}
+
+export function clone(array: NumericArray): NumericArray {
+  // @ts-expect-error We are speculatively calling clone
+  return 'clone' in array ? array.clone() : new Array(...array);
+}
+
+export function toRadians(degrees: number): number;
+export function toRadians(degrees: NumericArray): NumericArray;
+
+export function toRadians(degrees): any {
+  return radians(degrees);
+}
+
+export function toDegrees(degrees: number): number;
+export function toDegrees(degrees: NumericArray): NumericArray;
+
+export function toDegrees(radians): any {
+  return degrees(radians);
+}
+
+// GLSL math function equivalents - Works on both single values and vectors
+
+/**
+ * "GLSL equivalent" radians: Works on single values and vectors
+ */
+export function radians(degrees: number): number;
+export function radians(degrees: NumericArray, result?: NumericArray): NumericArray;
+
+export function radians(degrees, result?) {
+  return map(degrees, (degrees) => degrees * DEGREES_TO_RADIANS, result);
+}
+
+/**
+ * "GLSL equivalent" degrees: Works on single values and vectors
+ */
+export function degrees(radians: number): number;
+export function degrees(radians: NumericArray, result?: NumericArray): NumericArray;
+
+export function degrees(radians: number | NumericArray, result?) {
+  return map(radians, (radians) => radians * RADIANS_TO_DEGREES, result);
+}
+
+/**
+ * "GLSL equivalent" of `Math.sin`: Works on single values and vectors
+ * @deprecated
+ */
+export function sin(radians: any, result?: any): any {
+  return map(radians, (angle) => Math.sin(angle), result);
+}
+
+/**
+ * "GLSL equivalent" of `Math.cos`: Works on single values and vectors
+ * @deprecated
+ */
+export function cos(radians: number | NumericArray, result?) {
+  return map(radians, (angle) => Math.cos(angle), result);
+}
+
+/**
+ * "GLSL equivalent" of `Math.tan`: Works on single values and vectors
+ * @deprecated
+ */
+export function tan(radians: number | NumericArray, result?) {
+  return map(radians, (angle) => Math.tan(angle));
+}
+
+/**
+ * "GLSL equivalent" of `Math.asin`: Works on single values and vectors
+ * @deprecated
+ */
+export function asin(radians: number | NumericArray) {
+  return map(radians, (angle) => Math.asin(angle));
+}
+
+/**
+ * "GLSL equivalent" of `Math.acos`: Works on single values and vectors
+ * @deprecated
+ */
+export function acos(radians: number | NumericArray) {
+  return map(radians, (angle) => Math.acos(angle));
+}
+
+/**
+ * "GLSL equivalent" of `Math.atan`: Works on single values and vectors
+ * @deprecated
+ */
+export function atan(radians: number | NumericArray) {
+  return map(radians, (angle) => Math.atan(angle));
+}
+
+/**
+ * GLSL style value clamping: Works on single values and vectors
+ */
+export function clamp(value: number | NumericArray, min: number, max: number) {
+  return map(value, (value) => Math.max(min, Math.min(max, value)));
+}
+
+/**
+ * Interpolate between two numbers or two arrays
+ */
+export function lerp(a, b, t: number) {
+  if (isArray(a)) {
+    return a.map((ai, i) => lerp(ai, b[i], t));
+  }
+  return t * b + (1 - t) * a;
+}
+
+/**
+ * Compares any two math objects, using `equals` method if available.
+ * @param a
+ * @param b
+ * @param epsilon
+ * @returns
+ */
+// eslint-disable-next-line complexity
+export function equals(a: unknown, b: unknown, epsilon?: number): boolean {
+  const oldEpsilon = config.EPSILON;
+  if (epsilon) {
+    config.EPSILON = epsilon;
+  }
+  try {
+    if (a === b) {
+      return true;
+    }
+    if (isArray(a) && isArray(b)) {
+      // @ts-expect-error isArray has checked
+      if (a.length !== b.length) {
+        return false;
+      }
+      // @ts-expect-error isArray has checked
+      for (let i = 0; i < a.length; ++i) {
+        // eslint-disable-next-line max-depth
+        if (!equals(a[i], b[i])) {
+          return false;
+        }
+      }
+      return true;
+    }
+    // @ts-expect-error Dynamic testing
+    if (a && a.equals) {
+      // @ts-expect-error Dynamic testing
+      return a.equals(b);
+    }
+    // @ts-expect-error Dynamic testing
+    if (b && b.equals) {
+      // @ts-expect-error Dynamic testing
+      return b.equals(a);
+    }
+    if (typeof a === 'number' && typeof b === 'number') {
+      return Math.abs(a - b) <= config.EPSILON * Math.max(1, Math.abs(a), Math.abs(b));
+    }
+    return false;
+  } finally {
+    config.EPSILON = oldEpsilon;
+  }
+}
+
+// eslint-disable-next-line complexity
+export function exactEquals(a, b): boolean {
+  if (a === b) {
+    return true;
+  }
+  if (a && typeof a === 'object' && b && typeof b === 'object') {
+    if (a.constructor !== b.constructor) {
+      return false;
+    }
+    if (a.exactEquals) {
+      return a.exactEquals(b);
+    }
+  }
+  if (isArray(a) && isArray(b)) {
+    if (a.length !== b.length) {
+      return false;
+    }
+    for (let i = 0; i < a.length; ++i) {
+      if (!exactEquals(a[i], b[i])) {
+        return false;
+      }
+    }
+    return true;
+  }
+  return false;
+}
+
+export function withEpsilon(epsilon: number, func: Function): any {
+  const oldPrecision = config.EPSILON;
+  config.EPSILON = epsilon;
+  let value;
+  try {
+    value = func();
+  } finally {
+    config.EPSILON = oldPrecision;
+  }
+  return value;
+}
+
+// HELPERS
+
+function round(value: number): number {
+  return Math.round(value / config.EPSILON) * config.EPSILON;
+}
+
+// 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);
+}
+
+// If the argument value is an array, applies the func element wise,
+// otherwise applies func to the argument value
+function map(value: number | NumericArray, func: Function, result?) {
+  if (isArray(value)) {
+    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);
+    }
+    return result;
+  }
+  return func(value);
+}

package/dist/es5/addons/polygon.d.ts

@@ -1,17 +0,0 @@
-import {NumberArray} from '@math.gl/core/';
-
-type SegmentVisitor = (p1: NumberArray, p2: NumberArray, i1: number, i2: number) => void;
-
-export default class Polygon {
-  constructor(
-    points: NumberArray | NumberArray[],
-    options?: {start?: number; end?: number; size?: number; isClosed?: boolean}
-  );
-
-  // https://en.wikipedia.org/wiki/Shoelace_formula
-  getSignedArea(): number;
-  getArea(): number;
-  getWindingDirection(): number;
-  forEachSegment(visitor: SegmentVisitor): void;
-  modifyWindingDirection(direction: number): boolean;
-}

package/dist/es5/classes/base/math-array.d.ts

@@ -1,56 +0,0 @@
-
-/** Base class for vectors and matrices */
-export default abstract class MathArray<DerivedType> extends Array<number> {
-  // Defined by derived class
-  abstract get ELEMENTS(): number;
-
-  clone(): DerivedType;
-
-  // TODO - define more sophisticated object type per class?
-  from(array: readonly number[]): DerivedType;
-  from(object: object): DerivedType;
-
-  fromArray(array: readonly number[], offset?: number): DerivedType;
-  // todo
-  to(arrayOrObject): any;
-  toTarget(target): any;
-
-  toArray(array?: number[], offset?: number): number[];
-  toFloat32Array(): Float32Array;
-  toString(): string;
-  formatString(opts: object): string;
-  equals(array: readonly number[]): boolean;
-  exactEquals(array: readonly number[]): boolean;
-
-  // Modifiers
-
-  negate(): DerivedType;
-  lerp(a: readonly number[], b: readonly number[], t: number): DerivedType;
-
-  min(vector: readonly number[]): DerivedType;
-  max(vector: readonly number[]): DerivedType;
-
-  clamp(minVector: readonly number[], maxVector: readonly number[]): DerivedType;
-
-  add(...vectors): DerivedType;
-  subtract(...vectors): DerivedType;
-
-  scale(scale): DerivedType;
-
-  // three.js compatibility
-
-  sub(a): DerivedType;
-  setScalar(a): DerivedType;
-  addScalar(a): DerivedType;
-  subScalar(a): DerivedType;
-  multiplyScalar(scalar): DerivedType;
-  divideScalar(a): DerivedType;
-  clampScalar(min, max): DerivedType;
-  elements: number[];
-
-  // Cesium compatibility
-  multiplyByScalar(scalar): DerivedType;
-
-  // private
-  check(): DerivedType;
-}

package/dist/es5/classes/base/matrix.d.ts

@@ -1,15 +0,0 @@
-import MathArray from './math-array';
-
-export default abstract class Matrix<MatrixType> extends MathArray<MatrixType> {
-  abstract get RANK(): number;
-
-  toString(): string;
-
-  getElementIndex(row: number, col: number): number;
-  // By default assumes row major indices
-  getElement(row: number, col: number);
-  // By default assumes row major indices
-  setElement(row: number, col: number, value: number);
-  getColumn(columnIndex: number, result?: number[]);
-  setColumn(columnIndex: number, columnVector: number[]);
-}

package/dist/es5/classes/base/vector.d.ts

@@ -1,45 +0,0 @@
-import MathArray from './math-array';
-
-/** Base class for vectors */
-export default abstract class Vector<VectorType> extends MathArray<VectorType> {
-  // VIRTUAL METHODS
-  // copy(vector) {
-
-  // ACCESSORS
-
-  x: number;
-  y: number;
-
-  // NOTE: `length` is a reserved word for Arrays, so we can't use `v.length()`
-  len(): number;
-  magnitude(): number;
-  lengthSquared(): number;
-  magnitudeSquared(): number;
-
-  distance(mathArray): number;
-
-  distanceSquared(mathArray): number;
-
-  dot(mathArray): number;
-  // MODIFIERS
-
-  normalize(): VectorType;
-
-  multiply(...vectors): VectorType;
-
-  divide(...vectors): VectorType;
-
-  // THREE.js compatibility
-  lengthSq(): number;
-  distanceTo(vector: VectorType): number;
-  distanceToSquared(vector): number;
-
-  getComponent(i): number;
-  setComponent(i, value): number;
-
-  addVectors(a: VectorType, b: VectorType): VectorType;
-  subVectors(a: VectorType, b: VectorType): VectorType;
-  multiplyVectors(a: VectorType, b: VectorType): VectorType;
-
-  addScaledVector(a: VectorType, b: VectorType): VectorType;
-}

package/dist/es5/classes/euler.d.ts

@@ -1,92 +0,0 @@
-import MathArray from './base/math-array';
-import Quaternion from './quaternion';
-import Matrix3 from './matrix3';
-
-export default class Euler extends MathArray<Euler> {
-  static ZYX: number;
-  static YXZ: number;
-  static XZY: number;
-  static ZXY: number;
-  static YZX: number;
-  static XYZ: number;
-  static RollPitchYaw: number;
-  static DefaultOrder: number;
-  static RotationOrders: string[];
-
-  static rotationOrder(order: number): string;
-
-  ELEMENTS: number;
-
-  /**
-   * @class
-   * @param {Number | Number[]} x
-   * @param {Number=} [y]
-   * @param {Number=} [z]
-   * @param {Number=} [order]
-   */
-  constructor();
-  constructor(x: number, y: number, z: number, order?: number);
-  constructor(vector3: number[], order?: number);
-
-  fromQuaternion(quaternion: Quaternion): Euler;
-
-  // If copied array does contain fourth element, preserves currently set order
-  copy(array: number[]): Euler;
-
-  // Sets the three angles, and optionally sets the rotation order
-  // If order is not specified, preserves currently set order
-  set(x: number, y: number, z: number, order?: number): Euler;
-
-  validate(): boolean;
-
-  // Does not copy the orientation element
-  toArray(array?: number[], offset?: number): number[];
-
-  // Copies the orientation element
-  toArray4(array?: number[], offset?: number): number[];
-
-  toVector3(result?: number[]): number[];
-
-  // x, y, z angle notation (note: only corresponds to axis in XYZ orientation)
-  x: number;
-  y: number;
-  z: number;
-
-  // alpha, beta, gamma angle notation
-  alpha: number;
-  beta: number;
-  gamma: number;
-
-  // phi, theta, psi angle notation
-  phi: number;
-  theta: number;
-  psi: number;
-
-  // roll, pitch, yaw angle notation
-  roll: number;
-  pitch: number;
-  yaw: number;
-
-  // rotation order, in all three angle notations
-  order: number;
-
-  /* eslint-disable no-multi-spaces, brace-style, no-return-assign */
-
-  // Constructors
-  fromVector3(v: number[], order: number): Euler;
-  // TODO - with and without 4th element
-  fromArray(array: number[], offset?: number): Euler;
-
-  // Common ZYX rotation order
-  fromRollPitchYaw(roll: number, pitch: number, yaw: number): Euler;
-  fromRotationMatrix(m: number[], order?: number): Euler;
-
-  // ACCESSORS
-
-  getRotationMatrix(m: Matrix3): Matrix3;
-  getRotationMatrix(m?: number[]): number[];
-
-  // TODO - move to Quaternion
-  getQuaternion(): Quaternion;
-  toQuaternion(): Quaternion;
-}

package/dist/es5/classes/matrix3.d.ts

@@ -1,91 +0,0 @@
-import Matrix from './base/matrix';
-// import Quaternion from './quaternion';
-
-export default class Matrix3 extends Matrix<Matrix3> {
-  static IDENTITY: Matrix3;
-  static ZERO: Matrix3;
-
-  // inherited
-  get ELEMENTS(): number;
-  get RANK(): number;
-  INDICES: number[];
-
-  constructor();
-  constructor(array: number[]);
-  constructor(
-    m00: number,
-    m10: number,
-    m20: number,
-    m01: number,
-    m11: number,
-    m21: number,
-    m02: number,
-    m12: number,
-    m22: number
-  );
-
-  copy(array): Matrix3;
-
-  // 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
-  );
-
-  // 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
-  );
-  setRowMajor(...array: number[]);
-
-  // Accessors
-  determinant(): number;
-
-  // Constructors
-  identity(): Matrix3;
-
-  // Calculates a 3x3 matrix from the given quaternion
-  // q quat  Quaternion to create matrix from
-  fromQuaternion(q: number[]): Matrix3;
-
-  // Modifiers
-  transpose(): Matrix3;
-  invert(): Matrix3;
-
-  // Operations
-  multiplyLeft(a: Matrix3): Matrix3;
-  multiplyRight(a: Matrix3): Matrix3;
-
-  rotate(radians: number): Matrix3;
-
-  scale(scale: number): Matrix3;
-  scale([scaleX, scaleY, scaleZ]: number[]): Matrix3;
-
-  translate(vec): Matrix3;
-
-  // Transforms
-
-  transform(vector: number[], result?: number[]): number[];
-
-  // DEPRECATED IN 3.0
-  transformVector(vector, result);
-  transformVector2(vector, result);
-  transformVector3(vector, result);
-}