@cesium/engine 10.1.0 → 11.1.0

package/Source/Scene/Vector3DTilePrimitive.js

@@ -129,7 +129,7 @@ function Vector3DTilePrimitive(options) {
    */
   this.classificationType = defaultValue(
     options.classificationType,
-    ClassificationType.BOTH
+    ClassificationType.BOTH,
   );
 
   // Hidden options
@@ -221,7 +221,7 @@ function createVertexArray(primitive, context) {
       index: 1,
       vertexBuffer: idBuffer,
       componentDatatype: ComponentDatatype.fromTypedArray(
-        primitive._vertexBatchIds
+        primitive._vertexBatchIds,
       ),
       componentsPerAttribute: 1,
     },
@@ -259,7 +259,7 @@ function createShaders(primitive, context) {
   const batchTable = primitive._batchTable;
   const attributeLocations = defaultValue(
     primitive._attributeLocations,
-    defaultAttributeLocations
+    defaultAttributeLocations,
   );
 
   let pickId = primitive._pickId;
@@ -276,7 +276,7 @@ function createShaders(primitive, context) {
 
     fragmentShaderSource = ShaderSource.replaceMain(
       fragmentShaderSource,
-      "czm_non_pick_main"
+      "czm_non_pick_main",
     );
     fragmentShaderSource =
       `${fragmentShaderSource}void main() \n` +
@@ -296,12 +296,12 @@ function createShaders(primitive, context) {
   const vsSource = batchTable.getVertexShaderCallback(
     false,
     "a_batchId",
-    undefined
+    undefined,
   )(VectorTileVS);
   let fsSource = batchTable.getFragmentShaderCallback(
     false,
     undefined,
-    true
+    true,
   )(ShadowVolumeFS);
 
   pickId = batchTable.getPickId();
@@ -454,10 +454,10 @@ function createRenderStates(primitive) {
   }
 
   primitive._rsStencilDepthPass = RenderState.fromCache(
-    getStencilDepthRenderState(false)
+    getStencilDepthRenderState(false),
   );
   primitive._rsStencilDepthPass3DTiles = RenderState.fromCache(
-    getStencilDepthRenderState(true)
+    getStencilDepthRenderState(true),
   );
   primitive._rsColorPass = RenderState.fromCache(colorRenderState);
   primitive._rsPickPass = RenderState.fromCache(pickRenderState);
@@ -479,17 +479,17 @@ function createUniformMap(primitive, context) {
       Matrix4.multiplyByPoint(
         modifiedModelViewScratch,
         primitive._center,
-        rtcScratch
+        rtcScratch,
       );
       Matrix4.setTranslation(
         modifiedModelViewScratch,
         rtcScratch,
-        modifiedModelViewScratch
+        modifiedModelViewScratch,
       );
       Matrix4.multiply(
         projectionMatrix,
         modifiedModelViewScratch,
-        modifiedModelViewScratch
+        modifiedModelViewScratch,
       );
       return modifiedModelViewScratch;
     },
@@ -498,9 +498,8 @@ function createUniformMap(primitive, context) {
     },
   };
 
-  primitive._uniformMap = primitive._batchTable.getUniformMapCallback()(
-    uniformMap
-  );
+  primitive._uniformMap =
+    primitive._batchTable.getUniformMapCallback()(uniformMap);
 }
 
 function copyIndicesCPU(
@@ -510,7 +509,7 @@ function copyIndicesCPU(
   offsets,
   counts,
   batchIds,
-  batchIdLookUp
+  batchIdLookUp,
 ) {
   const sizeInBytes = indices.constructor.BYTES_PER_ELEMENT;
 
@@ -524,7 +523,7 @@ function copyIndicesCPU(
     const subarray = new indices.constructor(
       indices.buffer,
       sizeInBytes * offset,
-      count
+      count,
     );
     newIndices.set(subarray, currentOffset);
 
@@ -553,7 +552,7 @@ function rebatchCPU(primitive, batchedIndices) {
     indexOffsets,
     indexCounts,
     current.batchIds,
-    batchIdLookUp
+    batchIdLookUp,
   );
 
   current.offset = 0;
@@ -569,7 +568,7 @@ function rebatchCPU(primitive, batchedIndices) {
         indexOffsets,
         indexCounts,
         next.batchIds,
-        batchIdLookUp
+        batchIdLookUp,
       );
       current.batchIds = current.batchIds.concat(next.batchIds);
       current.count = currentOffset - current.offset;
@@ -582,7 +581,7 @@ function rebatchCPU(primitive, batchedIndices) {
         indexOffsets,
         indexCounts,
         next.batchIds,
-        batchIdLookUp
+        batchIdLookUp,
       );
 
       next.offset = offset;
@@ -605,7 +604,7 @@ function copyIndicesGPU(
   offsets,
   counts,
   batchIds,
-  batchIdLookUp
+  batchIdLookUp,
 ) {
   const sizeInBytes = readBuffer.bytesPerIndex;
 
@@ -620,7 +619,7 @@ function copyIndicesGPU(
       readBuffer,
       offset * sizeInBytes,
       currentOffset * sizeInBytes,
-      count * sizeInBytes
+      count * sizeInBytes,
     );
 
     offsets[index] = currentOffset;
@@ -648,7 +647,7 @@ function rebatchGPU(primitive, batchedIndices) {
     indexOffsets,
     indexCounts,
     current.batchIds,
-    batchIdLookUp
+    batchIdLookUp,
   );
 
   current.offset = 0;
@@ -664,7 +663,7 @@ function rebatchGPU(primitive, batchedIndices) {
         indexOffsets,
         indexCounts,
         next.batchIds,
-        batchIdLookUp
+        batchIdLookUp,
       );
       current.batchIds = current.batchIds.concat(next.batchIds);
       current.count = currentOffset - current.offset;
@@ -677,7 +676,7 @@ function rebatchGPU(primitive, batchedIndices) {
         indexOffsets,
         indexCounts,
         next.batchIds,
-        batchIdLookUp
+        batchIdLookUp,
       );
       next.offset = offset;
       next.count = currentOffset - offset;
@@ -798,7 +797,7 @@ function createColorCommands(primitive, context) {
 
     const stencilDepthDerivedCommand = DrawCommand.shallowClone(
       stencilDepthCommand,
-      stencilDepthCommand.derivedCommands.tileset
+      stencilDepthCommand.derivedCommands.tileset,
     );
     stencilDepthDerivedCommand.renderState =
       primitive._rsStencilDepthPass3DTiles;
@@ -825,7 +824,7 @@ function createColorCommands(primitive, context) {
 
     const colorDerivedCommand = DrawCommand.shallowClone(
       colorCommand,
-      colorCommand.derivedCommands.tileset
+      colorCommand.derivedCommands.tileset,
     );
     colorDerivedCommand.pass = Pass.CESIUM_3D_TILE_CLASSIFICATION;
     colorCommand.derivedCommands.tileset = colorDerivedCommand;
@@ -854,7 +853,7 @@ function createColorCommandsIgnoreShow(primitive, frameState) {
   for (let j = 0; j < length; ++j) {
     const commandIgnoreShow = (commandsIgnoreShow[j] = DrawCommand.shallowClone(
       commands[commandIndex],
-      commandsIgnoreShow[j]
+      commandsIgnoreShow[j],
     ));
     commandIgnoreShow.shaderProgram = spStencil;
     commandIgnoreShow.pass = Pass.CESIUM_3D_TILE_CLASSIFICATION_IGNORE_SHOW;
@@ -907,7 +906,7 @@ function createPickCommands(primitive) {
 
     const stencilDepthDerivedCommand = DrawCommand.shallowClone(
       stencilDepthCommand,
-      stencilDepthCommand.derivedCommands.tileset
+      stencilDepthCommand.derivedCommands.tileset,
     );
     stencilDepthDerivedCommand.renderState =
       primitive._rsStencilDepthPass3DTiles;
@@ -934,7 +933,7 @@ function createPickCommands(primitive) {
 
     const colorDerivedCommand = DrawCommand.shallowClone(
       colorCommand,
-      colorCommand.derivedCommands.tileset
+      colorCommand.derivedCommands.tileset,
     );
     colorDerivedCommand.pass = Pass.CESIUM_3D_TILE_CLASSIFICATION;
     colorCommand.derivedCommands.tileset = colorDerivedCommand;
@@ -1091,7 +1090,7 @@ Vector3DTilePrimitive.prototype.updateCommands = function (batchId, color) {
       offset: offset,
       count: count,
       batchIds: [batchId],
-    })
+    }),
   );
 
   const startIds = [];
@@ -1122,7 +1121,7 @@ Vector3DTilePrimitive.prototype.updateCommands = function (batchId, color) {
         count:
           batchedIndices[i].offset + batchedIndices[i].count - (offset + count),
         batchIds: endIds,
-      })
+      }),
     );
   }
 

package/Source/Scene/View.js

@@ -28,6 +28,13 @@ function CommandExtent() {
 }
 
 /**
+ * @alias View
+ * @constructor
+ *
+ * @param {Scene} scene
+ * @param {Camera} camera
+ * @param {BoundingRectangle} viewport
+ *
  * @private
  */
 function View(scene, camera, viewport) {
@@ -60,8 +67,11 @@ function View(scene, camera, viewport) {
   this.globeTranslucencyFramebuffer = new GlobeTranslucencyFramebuffer();
   this.oit = oit;
   this.translucentTileClassification = new TranslucentTileClassification(
-    context
+    context,
   );
+  /**
+   * @type {PickDepth[]}
+   */
   this.pickDepths = [];
   this.frustumCommandsList = [];
   this.debugFrustumStatistics = undefined;
@@ -73,16 +83,26 @@ function View(scene, camera, viewport) {
 
 const scratchPosition0 = new Cartesian3();
 const scratchPosition1 = new Cartesian3();
-function maxComponent(a, b) {
-  const x = Math.max(Math.abs(a.x), Math.abs(b.x));
-  const y = Math.max(Math.abs(a.y), Math.abs(b.y));
-  const z = Math.max(Math.abs(a.z), Math.abs(b.z));
-  return Math.max(Math.max(x, y), z);
-}
-
+/**
+ * Check if two cameras have the same view.
+ *
+ * @param {Camera} camera0 The first camera for comparison.
+ * @param {Camera} camera1 The second camera for comparison.
+ * @param {number} epsilon The epsilon tolerance to use for equality testing.
+ * @returns {boolean} <code>true</code> if the cameras are equal.
+ *
+ * @private
+ */
 function cameraEqual(camera0, camera1, epsilon) {
-  const scalar =
-    1 / Math.max(1, maxComponent(camera0.position, camera1.position));
+  const maximumPositionComponent = Math.max(
+    Cartesian3.maximumComponent(
+      Cartesian3.abs(camera0.position, scratchPosition0),
+    ),
+    Cartesian3.maximumComponent(
+      Cartesian3.abs(camera1.position, scratchPosition1),
+    ),
+  );
+  const scalar = 1 / Math.max(1, maximumPositionComponent);
   Cartesian3.multiplyByScalar(camera0.position, scalar, scratchPosition0);
   Cartesian3.multiplyByScalar(camera1.position, scalar, scratchPosition1);
   return (
@@ -95,6 +115,14 @@ function cameraEqual(camera0, camera1, epsilon) {
   );
 }
 
+/**
+ * Check if the camera position or direction has changed.
+ *
+ * @param {Scene} scene
+ * @returns {boolean} <code>true</code> if the camera has been updated
+ *
+ * @private
+ */
 View.prototype.checkForCameraUpdates = function (scene) {
   const camera = this.camera;
   const cameraClone = this._cameraClone;
@@ -120,10 +148,22 @@ View.prototype.checkForCameraUpdates = function (scene) {
   return false;
 };
 
+/**
+ * Split the depth range of the scene into multiple frustums, and initialize
+ * a list of {@link FrustumCommands} with the distances to the near and far
+ * planes for each frustum.
+ *
+ * @param {View} view The view to which the frustum commands list is attached.
+ * @param {Scene} scene The scene to be rendered.
+ * @param {number} near The distance to the nearest object in the scene.
+ * @param {number} far The distance to the farthest object in the scene.
+ *
+ * @private
+ */
 function updateFrustums(view, scene, near, far) {
-  const frameState = scene.frameState;
-  const camera = frameState.camera;
-  const farToNearRatio = frameState.useLogDepth
+  const { frameState } = scene;
+  const { camera, useLogDepth } = frameState;
+  const farToNearRatio = useLogDepth
     ? scene.logarithmicDepthFarToNearRatio
     : scene.farToNearRatio;
   const is2D = scene.mode === SceneMode.SCENE2D;
@@ -146,14 +186,14 @@ function updateFrustums(view, scene, near, far) {
     far = Math.min(far, camera.position.z + scene.nearToFarDistance2D);
     near = Math.min(near, far);
     numFrustums = Math.ceil(
-      Math.max(1.0, far - near) / scene.nearToFarDistance2D
+      Math.max(1.0, far - near) / scene.nearToFarDistance2D,
     );
   } else {
     // The multifrustum for 3D/CV is non-uniformly distributed.
     numFrustums = Math.ceil(Math.log(far / near) / Math.log(farToNearRatio));
   }
 
-  const frustumCommandsList = view.frustumCommandsList;
+  const { frustumCommandsList } = view;
   frustumCommandsList.length = numFrustums;
   for (let m = 0; m < numFrustums; ++m) {
     let curNear;
@@ -162,7 +202,7 @@ function updateFrustums(view, scene, near, far) {
     if (is2D) {
       curNear = Math.min(
         far - nearToFarDistance2D,
-        near + m * nearToFarDistance2D
+        near + m * nearToFarDistance2D,
       );
       curFar = Math.min(far, curNear + nearToFarDistance2D);
     } else {
@@ -173,7 +213,7 @@ function updateFrustums(view, scene, near, far) {
     if (!defined(frustumCommands)) {
       frustumCommands = frustumCommandsList[m] = new FrustumCommands(
         curNear,
-        curFar
+        curFar,
       );
     } else {
       frustumCommands.near = curNear;
@@ -182,24 +222,33 @@ function updateFrustums(view, scene, near, far) {
   }
 }
 
-function insertIntoBin(view, scene, command, commandNear, commandFar) {
+/**
+ * Insert a command into the appropriate {@link FrustumCommands} based on the
+ * range of depths covered by its bounding volume.
+ *
+ * @param {View} view
+ * @param {Scene} scene
+ * @param {CommandExtent} commandExtent
+ *
+ * @private
+ */
+function insertIntoBin(view, scene, commandExtent) {
+  const { command, near, far } = commandExtent;
+
   if (scene.debugShowFrustums) {
     command.debugOverlappingFrustums = 0;
   }
 
-  const frustumCommandsList = view.frustumCommandsList;
-  const length = frustumCommandsList.length;
+  const { frustumCommandsList } = view;
 
-  for (let i = 0; i < length; ++i) {
+  for (let i = 0; i < frustumCommandsList.length; ++i) {
     const frustumCommands = frustumCommandsList[i];
-    const curNear = frustumCommands.near;
-    const curFar = frustumCommands.far;
 
-    if (commandNear > curFar) {
+    if (near > frustumCommands.far) {
       continue;
     }
 
-    if (commandFar < curNear) {
+    if (far < frustumCommands.near) {
       break;
     }
 
@@ -217,13 +266,13 @@ function insertIntoBin(view, scene, command, commandNear, commandFar) {
   }
 
   if (scene.debugShowFrustums) {
-    const cf = view.debugFrustumStatistics.commandsInFrustums;
-    cf[command.debugOverlappingFrustums] = defined(
-      cf[command.debugOverlappingFrustums]
-    )
-      ? cf[command.debugOverlappingFrustums] + 1
+    const { debugFrustumStatistics } = view;
+    const { debugOverlappingFrustums } = command;
+    const cf = debugFrustumStatistics.commandsInFrustums;
+    cf[debugOverlappingFrustums] = defined(cf[debugOverlappingFrustums])
+      ? cf[debugOverlappingFrustums] + 1
       : 1;
-    ++view.debugFrustumStatistics.totalCommands;
+    ++debugFrustumStatistics.totalCommands;
   }
 
   scene.updateDerivedCommands(command);
@@ -233,14 +282,12 @@ const scratchCullingVolume = new CullingVolume();
 const scratchNearFarInterval = new Interval();
 
 View.prototype.createPotentiallyVisibleSet = function (scene) {
-  const frameState = scene.frameState;
-  const camera = frameState.camera;
-  const direction = camera.directionWC;
-  const position = camera.positionWC;
+  const { frameState } = scene;
+  const { camera, commandList, shadowState } = frameState;
+  const { positionWC, directionWC, frustum } = camera;
 
   const computeList = scene._computeCommandList;
   const overlayList = scene._overlayCommandList;
-  const commandList = frameState.commandList;
 
   if (scene.debugShowFrustums) {
     this.debugFrustumStatistics = {
@@ -250,10 +297,8 @@ View.prototype.createPotentiallyVisibleSet = function (scene) {
   }
 
   const frustumCommandsList = this.frustumCommandsList;
-  const numberOfFrustums = frustumCommandsList.length;
-  const numberOfPasses = Pass.NUMBER_OF_PASSES;
-  for (let n = 0; n < numberOfFrustums; ++n) {
-    for (let p = 0; p < numberOfPasses; ++p) {
+  for (let n = 0; n < frustumCommandsList.length; ++n) {
+    for (let p = 0; p < Pass.NUMBER_OF_PASSES; ++p) {
       frustumCommandsList[n].indices[p] = 0;
     }
   }
@@ -268,26 +313,25 @@ View.prototype.createPotentiallyVisibleSet = function (scene) {
   let near = +Number.MAX_VALUE;
   let far = -Number.MAX_VALUE;
 
-  const shadowsEnabled = frameState.shadowState.shadowsEnabled;
+  const { shadowsEnabled } = shadowState;
   let shadowNear = +Number.MAX_VALUE;
   let shadowFar = -Number.MAX_VALUE;
   let shadowClosestObjectSize = Number.MAX_VALUE;
 
   const occluder =
     frameState.mode === SceneMode.SCENE3D ? frameState.occluder : undefined;
-  let cullingVolume = frameState.cullingVolume;
 
   // get user culling volume minus the far plane.
+  let { cullingVolume } = frameState;
   const planes = scratchCullingVolume.planes;
   for (let k = 0; k < 5; ++k) {
     planes[k] = cullingVolume.planes[k];
   }
   cullingVolume = scratchCullingVolume;
 
-  const length = commandList.length;
-  for (let i = 0; i < length; ++i) {
+  for (let i = 0; i < commandList.length; ++i) {
     const command = commandList[i];
-    const pass = command.pass;
+    const { pass, boundingVolume } = command;
 
     if (pass === Pass.COMPUTE) {
       computeList.push(command);
@@ -297,16 +341,15 @@ View.prototype.createPotentiallyVisibleSet = function (scene) {
       let commandNear;
       let commandFar;
 
-      const boundingVolume = command.boundingVolume;
       if (defined(boundingVolume)) {
-        if (!scene.isVisible(command, cullingVolume, occluder)) {
+        if (!scene.isVisible(cullingVolume, command, occluder)) {
           continue;
         }
 
         const nearFarInterval = boundingVolume.computePlaneDistances(
-          position,
-          direction,
-          scratchNearFarInterval
+          positionWC,
+          directionWC,
+          scratchNearFarInterval,
         );
         commandNear = nearFarInterval.start;
         commandFar = nearFarInterval.stop;
@@ -334,13 +377,13 @@ View.prototype.createPotentiallyVisibleSet = function (scene) {
         }
       } else if (command instanceof ClearCommand) {
         // Clear commands don't need a bounding volume - just add the clear to all frustums.
-        commandNear = camera.frustum.near;
-        commandFar = camera.frustum.far;
+        commandNear = frustum.near;
+        commandFar = frustum.far;
       } else {
         // If command has no bounding volume we need to use the camera's
         // worst-case near and far planes to avoid clipping something important.
-        commandNear = camera.frustum.near;
-        commandFar = camera.frustum.far;
+        commandNear = frustum.near;
+        commandFar = frustum.far;
         near = Math.min(near, commandNear);
         far = Math.max(far, commandFar);
       }
@@ -357,46 +400,36 @@ View.prototype.createPotentiallyVisibleSet = function (scene) {
   }
 
   if (shadowsEnabled) {
-    shadowNear = Math.min(
-      Math.max(shadowNear, camera.frustum.near),
-      camera.frustum.far
-    );
-    shadowFar = Math.max(Math.min(shadowFar, camera.frustum.far), shadowNear);
-  }
-
-  // Use the computed near and far for shadows
-  if (shadowsEnabled) {
-    frameState.shadowState.nearPlane = shadowNear;
-    frameState.shadowState.farPlane = shadowFar;
-    frameState.shadowState.closestObjectSize = shadowClosestObjectSize;
+    shadowNear = Math.min(Math.max(shadowNear, frustum.near), frustum.far);
+    shadowFar = Math.max(Math.min(shadowFar, frustum.far), shadowNear);
+    // Use the computed near and far for shadows
+    shadowState.nearPlane = shadowNear;
+    shadowState.farPlane = shadowFar;
+    shadowState.closestObjectSize = shadowClosestObjectSize;
   }
 
   updateFrustums(this, scene, near, far);
 
-  let c;
-  let ce;
-
-  for (c = 0; c < commandExtentCount; c++) {
-    ce = commandExtents[c];
-    insertIntoBin(this, scene, ce.command, ce.near, ce.far);
+  for (let c = 0; c < commandExtentCount; c++) {
+    insertIntoBin(this, scene, commandExtents[c]);
   }
 
   // Dereference old commands
   if (commandExtentCount < commandExtentCapacity) {
-    for (c = commandExtentCount; c < commandExtentCapacity; c++) {
-      ce = commandExtents[c];
-      if (!defined(ce.command)) {
+    for (let c = commandExtentCount; c < commandExtentCapacity; c++) {
+      const commandExtent = commandExtents[c];
+      if (!defined(commandExtent.command)) {
         // If the command is undefined, it's assumed that all
         // subsequent commmands were set to undefined as well,
         // so no need to loop over them all
         break;
       }
-      ce.command = undefined;
+      commandExtent.command = undefined;
     }
   }
 
   const numFrustums = frustumCommandsList.length;
-  const frustumSplits = frameState.frustumSplits;
+  const { frustumSplits } = frameState;
   frustumSplits.length = numFrustums + 1;
   for (let j = 0; j < numFrustums; ++j) {
     frustumSplits[j] = frustumCommandsList[j].near;
@@ -421,10 +454,8 @@ View.prototype.destroy = function () {
     this.globeTranslucencyFramebuffer &&
     this.globeTranslucencyFramebuffer.destroy();
 
-  let i;
   const pickDepths = this.pickDepths;
-  const length = pickDepths.length;
-  for (i = 0; i < length; ++i) {
+  for (let i = 0; i < pickDepths.length; ++i) {
     pickDepths[i].destroy();
   }
 };