@cesium/engine 6.2.0 → 8.0.0

package/Source/Scene/Picking.js

@@ -236,30 +236,38 @@ let scratchRectangle = new BoundingRectangle(
 const scratchPosition = new Cartesian2();
 const scratchColorZero = new Color(0.0, 0.0, 0.0, 0.0);
 
+/**
+ * Returns an object with a <code>primitive</code> property that contains the first (top) primitive in the scene
+ * at a particular window coordinate or undefined if nothing is at the location. Other properties may
+ * potentially be set depending on the type of primitive and may be used to further identify the picked object.
+ * <p>
+ * When a feature of a 3D Tiles tileset is picked, <code>pick</code> returns a {@link Cesium3DTileFeature} object.
+ * </p>
+ * @param {Scene} scene
+ * @param {Cartesian2} windowPosition Window coordinates to perform picking on.
+ * @param {number} [width=3] Width of the pick rectangle.
+ * @param {number} [height=3] Height of the pick rectangle.
+ * @returns {object} Object containing the picked primitive.
+ */
 Picking.prototype.pick = function (scene, windowPosition, width, height) {
   //>>includeStart('debug', pragmas.debug);
-  if (!defined(windowPosition)) {
-    throw new DeveloperError("windowPosition is undefined.");
-  }
+  Check.defined("windowPosition", windowPosition);
   //>>includeEnd('debug');
 
   scratchRectangleWidth = defaultValue(width, 3.0);
   scratchRectangleHeight = defaultValue(height, scratchRectangleWidth);
 
-  const context = scene.context;
-  const us = context.uniformState;
-  const frameState = scene.frameState;
+  const { context, frameState, defaultView } = scene;
+  const { viewport, pickFramebuffer } = defaultView;
 
-  const view = scene.defaultView;
-  scene.view = view;
+  scene.view = defaultView;
 
-  const viewport = view.viewport;
   viewport.x = 0;
   viewport.y = 0;
   viewport.width = context.drawingBufferWidth;
   viewport.height = context.drawingBufferHeight;
 
-  let passState = view.passState;
+  let passState = defaultView.passState;
   passState.viewport = BoundingRectangle.clone(viewport, passState.viewport);
 
   const drawingBufferPosition = SceneTransforms.transformWindowToDrawingBuffer(
@@ -282,7 +290,7 @@ Picking.prototype.pick = function (scene, windowPosition, width, height) {
   frameState.passes.pick = true;
   frameState.tilesetPassState = pickTilesetPassState;
 
-  us.update(frameState);
+  context.uniformState.update(frameState);
 
   scene.updateEnvironment();
 
@@ -294,32 +302,108 @@ Picking.prototype.pick = function (scene, windowPosition, width, height) {
     (scratchRectangleHeight - 1.0) * 0.5;
   scratchRectangle.width = scratchRectangleWidth;
   scratchRectangle.height = scratchRectangleHeight;
-  passState = view.pickFramebuffer.begin(scratchRectangle, view.viewport);
+  passState = pickFramebuffer.begin(scratchRectangle, viewport);
 
   scene.updateAndExecuteCommands(passState, scratchColorZero);
   scene.resolveFramebuffers(passState);
 
-  const object = view.pickFramebuffer.end(scratchRectangle);
+  const object = pickFramebuffer.end(scratchRectangle);
   context.endFrame();
   return object;
 };
 
+/**
+ * Returns an object with information about the voxel sample rendered at
+ * a particular window coordinate. Returns <code>undefined</code> if there is no
+ * voxel at that position.
+ *
+ * @param {Scene} scene
+ * @param {Cartesian2} windowPosition Window coordinates to perform picking on.
+ * @param {number} [width=3] Width of the pick rectangle.
+ * @param {number} [height=3] Height of the pick rectangle.
+ * @returns {object|undefined} Object containing the picked primitive.
+ */
+Picking.prototype.pickVoxelCoordinate = function (
+  scene,
+  windowPosition,
+  width,
+  height
+) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.defined("windowPosition", windowPosition);
+  //>>includeEnd('debug');
+
+  scratchRectangleWidth = defaultValue(width, 3.0);
+  scratchRectangleHeight = defaultValue(height, scratchRectangleWidth);
+
+  const { context, frameState, defaultView } = scene;
+  const { viewport, pickFramebuffer } = defaultView;
+
+  scene.view = defaultView;
+
+  viewport.x = 0;
+  viewport.y = 0;
+  viewport.width = context.drawingBufferWidth;
+  viewport.height = context.drawingBufferHeight;
+
+  let passState = defaultView.passState;
+  passState.viewport = BoundingRectangle.clone(viewport, passState.viewport);
+
+  const drawingBufferPosition = SceneTransforms.transformWindowToDrawingBuffer(
+    scene,
+    windowPosition,
+    scratchPosition
+  );
+
+  scene.jobScheduler.disableThisFrame();
+
+  scene.updateFrameState();
+  frameState.cullingVolume = getPickCullingVolume(
+    scene,
+    drawingBufferPosition,
+    scratchRectangleWidth,
+    scratchRectangleHeight,
+    viewport
+  );
+  frameState.invertClassification = false;
+  frameState.passes.pickVoxel = true;
+  frameState.tilesetPassState = pickTilesetPassState;
+
+  context.uniformState.update(frameState);
+
+  scene.updateEnvironment();
+
+  scratchRectangle.x =
+    drawingBufferPosition.x - (scratchRectangleWidth - 1.0) * 0.5;
+  scratchRectangle.y =
+    scene.drawingBufferHeight -
+    drawingBufferPosition.y -
+    (scratchRectangleHeight - 1.0) * 0.5;
+  scratchRectangle.width = scratchRectangleWidth;
+  scratchRectangle.height = scratchRectangleHeight;
+  passState = pickFramebuffer.begin(scratchRectangle, viewport);
+
+  scene.updateAndExecuteCommands(passState, scratchColorZero);
+  scene.resolveFramebuffers(passState);
+
+  const voxelInfo = pickFramebuffer.readVoxelInfo(scratchRectangle);
+  context.endFrame();
+  return voxelInfo;
+};
+
 function renderTranslucentDepthForPick(scene, drawingBufferPosition) {
   // PERFORMANCE_IDEA: render translucent only and merge with the previous frame
-  const context = scene.context;
-  const frameState = scene.frameState;
-  const environmentState = scene.environmentState;
+  const { defaultView, context, frameState, environmentState } = scene;
+  const { viewport, pickDepthFramebuffer } = defaultView;
 
-  const view = scene.defaultView;
-  scene.view = view;
+  scene.view = defaultView;
 
-  const viewport = view.viewport;
   viewport.x = 0;
   viewport.y = 0;
   viewport.width = context.drawingBufferWidth;
   viewport.height = context.drawingBufferHeight;
 
-  let passState = view.passState;
+  let passState = defaultView.passState;
   passState.viewport = BoundingRectangle.clone(viewport, passState.viewport);
 
   scene.clearPasses(frameState.passes);
@@ -336,7 +420,7 @@ function renderTranslucentDepthForPick(scene, drawingBufferPosition) {
 
   scene.updateEnvironment();
   environmentState.renderTranslucentDepthForPick = true;
-  passState = view.pickDepthFramebuffer.update(
+  passState = pickDepthFramebuffer.update(
     context,
     drawingBufferPosition,
     viewport
@@ -363,9 +447,7 @@ Picking.prototype.pickPositionWorldCoordinates = function (
   }
 
   //>>includeStart('debug', pragmas.debug);
-  if (!defined(windowPosition)) {
-    throw new DeveloperError("windowPosition is undefined.");
-  }
+  Check.defined("windowPosition", windowPosition);
   if (!scene.context.depthTexture) {
     throw new DeveloperError(
       "Picking from the depth buffer is not supported. Check pickPositionSupported."
@@ -382,12 +464,10 @@ Picking.prototype.pickPositionWorldCoordinates = function (
     return Cartesian3.clone(this._pickPositionCache[cacheKey], result);
   }
 
-  const frameState = scene.frameState;
-  const context = scene.context;
-  const uniformState = context.uniformState;
+  const { context, frameState, camera, defaultView } = scene;
+  const { uniformState } = context;
 
-  const view = scene.defaultView;
-  scene.view = view;
+  scene.view = defaultView;
 
   const drawingBufferPosition = SceneTransforms.transformWindowToDrawingBuffer(
     scene,
@@ -403,8 +483,6 @@ Picking.prototype.pickPositionWorldCoordinates = function (
   }
   drawingBufferPosition.y = scene.drawingBufferHeight - drawingBufferPosition.y;
 
-  const camera = scene.camera;
-
   // Create a working frustum from the original camera frustum.
   let frustum;
   if (defined(camera.frustum.fov)) {
@@ -417,7 +495,7 @@ Picking.prototype.pickPositionWorldCoordinates = function (
     frustum = camera.frustum.clone(scratchOrthographicOffCenterFrustum);
   }
 
-  const frustumCommandsList = view.frustumCommandsList;
+  const frustumCommandsList = defaultView.frustumCommandsList;
   const numFrustums = frustumCommandsList.length;
   for (let i = 0; i < numFrustums; ++i) {
     const pickDepth = this.getPickDepth(scene, i);
@@ -636,9 +714,7 @@ function updateOffscreenCameraFromRay(picking, ray, width, camera) {
 function updateMostDetailedRayPick(picking, scene, rayPick) {
   const frameState = scene.frameState;
 
-  const ray = rayPick.ray;
-  const width = rayPick.width;
-  const tilesets = rayPick.tilesets;
+  const { ray, width, tilesets } = rayPick;
 
   const camera = picking._pickOffscreenView.camera;
   const cullingVolume = updateOffscreenCameraFromRay(
@@ -682,8 +758,7 @@ Picking.prototype.updateMostDetailedRayPicks = function (scene) {
 };
 
 function getTilesets(primitives, objectsToExclude, tilesets) {
-  const length = primitives.length;
-  for (let i = 0; i < length; ++i) {
+  for (let i = 0; i < primitives.length; ++i) {
     const primitive = primitives.get(i);
     if (primitive.show) {
       if (defined(primitive.isCesium3DTileset)) {
@@ -745,9 +820,8 @@ function getRayIntersection(
   requirePosition,
   mostDetailed
 ) {
-  const context = scene.context;
+  const { context, frameState } = scene;
   const uniformState = context.uniformState;
-  const frameState = scene.frameState;
 
   const view = picking._pickOffscreenView;
   scene.view = view;

package/Source/Scene/Primitive.js

@@ -1174,15 +1174,19 @@ function loadAsynchronous(primitive, frameState) {
       instanceIds.push(instances[i].id);
 
       //>>includeStart('debug', pragmas.debug);
-      if (!defined(geometry._workerName)) {
+      if (
+        (defined(geometry._workerName) && defined(geometry._workerPath)) ||
+        (!defined(geometry._workerName) && !defined(geometry._workerPath))
+      ) {
         throw new DeveloperError(
-          "_workerName must be defined for asynchronous geometry."
+          "Must define either _workerName or _workerPath for asynchronous geometry."
         );
       }
       //>>includeEnd('debug');
 
       subTasks.push({
         moduleName: geometry._workerName,
+        modulePath: geometry._workerPath,
         geometry: geometry,
       });
     }

package/Source/Scene/QuadtreePrimitive.js

@@ -274,7 +274,7 @@ QuadtreePrimitive.prototype.forEachRenderedTile = function (tileFunction) {
  * is the cartesian position on the tile.
  *
  * @param {Cartographic} cartographic The cartographic position.
- * @param {Function} callback The function to be called when a new tile is loaded containing cartographic.
+ * @param {Function} callback The function to be called when a new tile is loaded containing the updated cartographic.
  * @returns {Function} The function to remove this callback from the quadtree.
  */
 QuadtreePrimitive.prototype.updateHeight = function (cartographic, callback) {