@cesium/engine 11.0.0 → 12.0.0

package/Source/Core/PerspectiveFrustum.js

@@ -41,7 +41,7 @@ function PerspectiveFrustum(options) {
    * The angle of the field of view (FOV), in radians.  This angle will be used
    * as the horizontal FOV if the width is greater than the height, otherwise
    * it will be the vertical FOV.
-   * @type {number}
+   * @type {number|undefined}
    * @default undefined
    */
   this.fov = options.fov;
@@ -52,7 +52,7 @@ function PerspectiveFrustum(options) {
 
   /**
    * The aspect ratio of the frustum's width to it's height.
-   * @type {number}
+   * @type {number|undefined}
    * @default undefined
    */
   this.aspectRatio = options.aspectRatio;
@@ -162,70 +162,76 @@ function update(frustum) {
     !defined(frustum.far)
   ) {
     throw new DeveloperError(
-      "fov, aspectRatio, near, or far parameters are not set."
+      "fov, aspectRatio, near, or far parameters are not set.",
     );
   }
   //>>includeEnd('debug');
 
-  const f = frustum._offCenterFrustum;
-
-  if (
+  const changed =
     frustum.fov !== frustum._fov ||
     frustum.aspectRatio !== frustum._aspectRatio ||
     frustum.near !== frustum._near ||
     frustum.far !== frustum._far ||
     frustum.xOffset !== frustum._xOffset ||
-    frustum.yOffset !== frustum._yOffset
-  ) {
-    //>>includeStart('debug', pragmas.debug);
-    if (frustum.fov < 0 || frustum.fov >= Math.PI) {
-      throw new DeveloperError("fov must be in the range [0, PI).");
-    }
-
-    if (frustum.aspectRatio < 0) {
-      throw new DeveloperError("aspectRatio must be positive.");
-    }
-
-    if (frustum.near < 0 || frustum.near > frustum.far) {
-      throw new DeveloperError(
-        "near must be greater than zero and less than far."
-      );
-    }
-    //>>includeEnd('debug');
-
-    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;
+    frustum.yOffset !== frustum._yOffset;
+
+  if (!changed) {
+    return;
+  }
+
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.number.greaterThanOrEquals("fov", frustum.fov, 0.0);
+  Check.typeOf.number.lessThan("fov", frustum.fov, Math.PI);
+
+  Check.typeOf.number.greaterThanOrEquals(
+    "aspectRatio",
+    frustum.aspectRatio,
+    0.0,
+  );
+
+  Check.typeOf.number.greaterThanOrEquals("near", frustum.near, 0.0);
+  if (frustum.near > frustum.far) {
+    throw new DeveloperError("near must be less than far.");
   }
+  //>>includeEnd('debug');
+
+  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;
+
+  const f = frustum._offCenterFrustum;
+
+  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;
 }
 
 Object.defineProperties(PerspectiveFrustum.prototype, {
   /**
    * Gets the perspective projection matrix computed from the view frustum.
+   * If necessary, the projection matrix will be recomputed.
+   *
    * @memberof PerspectiveFrustum.prototype
    * @type {Matrix4}
    * @readonly
    *
+   * @see PerspectiveOffCenterFrustum#projectionMatrix.
    * @see PerspectiveFrustum#infiniteProjectionMatrix
    */
   projectionMatrix: {
@@ -253,7 +259,7 @@ Object.defineProperties(PerspectiveFrustum.prototype, {
   /**
    * Gets the angle of the vertical field of view, in radians.
    * @memberof PerspectiveFrustum.prototype
-   * @type {number}
+   * @type {number|undefined}
    * @readonly
    * @default undefined
    */
@@ -306,7 +312,7 @@ Object.defineProperties(PerspectiveFrustum.prototype, {
 PerspectiveFrustum.prototype.computeCullingVolume = function (
   position,
   direction,
-  up
+  up,
 ) {
   update(this);
   return this._offCenterFrustum.computeCullingVolume(position, direction, up);
@@ -347,7 +353,7 @@ PerspectiveFrustum.prototype.getPixelDimensions = function (
   drawingBufferHeight,
   distance,
   pixelRatio,
-  result
+  result,
 ) {
   update(this);
   return this._offCenterFrustum.getPixelDimensions(
@@ -355,7 +361,7 @@ PerspectiveFrustum.prototype.getPixelDimensions = function (
     drawingBufferHeight,
     distance,
     pixelRatio,
-    result
+    result,
   );
 };
 
@@ -421,7 +427,7 @@ PerspectiveFrustum.prototype.equals = function (other) {
 PerspectiveFrustum.prototype.equalsEpsilon = function (
   other,
   relativeEpsilon,
-  absoluteEpsilon
+  absoluteEpsilon,
 ) {
   if (!defined(other) || !(other instanceof PerspectiveFrustum)) {
     return false;
@@ -435,18 +441,18 @@ PerspectiveFrustum.prototype.equalsEpsilon = function (
       this.fov,
       other.fov,
       relativeEpsilon,
-      absoluteEpsilon
+      absoluteEpsilon,
     ) &&
     CesiumMath.equalsEpsilon(
       this.aspectRatio,
       other.aspectRatio,
       relativeEpsilon,
-      absoluteEpsilon
+      absoluteEpsilon,
     ) &&
     this._offCenterFrustum.equalsEpsilon(
       other._offCenterFrustum,
       relativeEpsilon,
-      absoluteEpsilon
+      absoluteEpsilon,
     )
   );
 };

package/Source/Core/PerspectiveOffCenterFrustum.js

@@ -41,7 +41,7 @@ function PerspectiveOffCenterFrustum(options) {
 
   /**
    * Defines the left clipping plane.
-   * @type {number}
+   * @type {number|undefined}
    * @default undefined
    */
   this.left = options.left;
@@ -49,7 +49,7 @@ function PerspectiveOffCenterFrustum(options) {
 
   /**
    * Defines the right clipping plane.
-   * @type {number}
+   * @type {number|undefined}
    * @default undefined
    */
   this.right = options.right;
@@ -57,7 +57,7 @@ function PerspectiveOffCenterFrustum(options) {
 
   /**
    * Defines the top clipping plane.
-   * @type {number}
+   * @type {number|undefined}
    * @default undefined
    */
   this.top = options.top;
@@ -65,7 +65,7 @@ function PerspectiveOffCenterFrustum(options) {
 
   /**
    * Defines the bottom clipping plane.
-   * @type {number}
+   * @type {number|undefined}
    * @default undefined
    */
   this.bottom = options.bottom;
@@ -103,63 +103,62 @@ function update(frustum) {
     !defined(frustum.far)
   ) {
     throw new DeveloperError(
-      "right, left, top, bottom, near, or far parameters are not set."
+      "right, left, top, bottom, near, or far parameters are not set.",
     );
   }
   //>>includeEnd('debug');
 
-  const t = frustum.top;
-  const b = frustum.bottom;
-  const r = frustum.right;
-  const l = frustum.left;
-  const n = frustum.near;
-  const f = frustum.far;
+  const { top, bottom, right, left, near, far } = frustum;
+
+  const changed =
+    top !== frustum._top ||
+    bottom !== frustum._bottom ||
+    left !== frustum._left ||
+    right !== frustum._right ||
+    near !== frustum._near ||
+    far !== frustum._far;
+  if (!changed) {
+    return;
+  }
 
-  if (
-    t !== frustum._top ||
-    b !== frustum._bottom ||
-    l !== frustum._left ||
-    r !== frustum._right ||
-    n !== frustum._near ||
-    f !== frustum._far
-  ) {
-    //>>includeStart('debug', pragmas.debug);
-    if (frustum.near <= 0 || frustum.near > frustum.far) {
-      throw new DeveloperError(
-        "near must be greater than zero and less than far."
-      );
-    }
-    //>>includeEnd('debug');
-
-    frustum._left = l;
-    frustum._right = r;
-    frustum._top = t;
-    frustum._bottom = b;
-    frustum._near = n;
-    frustum._far = f;
-    frustum._perspectiveMatrix = Matrix4.computePerspectiveOffCenter(
-      l,
-      r,
-      b,
-      t,
-      n,
-      f,
-      frustum._perspectiveMatrix
-    );
-    frustum._infinitePerspective = Matrix4.computeInfinitePerspectiveOffCenter(
-      l,
-      r,
-      b,
-      t,
-      n,
-      frustum._infinitePerspective
+  //>>includeStart('debug', pragmas.debug);
+  if (frustum.near <= 0 || frustum.near > frustum.far) {
+    throw new DeveloperError(
+      "near must be greater than zero and less than far.",
     );
   }
+  //>>includeEnd('debug');
+
+  frustum._left = left;
+  frustum._right = right;
+  frustum._top = top;
+  frustum._bottom = bottom;
+  frustum._near = near;
+  frustum._far = far;
+  frustum._perspectiveMatrix = Matrix4.computePerspectiveOffCenter(
+    left,
+    right,
+    bottom,
+    top,
+    near,
+    far,
+    frustum._perspectiveMatrix,
+  );
+  frustum._infinitePerspective = Matrix4.computeInfinitePerspectiveOffCenter(
+    left,
+    right,
+    bottom,
+    top,
+    near,
+    frustum._infinitePerspective,
+  );
 }
 
 Object.defineProperties(PerspectiveOffCenterFrustum.prototype, {
   /**
    * Gets the perspective projection matrix computed from the view frustum.
+   * The projection matrix will be recomputed if any frustum parameters have changed.
+   *
    * @memberof PerspectiveOffCenterFrustum.prototype
    * @type {Matrix4}
    * @readonly
@@ -209,7 +208,7 @@ const getPlanesNormal = new Cartesian3();
 PerspectiveOffCenterFrustum.prototype.computeCullingVolume = function (
   position,
   direction,
-  up
+  up,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(position)) {
@@ -371,14 +370,14 @@ PerspectiveOffCenterFrustum.prototype.getPixelDimensions = function (
   drawingBufferHeight,
   distance,
   pixelRatio,
-  result
+  result,
 ) {
   update(this);
 
   //>>includeStart('debug', pragmas.debug);
   if (!defined(drawingBufferWidth) || !defined(drawingBufferHeight)) {
     throw new DeveloperError(
-      "Both drawingBufferWidth and drawingBufferHeight are required."
+      "Both drawingBufferWidth and drawingBufferHeight are required.",
     );
   }
   if (drawingBufferWidth <= 0) {
@@ -476,7 +475,7 @@ PerspectiveOffCenterFrustum.prototype.equals = function (other) {
 PerspectiveOffCenterFrustum.prototype.equalsEpsilon = function (
   other,
   relativeEpsilon,
-  absoluteEpsilon
+  absoluteEpsilon,
 ) {
   return (
     other === this ||
@@ -486,37 +485,37 @@ PerspectiveOffCenterFrustum.prototype.equalsEpsilon = function (
         this.right,
         other.right,
         relativeEpsilon,
-        absoluteEpsilon
+        absoluteEpsilon,
       ) &&
       CesiumMath.equalsEpsilon(
         this.left,
         other.left,
         relativeEpsilon,
-        absoluteEpsilon
+        absoluteEpsilon,
       ) &&
       CesiumMath.equalsEpsilon(
         this.top,
         other.top,
         relativeEpsilon,
-        absoluteEpsilon
+        absoluteEpsilon,
       ) &&
       CesiumMath.equalsEpsilon(
         this.bottom,
         other.bottom,
         relativeEpsilon,
-        absoluteEpsilon
+        absoluteEpsilon,
       ) &&
       CesiumMath.equalsEpsilon(
         this.near,
         other.near,
         relativeEpsilon,
-        absoluteEpsilon
+        absoluteEpsilon,
       ) &&
       CesiumMath.equalsEpsilon(
         this.far,
         other.far,
         relativeEpsilon,
-        absoluteEpsilon
+        absoluteEpsilon,
       ))
   );
 };

package/Source/Core/PinBuilder.js

@@ -89,7 +89,7 @@ PinBuilder.prototype.fromMakiIconId = function (id, color, size) {
     undefined,
     color,
     size,
-    this._cache
+    this._cache,
   );
 };
 

package/Source/Core/PixelFormat.js

@@ -341,7 +341,7 @@ PixelFormat.isBC7Format = function (pixelFormat) {
 PixelFormat.compressedTextureSizeInBytes = function (
   pixelFormat,
   width,
-  height
+  height,
 ) {
   switch (pixelFormat) {
     case PixelFormat.RGB_DXT1:
@@ -363,7 +363,7 @@ PixelFormat.compressedTextureSizeInBytes = function (
     case PixelFormat.RGB_PVRTC_2BPPV1:
     case PixelFormat.RGBA_PVRTC_2BPPV1:
       return Math.floor(
-        (Math.max(width, 16) * Math.max(height, 8) * 2 + 7) / 8
+        (Math.max(width, 16) * Math.max(height, 8) * 2 + 7) / 8,
       );
 
     case PixelFormat.RGBA_BC7:
@@ -381,7 +381,7 @@ PixelFormat.textureSizeInBytes = function (
   pixelFormat,
   pixelDatatype,
   width,
-  height
+  height,
 ) {
   let componentsLength = PixelFormat.componentsLength(pixelFormat);
   if (PixelDatatype.isPacked(pixelDatatype)) {
@@ -413,7 +413,7 @@ PixelFormat.createTypedArray = function (
   pixelFormat,
   pixelDatatype,
   width,
-  height
+  height,
 ) {
   const constructor = PixelDatatype.getTypedArrayConstructor(pixelDatatype);
   const size = PixelFormat.componentsLength(pixelFormat) * width * height;
@@ -428,7 +428,7 @@ PixelFormat.flipY = function (
   pixelFormat,
   pixelDatatype,
   width,
-  height
+  height,
 ) {
   if (height === 1) {
     return bufferView;
@@ -437,7 +437,7 @@ PixelFormat.flipY = function (
     pixelFormat,
     pixelDatatype,
     width,
-    height
+    height,
   );
   const numberOfComponents = PixelFormat.componentsLength(pixelFormat);
   const textureWidth = width * numberOfComponents;

package/Source/Core/Plane.js

@@ -38,7 +38,7 @@ function Plane(normal, distance) {
     !CesiumMath.equalsEpsilon(
       Cartesian3.magnitude(normal),
       1.0,
-      CesiumMath.EPSILON6
+      CesiumMath.EPSILON6,
     )
   ) {
     throw new DeveloperError("normal must be normalized.");
@@ -88,7 +88,7 @@ Plane.fromPointNormal = function (point, normal, result) {
     !CesiumMath.equalsEpsilon(
       Cartesian3.magnitude(normal),
       1.0,
-      CesiumMath.EPSILON6
+      CesiumMath.EPSILON6,
     )
   ) {
     throw new DeveloperError("normal must be normalized.");
@@ -129,7 +129,7 @@ Plane.fromCartesian4 = function (coefficients, result) {
     !CesiumMath.equalsEpsilon(
       Cartesian3.magnitude(normal),
       1.0,
-      CesiumMath.EPSILON6
+      CesiumMath.EPSILON6,
     )
   ) {
     throw new DeveloperError("normal must be normalized.");
@@ -187,7 +187,7 @@ Plane.projectPointOntoPlane = function (plane, point, result) {
   const scaledNormal = Cartesian3.multiplyByScalar(
     plane.normal,
     pointDistance,
-    scratchCartesian
+    scratchCartesian,
   );
 
   return Cartesian3.subtract(point, scaledNormal, result);
@@ -214,31 +214,31 @@ Plane.transform = function (plane, transform, result) {
   const distance = plane.distance;
   const inverseTranspose = Matrix4.inverseTranspose(
     transform,
-    scratchInverseTranspose
+    scratchInverseTranspose,
   );
   let planeAsCartesian4 = Cartesian4.fromElements(
     normal.x,
     normal.y,
     normal.z,
     distance,
-    scratchPlaneCartesian4
+    scratchPlaneCartesian4,
   );
   planeAsCartesian4 = Matrix4.multiplyByVector(
     inverseTranspose,
     planeAsCartesian4,
-    planeAsCartesian4
+    planeAsCartesian4,
   );
 
   // Convert the transformed plane to Hessian Normal Form
   const transformedNormal = Cartesian3.fromCartesian4(
     planeAsCartesian4,
-    scratchTransformNormal
+    scratchTransformNormal,
   );
 
   planeAsCartesian4 = Cartesian4.divideByScalar(
     planeAsCartesian4,
     Cartesian3.magnitude(transformedNormal),
-    planeAsCartesian4
+    planeAsCartesian4,
   );
 
   return Plane.fromCartesian4(planeAsCartesian4, result);

package/Source/Core/PlaneGeometry.js

@@ -84,7 +84,7 @@ PlaneGeometry.unpack = function (array, startingIndex, result) {
   const vertexFormat = VertexFormat.unpack(
     array,
     startingIndex,
-    scratchVertexFormat
+    scratchVertexFormat,
   );
 
   if (!defined(result)) {