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

package/dist/classes/spherical-coordinates.js

@@ -1,155 +1,150 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// Copyright (c) 2017 Uber Technologies, Inc.
 import { Vector3 } from "./vector3.js";
 import { formatValue, equals, config } from "../lib/common.js";
 import { degrees, radians, clamp } from "../lib/common.js";
+// @ts-ignore gl-matrix types...
 import * as vec3 from "../gl-matrix/vec3.js";
+// TODO - import epsilon
 const EPSILON = 0.000001;
 const EARTH_RADIUS_METERS = 6371000;
+/**
+ * The poles (phi) are at the positive and negative y axis.
+ * The equator starts at positive z.
+ * @link https://en.wikipedia.org/wiki/Spherical_coordinate_system
+ */
 export class SphericalCoordinates {
-  constructor({
-    phi = 0,
-    theta = 0,
-    radius = 1,
-    bearing,
-    pitch,
-    altitude,
-    radiusScale = EARTH_RADIUS_METERS
-  } = {}) {
-    _defineProperty(this, "phi", void 0);
-
-    _defineProperty(this, "theta", void 0);
-
-    _defineProperty(this, "radius", void 0);
-
-    _defineProperty(this, "radiusScale", void 0);
-
-    this.phi = phi;
-    this.theta = theta;
-    this.radius = radius || altitude || 1;
-    this.radiusScale = radiusScale || 1;
-
-    if (bearing !== undefined) {
-      this.bearing = bearing;
-    }
-
-    if (pitch !== undefined) {
-      this.pitch = pitch;
-    }
-
-    this.check();
-  }
-
-  toString() {
-    return this.formatString(config);
-  }
-
-  formatString({
-    printTypes = false
-  }) {
-    const f = formatValue;
-    return "".concat(printTypes ? 'Spherical' : '', "[rho:").concat(f(this.radius), ",theta:").concat(f(this.theta), ",phi:").concat(f(this.phi), "]");
-  }
-
-  equals(other) {
-    return equals(this.radius, other.radius) && equals(this.theta, other.theta) && equals(this.phi, other.phi);
-  }
-
-  exactEquals(other) {
-    return this.radius === other.radius && this.theta === other.theta && this.phi === other.phi;
-  }
-
-  get bearing() {
-    return 180 - degrees(this.phi);
-  }
-
-  set bearing(v) {
-    this.phi = Math.PI - radians(v);
-  }
-
-  get pitch() {
-    return degrees(this.theta);
-  }
-
-  set pitch(v) {
-    this.theta = radians(v);
-  }
-
-  get longitude() {
-    return degrees(this.phi);
-  }
-
-  get latitude() {
-    return degrees(this.theta);
-  }
-
-  get lng() {
-    return degrees(this.phi);
-  }
-
-  get lat() {
-    return degrees(this.theta);
-  }
-
-  get z() {
-    return (this.radius - 1) * this.radiusScale;
-  }
-
-  set(radius, phi, theta) {
-    this.radius = radius;
-    this.phi = phi;
-    this.theta = theta;
-    return this.check();
-  }
-
-  clone() {
-    return new SphericalCoordinates().copy(this);
-  }
-
-  copy(other) {
-    this.radius = other.radius;
-    this.phi = other.phi;
-    this.theta = other.theta;
-    return this.check();
-  }
-
-  fromLngLatZ([lng, lat, z]) {
-    this.radius = 1 + z / this.radiusScale;
-    this.phi = radians(lat);
-    this.theta = radians(lng);
-    return this.check();
-  }
-
-  fromVector3(v) {
-    this.radius = vec3.length(v);
-
-    if (this.radius > 0) {
-      this.theta = Math.atan2(v[0], v[1]);
-      this.phi = Math.acos(clamp(v[2] / this.radius, -1, 1));
-    }
-
-    return this.check();
-  }
-
-  toVector3() {
-    return new Vector3(0, 0, this.radius).rotateX({
-      radians: this.theta
-    }).rotateZ({
-      radians: this.phi
-    });
-  }
-
-  makeSafe() {
-    this.phi = Math.max(EPSILON, Math.min(Math.PI - EPSILON, this.phi));
-    return this;
-  }
-
-  check() {
-    if (!Number.isFinite(this.phi) || !Number.isFinite(this.theta) || !(this.radius > 0)) {
-      throw new Error('SphericalCoordinates: some fields set to invalid numbers');
-    }
-
-    return this;
-  }
-
+    // bearing: number;
+    // pitch: number;
+    // altitude: number;
+    // lnglatZ coordinates
+    // longitude: number;
+    // latitude: number;
+    // lng: number;
+    // lat: number;
+    // z: number;
+    /**
+     * Creates a new SphericalCoordinates object
+     * @param options
+     * @param [options.phi] =0 - rotation around X (latitude)
+     * @param [options.theta] =0 - rotation around Y (longitude)
+     * @param [options.radius] =1 - Distance from center
+     * @param [options.bearing]
+     * @param [options.pitch]
+     * @param [options.altitude]
+     * @param [options.radiusScale] =1
+     */
+    // eslint-disable-next-line complexity
+    constructor({ phi = 0, theta = 0, radius = 1, bearing, pitch, altitude, radiusScale = EARTH_RADIUS_METERS } = {}) {
+        this.phi = phi;
+        this.theta = theta;
+        // TODO - silently accepts illegal 0
+        this.radius = radius || altitude || 1; // radial distance from center
+        this.radiusScale = radiusScale || 1; // Used by lngLatZ
+        if (bearing !== undefined) {
+            this.bearing = bearing; // up / down towards top and bottom pole
+        }
+        if (pitch !== undefined) {
+            this.pitch = pitch; // around the equator of the sphere
+        }
+        this.check();
+    }
+    toString() {
+        return this.formatString(config);
+    }
+    formatString({ printTypes = false }) {
+        const f = formatValue;
+        return `${printTypes ? 'Spherical' : ''}\
+[rho:${f(this.radius)},theta:${f(this.theta)},phi:${f(this.phi)}]`;
+    }
+    equals(other) {
+        return (equals(this.radius, other.radius) &&
+            equals(this.theta, other.theta) &&
+            equals(this.phi, other.phi));
+    }
+    exactEquals(other) {
+        return this.radius === other.radius && this.theta === other.theta && this.phi === other.phi;
+    }
+    /* eslint-disable brace-style */
+    // Cartographic (bearing 0 north, pitch 0 look from above)
+    get bearing() {
+        return 180 - degrees(this.phi);
+    }
+    set bearing(v) {
+        this.phi = Math.PI - radians(v);
+    }
+    get pitch() {
+        return degrees(this.theta);
+    }
+    set pitch(v) {
+        this.theta = radians(v);
+    }
+    // get pitch() { return 90 - degrees(this.phi); }
+    // set pitch(v) { this.phi = radians(v) + Math.PI / 2; }
+    // get altitude() { return this.radius - 1; } // relative altitude
+    // lnglatZ coordinates
+    get longitude() {
+        return degrees(this.phi);
+    }
+    get latitude() {
+        return degrees(this.theta);
+    }
+    get lng() {
+        return degrees(this.phi);
+    }
+    get lat() {
+        return degrees(this.theta);
+    }
+    get z() {
+        return (this.radius - 1) * this.radiusScale;
+    }
+    /* eslint-enable brace-style */
+    set(radius, phi, theta) {
+        this.radius = radius;
+        this.phi = phi;
+        this.theta = theta;
+        return this.check();
+    }
+    clone() {
+        return new SphericalCoordinates().copy(this);
+    }
+    copy(other) {
+        this.radius = other.radius;
+        this.phi = other.phi;
+        this.theta = other.theta;
+        return this.check();
+    }
+    fromLngLatZ([lng, lat, z]) {
+        this.radius = 1 + z / this.radiusScale;
+        this.phi = radians(lat);
+        this.theta = radians(lng);
+        return this.check();
+    }
+    fromVector3(v) {
+        this.radius = vec3.length(v);
+        if (this.radius > 0) {
+            this.theta = Math.atan2(v[0], v[1]); // equator angle around y-up axis
+            this.phi = Math.acos(clamp(v[2] / this.radius, -1, 1)); // polar angle
+        }
+        return this.check();
+    }
+    toVector3() {
+        return new Vector3(0, 0, this.radius)
+            .rotateX({ radians: this.theta })
+            .rotateZ({ radians: this.phi });
+    }
+    // restrict phi to be betwee EPS and PI-EPS
+    makeSafe() {
+        this.phi = Math.max(EPSILON, Math.min(Math.PI - EPSILON, this.phi));
+        return this;
+    }
+    check() {
+        // this.makeSafe();
+        if (!Number.isFinite(this.phi) || !Number.isFinite(this.theta) || !(this.radius > 0)) {
+            throw new Error('SphericalCoordinates: some fields set to invalid numbers');
+        }
+        return this;
+    }
 }
-//# sourceMappingURL=spherical-coordinates.js.map

package/dist/classes/vector2.d.ts

@@ -1,8 +1,10 @@
-import { Vector } from './base/vector';
-import { NumericArray } from '@math.gl/types';
+import { NumericArray, NumberArray2 } from '@math.gl/types';
+import { Vector } from "./base/vector.js";
+/** Helper type that captures array length for a 2 element vector */
+export type Vector2Like = Vector2 | NumberArray2;
 /**
- * Two-element vector class.
- * Subclass of Array<number>
+ * Two-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
  */
 export declare class Vector2 extends Vector {
     constructor(x?: number | Readonly<NumericArray>, y?: number);
@@ -52,4 +54,3 @@ export declare class Vector2 extends Vector {
     transformByMatrix2x3(matrix2x3: Readonly<NumericArray>): this;
     transformByMatrix2(matrix2: Readonly<NumericArray>): this;
 }
-//# sourceMappingURL=vector2.d.ts.map

package/dist/classes/vector2.js

@@ -1,94 +1,112 @@
+// 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";
 import { transformMat4 as vec2_transformMat4, transformMat3 as vec2_transformMat3, transformMat2d as vec2_transformMat2d, transformMat2 as vec2_transformMat2 } from "../gl-matrix/vec2.js";
 import { vec2_transformMat4AsVector } from "../lib/gl-matrix-extras.js";
+/**
+ * Two-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
+ */
 export class Vector2 extends Vector {
-  constructor(x = 0, y = 0) {
-    super(2);
-
-    if (isArray(x) && arguments.length === 1) {
-      this.copy(x);
-    } else {
-      if (config.debug) {
-        checkNumber(x);
-        checkNumber(y);
-      }
-
-      this[0] = x;
-      this[1] = y;
+    // Creates a new, empty vec2
+    constructor(x = 0, y = 0) {
+        // PERF NOTE: initialize elements as double precision numbers
+        super(2); // -0, -0);
+        if (isArray(x) && arguments.length === 1) {
+            this.copy(x);
+        }
+        else {
+            if (config.debug) {
+                checkNumber(x);
+                checkNumber(y);
+            }
+            this[0] = x;
+            this[1] = y;
+        }
     }
-  }
-
-  set(x, y) {
-    this[0] = x;
-    this[1] = y;
-    return this.check();
-  }
-
-  copy(array) {
-    this[0] = array[0];
-    this[1] = array[1];
-    return this.check();
-  }
-
-  fromObject(object) {
-    if (config.debug) {
-      checkNumber(object.x);
-      checkNumber(object.y);
+    set(x, y) {
+        this[0] = x;
+        this[1] = y;
+        return this.check();
+    }
+    copy(array) {
+        this[0] = array[0];
+        this[1] = array[1];
+        return this.check();
+    }
+    fromObject(object) {
+        if (config.debug) {
+            checkNumber(object.x);
+            checkNumber(object.y);
+        }
+        this[0] = object.x;
+        this[1] = object.y;
+        return this.check();
+    }
+    toObject(object) {
+        object.x = this[0];
+        object.y = this[1];
+        return object;
+    }
+    // Getters/setters
+    get ELEMENTS() {
+        return 2;
+    }
+    /**
+     * Returns angle from x axis
+     * @returns
+     */
+    horizontalAngle() {
+        return Math.atan2(this.y, this.x);
+    }
+    /**
+     * Returns angle from y axis
+     * @returns
+     */
+    verticalAngle() {
+        return Math.atan2(this.x, this.y);
+    }
+    // Transforms
+    /**
+     * Transforms as point
+     * @param matrix4
+     * @returns
+     */
+    transform(matrix4) {
+        return this.transformAsPoint(matrix4);
+    }
+    /**
+     * transforms as point (4th component is implicitly 1)
+     * @param matrix4
+     * @returns
+     */
+    transformAsPoint(matrix4) {
+        vec2_transformMat4(this, this, matrix4);
+        return this.check();
+    }
+    /**
+     * transforms as vector (4th component is implicitly 0, ignores translation. slightly faster)
+     * @param matrix4
+     * @returns
+     */
+    transformAsVector(matrix4) {
+        vec2_transformMat4AsVector(this, this, matrix4);
+        return this.check();
+    }
+    transformByMatrix3(matrix3) {
+        vec2_transformMat3(this, this, matrix3);
+        return this.check();
+    }
+    transformByMatrix2x3(matrix2x3) {
+        vec2_transformMat2d(this, this, matrix2x3);
+        return this.check();
+    }
+    transformByMatrix2(matrix2) {
+        vec2_transformMat2(this, this, matrix2);
+        return this.check();
     }
-
-    this[0] = object.x;
-    this[1] = object.y;
-    return this.check();
-  }
-
-  toObject(object) {
-    object.x = this[0];
-    object.y = this[1];
-    return object;
-  }
-
-  get ELEMENTS() {
-    return 2;
-  }
-
-  horizontalAngle() {
-    return Math.atan2(this.y, this.x);
-  }
-
-  verticalAngle() {
-    return Math.atan2(this.x, this.y);
-  }
-
-  transform(matrix4) {
-    return this.transformAsPoint(matrix4);
-  }
-
-  transformAsPoint(matrix4) {
-    vec2_transformMat4(this, this, matrix4);
-    return this.check();
-  }
-
-  transformAsVector(matrix4) {
-    vec2_transformMat4AsVector(this, this, matrix4);
-    return this.check();
-  }
-
-  transformByMatrix3(matrix3) {
-    vec2_transformMat3(this, this, matrix3);
-    return this.check();
-  }
-
-  transformByMatrix2x3(matrix2x3) {
-    vec2_transformMat2d(this, this, matrix2x3);
-    return this.check();
-  }
-
-  transformByMatrix2(matrix2) {
-    vec2_transformMat2(this, this, matrix2);
-    return this.check();
-  }
-
 }
-//# sourceMappingURL=vector2.js.map

package/dist/classes/vector3.d.ts

@@ -1,8 +1,10 @@
-import { NumericArray } from '@math.gl/types';
-import { Vector } from './base/vector';
+import { NumericArray, NumberArray3 } from '@math.gl/types';
+import { Vector } from "./base/vector.js";
+/** Helper type that captures array length for a 3 element vector */
+export type Vector3Like = Vector3 | NumberArray3;
 /**
- * Three-element vector class.
- * Subclass of Array<number>
+ * Three-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
  */
 export declare class Vector3 extends Vector {
     static get ZERO(): Vector3;
@@ -53,4 +55,3 @@ export declare class Vector3 extends Vector {
     transformByMatrix2(matrix2: Readonly<NumericArray>): this;
     transformByQuaternion(quaternion: Readonly<NumericArray>): this;
 }
-//# sourceMappingURL=vector3.d.ts.map