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

package/src/lib/gl-matrix.d.ts

@@ -0,0 +1,266 @@
+type NumericArray =
+  | Int8Array
+  | Uint8Array
+  | Int16Array
+  | Uint16Array
+  | Int32Array
+  | Uint32Array
+  | Uint8ClampedArray
+  | Float32Array
+  | Float64Array
+  | number[];
+
+declare module 'gl-matrix/vec2' {
+  function length(a: Readonly<NumericArray>): number;
+  function negate<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function add<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function sub<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function scale<T extends NumericArray>(out: T, a: Readonly<NumericArray>, b: number): T;
+  function lerp<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>,
+    t: number
+  ): T;
+  function transformMat2<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    m: Readonly<NumericArray>
+  ): T;
+  function transformMat2d<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    m: Readonly<NumericArray>
+  ): T;
+  function transformMat3<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    m: Readonly<NumericArray>
+  ): T;
+  function transformMat4<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    m: Readonly<NumericArray>
+  ): T;
+}
+
+declare module 'gl-matrix/vec3' {
+  function length(a: Readonly<NumericArray>): number;
+  function angle(a: Readonly<NumericArray>, b: Readonly<NumericArray>): number;
+  function dot(a: Readonly<NumericArray>, b: Readonly<NumericArray>): number;
+  function negate<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function add<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function sub<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function mul<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function cross<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function rotateX<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>,
+    rad: number
+  ): T;
+  function rotateY<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>,
+    rad: number
+  ): T;
+  function rotateZ<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>,
+    rad: number
+  ): T;
+  function transformMat3<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    m: Readonly<NumericArray>
+  ): T;
+  function transformMat4<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    m: Readonly<NumericArray>
+  ): T;
+  function transformQuat<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    q: Readonly<NumericArray>
+  ): T;
+}
+
+declare module 'gl-matrix/vec4' {
+  function length(a: Readonly<NumericArray>): number;
+  function negate<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function scale<T extends NumericArray>(out: T, a: Readonly<NumericArray>, b: number): T;
+  function transformMat4<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    m: Readonly<NumericArray>
+  ): T;
+  function transformQuat<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    q: Readonly<NumericArray>
+  ): T;
+}
+
+declare module 'gl-matrix/mat3' {
+  function determinant(a: Readonly<NumericArray>): number;
+  function fromQuat<T extends NumericArray>(out: T, q: Readonly<NumericArray>): T;
+  function transpose<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function invert<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function translate<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    v: Readonly<NumericArray>
+  ): T;
+  function scale<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    v: Readonly<NumericArray>
+  ): T;
+  function rotate<T extends NumericArray>(out: T, a: Readonly<NumericArray>, rad: number): T;
+  function multiply<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+}
+
+declare module 'gl-matrix/mat4' {
+  function determinant(a: Readonly<NumericArray>): number;
+  function fromQuat<T extends NumericArray>(out: T, q: Readonly<NumericArray>): T;
+  function transpose<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function invert<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function getRotation<T extends NumericArray>(out: T, mat: Readonly<NumericArray>): T;
+  function getScaling<T extends NumericArray>(out: T, mat: Readonly<NumericArray>): T;
+  function getTranslation<T extends NumericArray>(out: T, mat: Readonly<NumericArray>): T;
+  function equals(a: Readonly<NumericArray>, b: Readonly<NumericArray>): boolean;
+  function translate<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    v: Readonly<NumericArray>
+  ): T;
+  function scale<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    v: Readonly<NumericArray>
+  ): T;
+  function rotate<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    rad: number,
+    axis: Readonly<NumericArray>
+  ): T;
+  function rotateX<T extends NumericArray>(out: T, a: Readonly<NumericArray>, rad: number): T;
+  function rotateY<T extends NumericArray>(out: T, a: Readonly<NumericArray>, rad: number): T;
+  function rotateZ<T extends NumericArray>(out: T, a: Readonly<NumericArray>, rad: number): T;
+  function multiply<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function lookAt<T extends NumericArray>(
+    out: T,
+    eye: Readonly<NumericArray>,
+    center: Readonly<NumericArray>,
+    up: Readonly<NumericArray>
+  ): T;
+  function perspective<T extends NumericArray>(
+    out: T,
+    fovy: number,
+    aspect: number,
+    near: number,
+    far: number
+  ): T;
+  function frustum<T extends NumericArray>(
+    out: T,
+    left: number,
+    right: number,
+    bottom: number,
+    top: number,
+    near: number,
+    far: number
+  ): T;
+  function ortho<T extends NumericArray>(
+    out: T,
+    left: number,
+    right: number,
+    bottom: number,
+    top: number,
+    near: number,
+    far: number
+  ): T;
+}
+
+declare module 'gl-matrix/quat' {
+  function identity<T extends NumericArray>(out: T): T;
+  function length(a: Readonly<NumericArray>): number;
+  function squaredLength(a: Readonly<NumericArray>): number;
+  function fromMat3<T extends NumericArray>(out: T, m: Readonly<NumericArray>): T;
+  function setAxisAngle<T extends NumericArray>(
+    out: T,
+    axis: Readonly<NumericArray>,
+    rad: number
+  ): T;
+  function rotationTo<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function add<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function dot(a: Readonly<NumericArray>, b: Readonly<NumericArray>): number;
+  function invert<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function calculateW<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+  function conjugate<T extends NumericArray>(out: T, a: Readonly<NumericArray>): T;
+
+  function lerp<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>,
+    t: number
+  ): T;
+  function slerp<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>,
+    t: number
+  ): T;
+  function scale<T extends NumericArray>(out: T, a: Readonly<NumericArray>, b: number): T;
+  function multiply<T extends NumericArray>(
+    out: T,
+    a: Readonly<NumericArray>,
+    b: Readonly<NumericArray>
+  ): T;
+  function rotateX<T extends NumericArray>(out: T, a: Readonly<NumericArray>, rad: number): T;
+  function rotateY<T extends NumericArray>(out: T, a: Readonly<NumericArray>, rad: number): T;
+  function rotateZ<T extends NumericArray>(out: T, a: Readonly<NumericArray>, rad: number): T;
+}

package/src/lib/{validators.js → validators.ts}

@@ -17,10 +17,10 @@
 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
-
+import {NumberArray} from '@math.gl/types';
 import {config} from './common';
 
-export function validateVector(v, length) {
+export function validateVector(v: NumberArray, length: number): boolean {
   if (v.length !== length) {
     return false;
   }
@@ -33,14 +33,18 @@ export function validateVector(v, length) {
   return true;
 }
 
-export function checkNumber(value) {
+export function checkNumber(value: any): number {
   if (!Number.isFinite(value)) {
     throw new Error(`Invalid number ${value}`);
   }
-  return value;
+  return value as number;
 }
 
-export function checkVector(v, length, callerName = '') {
+export function checkVector<T extends NumberArray>(
+  v: T,
+  length: number,
+  callerName: string = ''
+): T {
   if (config.debug && !validateVector(v, length)) {
     throw new Error(`math.gl: ${callerName} some fields set to invalid numbers'`);
   }
@@ -49,7 +53,7 @@ export function checkVector(v, length, callerName = '') {
 
 const map = {};
 
-export function deprecated(method, version) {
+export function deprecated(method: string, version: string): void {
   if (!map[method]) {
     map[method] = true;
     // eslint-disable-next-line

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);
-}