@math.gl/culling 3.6.0-alpha.4 → 3.6.0-alpha.7

package/dist/lib/perspective-off-center-frustum.js

@@ -3,7 +3,6 @@
 // Note: This class is still an experimental export, mainly used by other test cases
 // - It has not been fully adapted to math.gl conventions
 // - Documentation has not been ported
-// @ts-nocheck
 import { Vector3, Matrix4, assert } from '@math.gl/core';
 import CullingVolume from './culling-volume';
 import Plane from './plane';
@@ -20,15 +19,6 @@ export default class PerspectiveOffCenterFrustum {
      * plane from the origin/camera position.
      *
      * @alias PerspectiveOffCenterFrustum
-     * @constructor
-     *
-     * @param {Object} [options] An object with the following properties:
-     * @param {Number} [options.left] The left clipping plane distance.
-     * @param {Number} [options.right] The right clipping plane distance.
-     * @param {Number} [options.top] The top clipping plane distance.
-     * @param {Number} [options.bottom] The bottom clipping plane distance.
-     * @param {Number} [options.near=1.0] The near clipping plane distance.
-     * @param {Number} [options.far=500000000.0] The far clipping plane distance.
      *
      * @example
      * const frustum = new PerspectiveOffCenterFrustum({
@@ -53,49 +43,19 @@ export default class PerspectiveOffCenterFrustum {
         ]);
         this._perspectiveMatrix = new Matrix4();
         this._infinitePerspective = new Matrix4();
-        options = { near: 1.0, far: 500000000.0, ...options };
-        /**
-         * Defines the left clipping plane.
-         * @type {Number}
-         * @default undefined
-         */
+        const { near = 1.0, far = 500000000.0 } = options;
         this.left = options.left;
         this._left = undefined;
-        /**
-         * Defines the right clipping plane.
-         * @type {Number}
-         * @default undefined
-         */
         this.right = options.right;
         this._right = undefined;
-        /**
-         * Defines the top clipping plane.
-         * @type {Number}
-         * @default undefined
-         */
         this.top = options.top;
         this._top = undefined;
-        /**
-         * Defines the bottom clipping plane.
-         * @type {Number}
-         * @default undefined
-         */
         this.bottom = options.bottom;
         this._bottom = undefined;
-        /**
-         * The distance of the near plane.
-         * @type {Number}
-         * @default 1.0
-         */
-        this.near = options.near;
-        this._near = this.near;
-        /**
-         * The distance of the far plane.
-         * @type {Number}
-         * @default 500000000.0
-         */
-        this.far = options.far;
-        this._far = this.far;
+        this.near = near;
+        this._near = near;
+        this.far = far;
+        this._far = far;
     }
     /**
      * Returns a duplicate of a PerspectiveOffCenterFrustum instance.
@@ -115,7 +75,6 @@ export default class PerspectiveOffCenterFrustum {
      * Compares the provided PerspectiveOffCenterFrustum componentwise and returns
      * <code>true</code> if they are equal, <code>false</code> otherwise.
      *
-     * @param {PerspectiveOffCenterFrustum} [other] The right hand side PerspectiveOffCenterFrustum.
      * @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
      */
     equals(other) {
@@ -136,7 +95,7 @@ export default class PerspectiveOffCenterFrustum {
      * @see PerspectiveOffCenterFrustum#infiniteProjectionMatrix
      */
     get projectionMatrix() {
-        update(this);
+        this._update();
         return this._perspectiveMatrix;
     }
     /**
@@ -147,15 +106,11 @@ export default class PerspectiveOffCenterFrustum {
      * @see PerspectiveOffCenterFrustum#projectionMatrix
      */
     get infiniteProjectionMatrix() {
-        update(this);
+        this._update();
         return this._infinitePerspective;
     }
     /**
      * Creates a culling volume for this frustum.
-     *
-     * @param {Vector3} position The eye position.
-     * @param {Vector3} direction The view direction.
-     * @param {Vector3} up The up direction.
      * @returns {CullingVolume} A culling volume at the given position and orientation.
      *
      * @example
@@ -164,7 +119,13 @@ export default class PerspectiveOffCenterFrustum {
      * const intersect = cullingVolume.computeVisibility(boundingVolume);
      */
     // eslint-disable-next-line complexity, max-statements
-    computeCullingVolume(position, direction, up) {
+    computeCullingVolume(
+    /** A Vector3 defines the eye position. */
+    position, 
+    /** A Vector3 defines the view direction. */
+    direction, 
+    /** A Vector3 defines the up direction. */
+    up) {
         assert(position, 'position is required.');
         assert(direction, 'direction is required.');
         assert(up, 'up is required.');
@@ -215,10 +176,6 @@ export default class PerspectiveOffCenterFrustum {
     /**
      * Returns the pixel's width and height in meters.
      *
-     * @param {Number} drawingBufferWidth The width of the drawing buffer.
-     * @param {Number} drawingBufferHeight The height of the drawing buffer.
-     * @param {Number} distance The distance to the near plane in meters.
-     * @param {Vector2} result The object onto which to store the result.
      * @returns {Vector2} The modified result parameter or a new instance of {@link Vector2} with the pixel's width and height in the x and y properties, respectively.
      *
      * @exception {DeveloperError} drawingBufferWidth must be greater than zero.
@@ -240,8 +197,16 @@ export default class PerspectiveOffCenterFrustum {
      * const distance = Vector3.magnitude(toCenterProj);
      * const pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, distance, new Vector2());
      */
-    getPixelDimensions(drawingBufferWidth, drawingBufferHeight, distance, result) {
-        update(this);
+    getPixelDimensions(
+    /** The width of the drawing buffer. */
+    drawingBufferWidth, 
+    /** The height of the drawing buffer. */
+    drawingBufferHeight, 
+    /** The distance to the near plane in meters. */
+    distance, 
+    /** The object onto which to store the result. */
+    result) {
+        this._update();
         assert(Number.isFinite(drawingBufferWidth) && Number.isFinite(drawingBufferHeight));
         // 'Both drawingBufferWidth and drawingBufferHeight are required.'
         assert(drawingBufferWidth > 0);
@@ -261,45 +226,45 @@ export default class PerspectiveOffCenterFrustum {
         result.y = pixelHeight;
         return result;
     }
-}
-// eslint-disable-next-line complexity, max-statements
-function update(frustum) {
-    assert(Number.isFinite(frustum.right) &&
-        Number.isFinite(frustum.left) &&
-        Number.isFinite(frustum.top) &&
-        Number.isFinite(frustum.bottom) &&
-        Number.isFinite(frustum.near) &&
-        Number.isFinite(frustum.far));
-    // throw new DeveloperError('right, left, top, bottom, near, or far parameters are not set.');
-    const { top, bottom, right, left, near, far } = frustum;
-    if (top !== frustum._top ||
-        bottom !== frustum._bottom ||
-        left !== frustum._left ||
-        right !== frustum._right ||
-        near !== frustum._near ||
-        far !== frustum._far) {
-        assert(frustum.near > 0 && frustum.near < frustum.far, 'near must be greater than zero and less than far.');
-        frustum._left = left;
-        frustum._right = right;
-        frustum._top = top;
-        frustum._bottom = bottom;
-        frustum._near = near;
-        frustum._far = far;
-        frustum._perspectiveMatrix = new Matrix4().frustum({
-            left,
-            right,
-            bottom,
-            top,
-            near,
-            far
-        });
-        frustum._infinitePerspective = new Matrix4().frustum({
-            left,
-            right,
-            bottom,
-            top,
-            near,
-            far: Infinity
-        });
+    // eslint-disable-next-line complexity, max-statements
+    _update() {
+        assert(Number.isFinite(this.right) &&
+            Number.isFinite(this.left) &&
+            Number.isFinite(this.top) &&
+            Number.isFinite(this.bottom) &&
+            Number.isFinite(this.near) &&
+            Number.isFinite(this.far));
+        // throw new DeveloperError('right, left, top, bottom, near, or far parameters are not set.');
+        const { top, bottom, right, left, near, far } = this;
+        if (top !== this._top ||
+            bottom !== this._bottom ||
+            left !== this._left ||
+            right !== this._right ||
+            near !== this._near ||
+            far !== this._far) {
+            assert(this.near > 0 && this.near < this.far, 'near must be greater than zero and less than far.');
+            this._left = left;
+            this._right = right;
+            this._top = top;
+            this._bottom = bottom;
+            this._near = near;
+            this._far = far;
+            this._perspectiveMatrix = new Matrix4().frustum({
+                left,
+                right,
+                bottom,
+                top,
+                near,
+                far
+            });
+            this._infinitePerspective = new Matrix4().frustum({
+                left,
+                right,
+                bottom,
+                top,
+                near,
+                far: Infinity
+            });
+        }
     }
 }

package/dist/lib/plane.d.ts

@@ -1,12 +1,12 @@
-import { Vector3 } from '@math.gl/core';
+import { Vector3, NumericArray } from '@math.gl/core';
 export default class Plane {
     readonly normal: Vector3;
     distance: number;
-    constructor(normal?: readonly number[], distance?: number);
+    constructor(normal?: Readonly<NumericArray>, distance?: number);
     /** Creates a plane from a normal and a distance from the origin. */
-    fromNormalDistance(normal: readonly number[], distance: number): this;
+    fromNormalDistance(normal: Readonly<NumericArray>, distance: number): this;
     /** Creates a plane from a normal and a point on the plane. */
-    fromPointNormal(point: readonly number[], normal: readonly number[]): this;
+    fromPointNormal(point: Readonly<NumericArray>, normal: Readonly<NumericArray>): this;
     /** Creates a plane from the general equation */
     fromCoefficients(a: number, b: number, c: number, d: number): this;
     /** Duplicates a Plane instance. */
@@ -16,11 +16,11 @@ export default class Plane {
     /** Computes the signed shortest distance of a point to a plane.
      * The sign of the distance determines which side of the plane the point is on.
      */
-    getPointDistance(point: readonly number[]): number;
+    getPointDistance(point: Readonly<NumericArray>): number;
     /** Transforms the plane by the given transformation matrix. */
-    transform(matrix4: readonly number[]): this;
+    transform(matrix4: Readonly<NumericArray>): this;
     /** Projects a point onto the plane. */
-    projectPointOntoPlane(point: readonly number[], result: Vector3): Vector3;
-    projectPointOntoPlane(point: readonly number[], result?: readonly number[]): readonly number[];
+    projectPointOntoPlane(point: Readonly<NumericArray>, result: Vector3): Vector3;
+    projectPointOntoPlane(point: Readonly<NumericArray>, result?: readonly number[]): readonly number[];
 }
 //# sourceMappingURL=plane.d.ts.map

package/dist/lib/plane.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plane.d.ts","sourceRoot":"","sources":["../../src/lib/plane.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,OAAO,EAAiB,MAAM,eAAe,CAAC;AAMtD,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;gBAEL,MAAM,GAAE,SAAS,MAAM,EAAc,EAAE,QAAQ,GAAE,MAAU;IAMvE,oEAAoE;IACpE,kBAAkB,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAOrE,8DAA8D;IAC9D,eAAe,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAQ1E,gDAAgD;IAChD,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAOlE,mCAAmC;IACnC,KAAK,IAAI,KAAK;IAId,0DAA0D;IAC1D,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAI7B;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM;IAIlD,+DAA+D;IAC/D,SAAS,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAM3C,uCAAuC;IACvC,qBAAqB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO;IACzE,qBAAqB,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,MAAM,EAAE;CAU/F"}
+{"version":3,"file":"plane.d.ts","sourceRoot":"","sources":["../../src/lib/plane.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,OAAO,EAAkB,YAAY,EAAC,MAAM,eAAe,CAAC;AAMpE,MAAM,CAAC,OAAO,OAAO,KAAK;IACxB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;gBAEL,MAAM,GAAE,QAAQ,CAAC,YAAY,CAAa,EAAE,QAAQ,GAAE,MAAU;IAM5E,oEAAoE;IACpE,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAO1E,8DAA8D;IAC9D,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAQpF,gDAAgD;IAChD,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAOlE,mCAAmC;IACnC,KAAK,IAAI,KAAK;IAId,0DAA0D;IAC1D,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO;IAI7B;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,MAAM;IAIvD,+DAA+D;IAC/D,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAMhD,uCAAuC;IACvC,qBAAqB,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO;IAC9E,qBAAqB,CACnB,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,EAC7B,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,GACzB,SAAS,MAAM,EAAE;CAUrB"}

package/package.json

@@ -5,7 +5,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "3.6.0-alpha.4",
+  "version": "3.6.0-alpha.7",
   "keywords": [
     "webgl",
     "javascript",
@@ -35,8 +35,8 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.12.0",
-    "@math.gl/core": "3.6.0-alpha.4",
+    "@math.gl/core": "3.6.0-alpha.7",
     "gl-matrix": "^3.4.0"
   },
-  "gitHead": "d2ce86da8b6f07f0af0236818138442f68e1d8e4"
+  "gitHead": "166f7411d07d545e6a3f247b55b56f5cb8efccde"
 }

package/src/lib/algorithms/compute-eigen-decomposition.ts

@@ -85,7 +85,7 @@ export default function computeEigenDecomposition(
   return result;
 }
 
-function computeFrobeniusNorm(matrix) {
+function computeFrobeniusNorm(matrix: Matrix3): number {
   let norm = 0.0;
   for (let i = 0; i < 9; ++i) {
     const temp = matrix[i];
@@ -99,7 +99,7 @@ const colVal = [2, 2, 1];
 
 // Computes the "off-diagonal" Frobenius norm.
 // Assumes matrix is symmetric.
-function offDiagonalFrobeniusNorm(matrix) {
+function offDiagonalFrobeniusNorm(matrix: Matrix3): number {
   let norm = 0.0;
   for (let i = 0; i < 3; ++i) {
     const temp = matrix[scratchMatrix.getElementIndex(colVal[i], rowVal[i])];
@@ -116,7 +116,7 @@ function offDiagonalFrobeniusNorm(matrix) {
 // section 8.4.2 The 2by2 Symmetric Schur Decomposition.
 //
 // eslint-disable-next-line max-statements
-function shurDecomposition(matrix, result) {
+function shurDecomposition(matrix: Matrix3, result: Matrix3): Matrix3 {
   const tolerance = _MathUtils.EPSILON15;
 
   let maxDiagonal = 0.0;

package/src/lib/bounding-volumes/axis-aligned-bounding-box.ts

@@ -58,7 +58,7 @@ export default class AxisAlignedBoundingBox implements BoundingVolume {
    *
    * @returns {AxisAlignedBoundingBox} A new AxisAlignedBoundingBox instance.
    */
-  clone() {
+  clone(): AxisAlignedBoundingBox {
     return new AxisAlignedBoundingBox(this.minimum, this.maximum, this.center);
   }
 
@@ -69,7 +69,7 @@ export default class AxisAlignedBoundingBox implements BoundingVolume {
    * @param {AxisAlignedBoundingBox} [right] The second AxisAlignedBoundingBox to compare with.
    * @returns {Boolean} <code>true</code> if left and right are equal, <code>false</code> otherwise.
    */
-  equals(right) {
+  equals(right: AxisAlignedBoundingBox): boolean {
     return (
       this === right ||
       (Boolean(right) && this.minimum.equals(right.minimum) && this.maximum.equals(right.maximum))

package/src/lib/bounding-volumes/oriented-bounding-box.ts

@@ -1,7 +1,7 @@
 // This file is derived from the Cesium math library under Apache 2 license
 // See LICENSE.md and https://github.com/AnalyticalGraphicsInc/cesium/blob/master/LICENSE.md
 
-import {Vector3, Matrix3, Quaternion, NumericArray} from '@math.gl/core';
+import {Vector3, Matrix3, Matrix4, Quaternion, NumericArray} from '@math.gl/core';
 import type {BoundingVolume} from './bounding-volume';
 import BoundingSphere from './bounding-sphere';
 import type Plane from '../plane';
@@ -336,7 +336,7 @@ export default class OrientedBoundingBox implements BoundingVolume {
     return this;
   }
 
-  getTransform() {
+  getTransform(): Matrix4 {
     // const modelMatrix = Matrix4.fromRotationTranslation(this.boundingVolume.halfAxes, this.boundingVolume.center);
     // return modelMatrix;
     throw new Error('not implemented');