@math.gl/culling 3.6.0-alpha.3 → 3.6.0-alpha.6

package/dist/lib/perspective-frustum.js

@@ -3,8 +3,7 @@
 // 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 { assert } from '@math.gl/core';
+import { assert, Vector2 } from '@math.gl/core';
 import PerspectiveOffCenterFrustum from './perspective-off-center-frustum';
 const defined = (val) => val !== null && typeof val !== 'undefined';
 /**
@@ -14,15 +13,6 @@ const defined = (val) => val !== null && typeof val !== 'undefined';
  * plane from the origin/camera position.
  *
  * @alias PerspectiveFrustum
- * @constructor
- *
- * @param {Object} [options] An object with the following properties:
- * @param {Number} [options.fov] The angle of the field of view (FOV), in radians.
- * @param {Number} [options.aspectRatio] The aspect ratio of the frustum's width to it's height.
- * @param {Number} [options.near=1.0] The distance of the near plane.
- * @param {Number} [options.far=500000000.0] The distance of the far plane.
- * @param {Number} [options.xOffset=0.0] The offset in the x direction.
- * @param {Number} [options.yOffset=0.0] The offset in the y direction.
  *
  * @example
  * var frustum = new PerspectiveFrustum({
@@ -37,23 +27,13 @@ const defined = (val) => val !== null && typeof val !== 'undefined';
 export default class PerspectiveFrustum {
     constructor(options = {}) {
         this._offCenterFrustum = new PerspectiveOffCenterFrustum();
-        options = {
-            near: 1.0,
-            far: 500000000.0,
-            xOffset: 0.0,
-            yOffset: 0.0,
-            ...options
-        };
-        this.fov = options.fov;
-        this.aspectRatio = options.aspectRatio;
-        this.near = options.near;
-        this._near = this.near;
-        this.far = options.far;
-        this._far = this.far;
-        this.xOffset = options.xOffset;
-        this._xOffset = this.xOffset;
-        this.yOffset = options.yOffset;
-        this._yOffset = this.yOffset;
+        const { fov, aspectRatio, near = 1.0, far = 500000000.0, xOffset = 0.0, yOffset = 0.0 } = options;
+        this.fov = fov;
+        this.aspectRatio = aspectRatio;
+        this.near = near;
+        this.far = far;
+        this.xOffset = xOffset;
+        this.yOffset = yOffset;
     }
     /**
      * Returns a duplicate of a PerspectiveFrustum instance.
@@ -74,8 +54,8 @@ export default class PerspectiveFrustum {
         if (!defined(other) || !(other instanceof PerspectiveFrustum)) {
             return false;
         }
-        update(this);
-        update(other);
+        this._update();
+        other._update();
         return (this.fov === other.fov &&
             this.aspectRatio === other.aspectRatio &&
             this.near === other.near &&
@@ -83,57 +63,54 @@ export default class PerspectiveFrustum {
             this._offCenterFrustum.equals(other._offCenterFrustum));
     }
     /**
-     * Gets the perspective projection matrix computed from the view frustum.
+     * Gets the perspective projection matrix computed from the view this.
      */
     get projectionMatrix() {
-        update(this);
+        this._update();
         return this._offCenterFrustum.projectionMatrix;
     }
     /**
      * The perspective projection matrix computed from the view frustum with an infinite far plane.
      */
     get infiniteProjectionMatrix() {
-        update(this);
+        this._update();
         return this._offCenterFrustum.infiniteProjectionMatrix;
     }
     /**
      * Gets the angle of the vertical field of view, in radians.
      */
     get fovy() {
-        update(this);
+        this._update();
         return this._fovy;
     }
     /**
      * @private
      */
     get sseDenominator() {
-        update(this);
+        this._update();
         return this._sseDenominator;
     }
     /**
-     * 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.
+     * Creates a culling volume for this this.ion.
      * @returns {CullingVolume} A culling volume at the given position and orientation.
      *
      * @example
-     * // Check if a bounding volume intersects the frustum.
-     * var cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
+     * // Check if a bounding volume intersects the this.
+     * var cullingVolume = this.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
      * var intersect = cullingVolume.computeVisibility(boundingVolume);
      */
-    computeCullingVolume(position, direction, up) {
-        update(this);
+    computeCullingVolume(
+    /** A Vector3 defines the eye position. */
+    position, 
+    /** A Vector3 defines the view direction. */
+    direction, 
+    /** A Vector3 defines the up direction. */
+    up) {
+        this._update();
         return this._offCenterFrustum.computeCullingVolume(position, direction, up);
     }
     /**
      * 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.
@@ -142,7 +119,7 @@ export default class PerspectiveFrustum {
      * @example
      * // Example 1
      * // Get the width and height of a pixel.
-     * var pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 1.0, new Vector2());
+     * var pixelSize = camera.this.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 1.0, new Vector2());
      *
      * @example
      * // Example 2
@@ -153,53 +130,61 @@ export default class PerspectiveFrustum {
      * var toCenter = Vector3.subtract(primitive.boundingVolume.center, position, new Vector3());      // vector from camera to a primitive
      * var toCenterProj = Vector3.multiplyByScalar(direction, Vector3.dot(direction, toCenter), new Vector3()); // project vector onto camera direction vector
      * var distance = Vector3.magnitude(toCenterProj);
-     * var pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, distance, new Vector2());
+     * var pixelSize = camera.this.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, distance, new Vector2());
      */
-    getPixelDimensions(drawingBufferWidth, drawingBufferHeight, distance, result) {
-        update(this);
-        return this._offCenterFrustum.getPixelDimensions(drawingBufferWidth, drawingBufferHeight, distance, result);
+    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();
+        return this._offCenterFrustum.getPixelDimensions(drawingBufferWidth, drawingBufferHeight, distance, result || new Vector2());
     }
-}
-// eslint-disable-next-line complexity, max-statements
-function update(frustum) {
-    assert(Number.isFinite(frustum.fov) &&
-        Number.isFinite(frustum.aspectRatio) &&
-        Number.isFinite(frustum.near) &&
-        Number.isFinite(frustum.far));
-    // 'fov, aspectRatio, near, or far parameters are not set.'
-    const f = frustum._offCenterFrustum;
-    if (frustum.fov !== frustum._fov ||
-        frustum.aspectRatio !== frustum._aspectRatio ||
-        frustum.near !== frustum._near ||
-        frustum.far !== frustum._far ||
-        frustum.xOffset !== frustum._xOffset ||
-        frustum.yOffset !== frustum._yOffset) {
-        assert(frustum.fov >= 0 && frustum.fov < Math.PI);
-        // throw new DeveloperError('fov must be in the range [0, PI).');
-        assert(frustum.aspectRatio > 0);
-        // throw new DeveloperError('aspectRatio must be positive.');
-        assert(frustum.near >= 0 && frustum.near < frustum.far);
-        // throw new DeveloperError('near must be greater than zero and less than far.');
-        frustum._aspectRatio = frustum.aspectRatio;
-        frustum._fov = frustum.fov;
-        frustum._fovy =
-            frustum.aspectRatio <= 1
-                ? frustum.fov
-                : Math.atan(Math.tan(frustum.fov * 0.5) / frustum.aspectRatio) * 2.0;
-        frustum._near = frustum.near;
-        frustum._far = frustum.far;
-        frustum._sseDenominator = 2.0 * Math.tan(0.5 * frustum._fovy);
-        frustum._xOffset = frustum.xOffset;
-        frustum._yOffset = frustum.yOffset;
-        f.top = frustum.near * Math.tan(0.5 * frustum._fovy);
-        f.bottom = -f.top;
-        f.right = frustum.aspectRatio * f.top;
-        f.left = -f.right;
-        f.near = frustum.near;
-        f.far = frustum.far;
-        f.right += frustum.xOffset;
-        f.left += frustum.xOffset;
-        f.top += frustum.yOffset;
-        f.bottom += frustum.yOffset;
+    // eslint-disable-next-line complexity, max-statements
+    _update() {
+        assert(Number.isFinite(this.fov) &&
+            Number.isFinite(this.aspectRatio) &&
+            Number.isFinite(this.near) &&
+            Number.isFinite(this.far));
+        // 'fov, aspectRatio, near, or far parameters are not set.'
+        const f = this._offCenterFrustum;
+        if (this.fov !== this._fov ||
+            this.aspectRatio !== this._aspectRatio ||
+            this.near !== this._near ||
+            this.far !== this._far ||
+            this.xOffset !== this._xOffset ||
+            this.yOffset !== this._yOffset) {
+            assert(this.fov >= 0 && this.fov < Math.PI);
+            // throw new DeveloperError('fov must be in the range [0, PI).');
+            assert(this.aspectRatio > 0);
+            // throw new DeveloperError('aspectRatio must be positive.');
+            assert(this.near >= 0 && this.near < this.far);
+            // throw new DeveloperError('near must be greater than zero and less than far.');
+            this._aspectRatio = this.aspectRatio;
+            this._fov = this.fov;
+            this._fovy =
+                this.aspectRatio <= 1
+                    ? this.fov
+                    : Math.atan(Math.tan(this.fov * 0.5) / this.aspectRatio) * 2.0;
+            this._near = this.near;
+            this._far = this.far;
+            this._sseDenominator = 2.0 * Math.tan(0.5 * this._fovy);
+            this._xOffset = this.xOffset;
+            this._yOffset = this.yOffset;
+            f.top = this.near * Math.tan(0.5 * this._fovy);
+            f.bottom = -f.top;
+            f.right = this.aspectRatio * f.top;
+            f.left = -f.right;
+            f.near = this.near;
+            f.far = this.far;
+            f.right += this.xOffset;
+            f.left += this.xOffset;
+            f.top += this.yOffset;
+            f.bottom += this.yOffset;
+        }
     }
 }

package/dist/lib/perspective-off-center-frustum.d.ts

@@ -1,21 +1,59 @@
-import { Matrix4 } from '@math.gl/core';
+import { Vector2, Matrix4, NumericArray } from '@math.gl/core';
 import CullingVolume from './culling-volume';
+declare type PerspectiveOffCenterFrustumOptions = {
+    left?: number;
+    right?: number;
+    top?: number;
+    bottom?: number;
+    near?: number;
+    far?: number;
+};
 export default class PerspectiveOffCenterFrustum {
-    left: any;
-    _left: any;
-    right: any;
-    _right: any;
-    top: any;
-    _top: any;
-    bottom: any;
-    _bottom: any;
-    near: any;
-    _near: any;
-    far: any;
-    _far: any;
-    _cullingVolume: CullingVolume;
-    _perspectiveMatrix: Matrix4;
-    _infinitePerspective: Matrix4;
+    /**
+     * Defines the left clipping plane.
+     * @type {Number}
+     * @default undefined
+     */
+    left?: number;
+    private _left?;
+    /**
+     * Defines the right clipping plane.
+     * @type {Number}
+     * @default undefined
+     */
+    right?: number;
+    private _right?;
+    /**
+     * Defines the top clipping plane.
+     * @type {Number}
+     * @default undefined
+     */
+    top?: number;
+    private _top?;
+    /**
+     * Defines the bottom clipping plane.
+     * @type {Number}
+     * @default undefined
+     */
+    bottom?: number;
+    private _bottom?;
+    /**
+     * The distance of the near plane.
+     * @type {Number}
+     * @default 1.0
+     */
+    near: number;
+    private _near;
+    /**
+     * The distance of the far plane.
+     * @type {Number}
+     * @default 500000000.0
+     */
+    far: number;
+    private _far;
+    private _cullingVolume;
+    private _perspectiveMatrix;
+    private _infinitePerspective;
     /**
      * The viewing frustum is defined by 6 planes.
      * Each plane is represented by a {@link Vector4} object, where the x, y, and z components
@@ -23,15 +61,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({
@@ -45,7 +74,7 @@ export default class PerspectiveOffCenterFrustum {
      *
      * @see PerspectiveFrustum
      */
-    constructor(options?: Record<string, any>);
+    constructor(options?: PerspectiveOffCenterFrustumOptions);
     /**
      * Returns a duplicate of a PerspectiveOffCenterFrustum instance.
      * @returns {PerspectiveOffCenterFrustum} A new PerspectiveFrustum instance.
@@ -55,10 +84,9 @@ 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: any): boolean;
+    equals(other: PerspectiveOffCenterFrustum): boolean;
     /**
      * Gets the perspective projection matrix computed from the view frustum.
      * @memberof PerspectiveOffCenterFrustum.prototype
@@ -77,10 +105,6 @@ export default class PerspectiveOffCenterFrustum {
     get infiniteProjectionMatrix(): Matrix4;
     /**
      * 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
@@ -88,14 +112,16 @@ export default class PerspectiveOffCenterFrustum {
      * const cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
      * const intersect = cullingVolume.computeVisibility(boundingVolume);
      */
-    computeCullingVolume(position: any, direction: any, up: any): CullingVolume;
+    computeCullingVolume(
+    /** A Vector3 defines the eye position. */
+    position: Readonly<NumericArray>, 
+    /** A Vector3 defines the view direction. */
+    direction: Readonly<NumericArray>, 
+    /** A Vector3 defines the up direction. */
+    up: Readonly<NumericArray>): CullingVolume;
     /**
      * 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.
@@ -117,6 +143,16 @@ export default class PerspectiveOffCenterFrustum {
      * const distance = Vector3.magnitude(toCenterProj);
      * const pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, distance, new Vector2());
      */
-    getPixelDimensions(drawingBufferWidth: any, drawingBufferHeight: any, distance: any, result: any): any;
+    getPixelDimensions(
+    /** The width of the drawing buffer. */
+    drawingBufferWidth: number, 
+    /** The height of the drawing buffer. */
+    drawingBufferHeight: number, 
+    /** The distance to the near plane in meters. */
+    distance: number, 
+    /** The object onto which to store the result. */
+    result: Vector2): Vector2;
+    private _update;
 }
+export {};
 //# sourceMappingURL=perspective-off-center-frustum.d.ts.map

package/dist/lib/perspective-off-center-frustum.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"perspective-off-center-frustum.d.ts","sourceRoot":"","sources":["../../src/lib/perspective-off-center-frustum.ts"],"names":[],"mappings":"AASA,OAAO,EAAU,OAAO,EAAS,MAAM,eAAe,CAAC;AACvD,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAS7C,MAAM,CAAC,OAAO,OAAO,2BAA2B;IAC9C,IAAI,MAAC;IACL,KAAK,MAAC;IACN,KAAK,MAAC;IACN,MAAM,MAAC;IACP,GAAG,MAAC;IACJ,IAAI,MAAC;IACL,MAAM,MAAC;IACP,OAAO,MAAC;IACR,IAAI,MAAC;IACL,KAAK,MAAC;IACN,GAAG,MAAC;IACJ,IAAI,MAAC;IACL,cAAc,gBAOX;IACH,kBAAkB,UAAiB;IACnC,oBAAoB,UAAiB;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;gBACS,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM;IAoD7C;;;SAGK;IACL,KAAK;IAWL;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,KAAA;IAaZ;;;;;;OAMG;IACH,IAAI,gBAAgB,YAGnB;IAED;;;;;;OAMG;IACH,IAAI,wBAAwB,YAG3B;IAED;;;;;;;;;;;;OAYG;IAEH,oBAAoB,CAAC,QAAQ,KAAA,EAAE,SAAS,KAAA,EAAE,EAAE,KAAA;IAmE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,kBAAkB,CAAC,kBAAkB,KAAA,EAAE,mBAAmB,KAAA,EAAE,QAAQ,KAAA,EAAE,MAAM,KAAA;CAwB7E"}
+{"version":3,"file":"perspective-off-center-frustum.d.ts","sourceRoot":"","sources":["../../src/lib/perspective-off-center-frustum.ts"],"names":[],"mappings":"AAOA,OAAO,EAAU,OAAO,EAAE,OAAO,EAAU,YAAY,EAAC,MAAM,eAAe,CAAC;AAC9E,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAS7C,aAAK,kCAAkC,GAAG;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,2BAA2B;IAC9C;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,KAAK,CAAS;IACtB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,IAAI,CAAS;IAErB,OAAO,CAAC,cAAc,CAOnB;IACH,OAAO,CAAC,kBAAkB,CAAiB;IAC3C,OAAO,CAAC,oBAAoB,CAAiB;IAE7C;;;;;;;;;;;;;;;;;;;OAmBG;gBACS,OAAO,GAAE,kCAAuC;IAsB5D;;;SAGK;IACL,KAAK,IAAI,2BAA2B;IAWpC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO;IAanD;;;;;;OAMG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAG9B;IAED;;;;;;OAMG;IACH,IAAI,wBAAwB,IAAI,OAAO,CAGtC;IAED;;;;;;;;OAQG;IAEH,oBAAoB;IAClB,0CAA0C;IAC1C,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC;IAChC,4CAA4C;IAC5C,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC;IACjC,0CAA0C;IAC1C,EAAE,EAAE,QAAQ,CAAC,YAAY,CAAC,GACzB,aAAa;IAmEhB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,kBAAkB;IAChB,uCAAuC;IACvC,kBAAkB,EAAE,MAAM;IAC1B,wCAAwC;IACxC,mBAAmB,EAAE,MAAM;IAC3B,gDAAgD;IAChD,QAAQ,EAAE,MAAM;IAChB,iDAAiD;IACjD,MAAM,EAAE,OAAO,GACd,OAAO;IA0BV,OAAO,CAAC,OAAO;CAkDhB"}