@cesium/engine 11.0.0 → 12.0.0

package/Source/Renderer/DrawCommand.js

@@ -16,6 +16,9 @@ const Flags = {
 /**
  * Represents a command to the renderer for drawing.
  *
+ * @alias DrawCommand
+ * @constructor
+ *
  * @private
  */
 function DrawCommand(options) {
@@ -26,7 +29,7 @@ function DrawCommand(options) {
   this._modelMatrix = options.modelMatrix;
   this._primitiveType = defaultValue(
     options.primitiveType,
-    PrimitiveType.TRIANGLES
+    PrimitiveType.TRIANGLES,
   );
   this._vertexArray = options.vertexArray;
   this._count = options.count;
@@ -40,6 +43,8 @@ function DrawCommand(options) {
   this._owner = options.owner;
   this._debugOverlappingFrustums = 0;
   this._pickId = options.pickId;
+  this._pickMetadataAllowed = options.pickMetadataAllowed === true;
+  this._pickedMetadataInfo = undefined;
 
   // Set initial flags.
   this._flags = 0;
@@ -47,18 +52,18 @@ function DrawCommand(options) {
   this.occlude = defaultValue(options.occlude, true);
   this.executeInClosestFrustum = defaultValue(
     options.executeInClosestFrustum,
-    false
+    false,
   );
   this.debugShowBoundingVolume = defaultValue(
     options.debugShowBoundingVolume,
-    false
+    false,
   );
   this.castShadows = defaultValue(options.castShadows, false);
   this.receiveShadows = defaultValue(options.receiveShadows, false);
   this.pickOnly = defaultValue(options.pickOnly, false);
   this.depthForTranslucentClassification = defaultValue(
     options.depthForTranslucentClassification,
-    false
+    false,
   );
 
   this.dirty = true;
@@ -511,7 +516,7 @@ Object.defineProperties(DrawCommand.prototype, {
    * during the pick pass.
    *
    * @memberof DrawCommand.prototype
-   * @type {string}
+   * @type {string|undefined}
    * @default undefined
    */
   pickId: {
@@ -525,6 +530,44 @@ Object.defineProperties(DrawCommand.prototype, {
       }
     },
   },
+
+  /**
+   * Whether metadata picking is allowed.
+   *
+   * This is essentially only set to `true` for draw commands that are
+   * part of a `ModelDrawCommand`, to check whether a derived command
+   * for metadata picking has to be created.
+   *
+   * @memberof DrawCommand.prototype
+   * @type {boolean}
+   * @default undefined
+   * @private
+   */
+  pickMetadataAllowed: {
+    get: function () {
+      return this._pickMetadataAllowed;
+    },
+  },
+
+  /**
+   * Information about picked metadata.
+   *
+   * @memberof DrawCommand.prototype
+   * @type {PickedMetadataInfo|undefined}
+   * @default undefined
+   */
+  pickedMetadataInfo: {
+    get: function () {
+      return this._pickedMetadataInfo;
+    },
+    set: function (value) {
+      if (this._pickedMetadataInfo !== value) {
+        this._pickedMetadataInfo = value;
+        this.dirty = true;
+      }
+    },
+  },
+
   /**
    * Whether this command should be executed in the pick pass only.
    *
@@ -590,6 +633,8 @@ DrawCommand.shallowClone = function (command, result) {
   result._owner = command._owner;
   result._debugOverlappingFrustums = command._debugOverlappingFrustums;
   result._pickId = command._pickId;
+  result._pickMetadataAllowed = command._pickMetadataAllowed;
+  result._pickedMetadataInfo = command._pickedMetadataInfo;
   result._flags = command._flags;
 
   result.dirty = true;

package/Source/Renderer/Framebuffer.js

@@ -14,7 +14,7 @@ function attachTexture(framebuffer, attachment, texture) {
     attachment,
     texture._target,
     texture._texture,
-    0
+    0,
   );
 }
 
@@ -24,7 +24,7 @@ function attachRenderbuffer(framebuffer, attachment, renderbuffer) {
     gl.FRAMEBUFFER,
     attachment,
     gl.RENDERBUFFER,
-    renderbuffer._getRenderbuffer()
+    renderbuffer._getRenderbuffer(),
   );
 }
 
@@ -33,7 +33,16 @@ function attachRenderbuffer(framebuffer, attachment, renderbuffer) {
  * Framebuffers are used for render-to-texture effects; they allow us to render to
  * textures in one pass, and read from it in a later pass.
  *
- * @param {object} options The initial framebuffer attachments as shown in the example below. <code>context</code> is required. The possible properties are <code>colorTextures</code>, <code>colorRenderbuffers</code>, <code>depthTexture</code>, <code>depthRenderbuffer</code>, <code>stencilRenderbuffer</code>, <code>depthStencilTexture</code>, <code>depthStencilRenderbuffer</code>, and <code>destroyAttachments</code>.
+ * @param {object} options Object with the following properties:
+ * @param {Context} options.context
+ * @param {Texture[]} [options.colorTextures]
+ * @param {Renderbuffer[]} [options.colorRenderbuffers]
+ * @param {Texture} [options.depthTexture]
+ * @param {Renderbuffer} [options.depthRenderbuffer]
+ * @param {Renderbuffer} [options.stencilRenderbuffer]
+ * @param {Texture} [options.depthStencilTexture]
+ * @param {Renderbuffer} [options.depthStencilRenderbuffer]
+ * @param {boolean} [options.destroyAttachments=true] When true, the framebuffer owns its attachments so they will be destroyed when {@link Framebuffer#destroy} is called or when a new attachment is assigned to an attachment point.
  *
  * @exception {DeveloperError} Cannot have both color texture and color renderbuffer attachments.
  * @exception {DeveloperError} Cannot have both a depth texture and depth renderbuffer attachment.
@@ -114,12 +123,12 @@ function Framebuffer(options) {
   //>>includeStart('debug', pragmas.debug);
   if (defined(options.colorTextures) && defined(options.colorRenderbuffers)) {
     throw new DeveloperError(
-      "Cannot have both color texture and color renderbuffer attachments."
+      "Cannot have both color texture and color renderbuffer attachments.",
     );
   }
   if (defined(options.depthTexture) && defined(options.depthRenderbuffer)) {
     throw new DeveloperError(
-      "Cannot have both a depth texture and depth renderbuffer attachment."
+      "Cannot have both a depth texture and depth renderbuffer attachment.",
     );
   }
   if (
@@ -127,10 +136,9 @@ function Framebuffer(options) {
     defined(options.depthStencilRenderbuffer)
   ) {
     throw new DeveloperError(
-      "Cannot have both a depth-stencil texture and depth-stencil renderbuffer attachment."
+      "Cannot have both a depth-stencil texture and depth-stencil renderbuffer attachment.",
     );
   }
-  //>>includeEnd('debug');
 
   // Avoid errors defined in Section 6.5 of the WebGL spec
   const depthAttachment =
@@ -138,55 +146,47 @@ function Framebuffer(options) {
   const depthStencilAttachment =
     defined(options.depthStencilTexture) ||
     defined(options.depthStencilRenderbuffer);
-
-  //>>includeStart('debug', pragmas.debug);
   if (depthAttachment && depthStencilAttachment) {
     throw new DeveloperError(
-      "Cannot have both a depth and depth-stencil attachment."
+      "Cannot have both a depth and depth-stencil attachment.",
     );
   }
   if (defined(options.stencilRenderbuffer) && depthStencilAttachment) {
     throw new DeveloperError(
-      "Cannot have both a stencil and depth-stencil attachment."
+      "Cannot have both a stencil and depth-stencil attachment.",
     );
   }
   if (depthAttachment && defined(options.stencilRenderbuffer)) {
     throw new DeveloperError(
-      "Cannot have both a depth and stencil attachment."
+      "Cannot have both a depth and stencil attachment.",
     );
   }
   //>>includeEnd('debug');
 
-  ///////////////////////////////////////////////////////////////////
-
   this._bind();
 
-  let texture;
-  let renderbuffer;
-  let i;
-  let length;
-  let attachmentEnum;
-
   if (defined(options.colorTextures)) {
     const textures = options.colorTextures;
-    length = this._colorTextures.length = this._activeColorAttachments.length =
-      textures.length;
+    const length =
+      (this._colorTextures.length =
+      this._activeColorAttachments.length =
+        textures.length);
 
     //>>includeStart('debug', pragmas.debug);
     if (length > maximumColorAttachments) {
       throw new DeveloperError(
-        "The number of color attachments exceeds the number supported."
+        "The number of color attachments exceeds the number supported.",
       );
     }
     //>>includeEnd('debug');
 
-    for (i = 0; i < length; ++i) {
-      texture = textures[i];
+    for (let i = 0; i < length; ++i) {
+      const texture = textures[i];
 
       //>>includeStart('debug', pragmas.debug);
       if (!PixelFormat.isColorFormat(texture.pixelFormat)) {
         throw new DeveloperError(
-          "The color-texture pixel-format must be a color format."
+          "The color-texture pixel-format must be a color format.",
         );
       }
       if (
@@ -194,7 +194,7 @@ function Framebuffer(options) {
         !context.colorBufferFloat
       ) {
         throw new DeveloperError(
-          "The color texture pixel datatype is FLOAT and the WebGL implementation does not support the EXT_color_buffer_float or WEBGL_color_buffer_float extensions. See Context.colorBufferFloat."
+          "The color texture pixel datatype is FLOAT and the WebGL implementation does not support the EXT_color_buffer_float or WEBGL_color_buffer_float extensions. See Context.colorBufferFloat.",
         );
       }
       if (
@@ -202,12 +202,12 @@ function Framebuffer(options) {
         !context.colorBufferHalfFloat
       ) {
         throw new DeveloperError(
-          "The color texture pixel datatype is HALF_FLOAT and the WebGL implementation does not support the EXT_color_buffer_half_float extension. See Context.colorBufferHalfFloat."
+          "The color texture pixel datatype is HALF_FLOAT and the WebGL implementation does not support the EXT_color_buffer_half_float extension. See Context.colorBufferHalfFloat.",
         );
       }
       //>>includeEnd('debug');
 
-      attachmentEnum = this._gl.COLOR_ATTACHMENT0 + i;
+      const attachmentEnum = this._gl.COLOR_ATTACHMENT0 + i;
       attachTexture(this, attachmentEnum, texture);
       this._activeColorAttachments[i] = attachmentEnum;
       this._colorTextures[i] = texture;
@@ -216,20 +216,22 @@ function Framebuffer(options) {
 
   if (defined(options.colorRenderbuffers)) {
     const renderbuffers = options.colorRenderbuffers;
-    length = this._colorRenderbuffers.length = this._activeColorAttachments.length =
-      renderbuffers.length;
+    const length =
+      (this._colorRenderbuffers.length =
+      this._activeColorAttachments.length =
+        renderbuffers.length);
 
     //>>includeStart('debug', pragmas.debug);
     if (length > maximumColorAttachments) {
       throw new DeveloperError(
-        "The number of color attachments exceeds the number supported."
+        "The number of color attachments exceeds the number supported.",
       );
     }
     //>>includeEnd('debug');
 
-    for (i = 0; i < length; ++i) {
-      renderbuffer = renderbuffers[i];
-      attachmentEnum = this._gl.COLOR_ATTACHMENT0 + i;
+    for (let i = 0; i < length; ++i) {
+      const renderbuffer = renderbuffers[i];
+      const attachmentEnum = this._gl.COLOR_ATTACHMENT0 + i;
       attachRenderbuffer(this, attachmentEnum, renderbuffer);
       this._activeColorAttachments[i] = attachmentEnum;
       this._colorRenderbuffers[i] = renderbuffer;
@@ -237,12 +239,12 @@ function Framebuffer(options) {
   }
 
   if (defined(options.depthTexture)) {
-    texture = options.depthTexture;
+    const texture = options.depthTexture;
 
     //>>includeStart('debug', pragmas.debug);
     if (texture.pixelFormat !== PixelFormat.DEPTH_COMPONENT) {
       throw new DeveloperError(
-        "The depth-texture pixel-format must be DEPTH_COMPONENT."
+        "The depth-texture pixel-format must be DEPTH_COMPONENT.",
       );
     }
     //>>includeEnd('debug');
@@ -252,24 +254,24 @@ function Framebuffer(options) {
   }
 
   if (defined(options.depthRenderbuffer)) {
-    renderbuffer = options.depthRenderbuffer;
+    const renderbuffer = options.depthRenderbuffer;
     attachRenderbuffer(this, this._gl.DEPTH_ATTACHMENT, renderbuffer);
     this._depthRenderbuffer = renderbuffer;
   }
 
   if (defined(options.stencilRenderbuffer)) {
-    renderbuffer = options.stencilRenderbuffer;
+    const renderbuffer = options.stencilRenderbuffer;
     attachRenderbuffer(this, this._gl.STENCIL_ATTACHMENT, renderbuffer);
     this._stencilRenderbuffer = renderbuffer;
   }
 
   if (defined(options.depthStencilTexture)) {
-    texture = options.depthStencilTexture;
+    const texture = options.depthStencilTexture;
 
     //>>includeStart('debug', pragmas.debug);
     if (texture.pixelFormat !== PixelFormat.DEPTH_STENCIL) {
       throw new DeveloperError(
-        "The depth-stencil pixel-format must be DEPTH_STENCIL."
+        "The depth-stencil pixel-format must be DEPTH_STENCIL.",
       );
     }
     //>>includeEnd('debug');
@@ -279,7 +281,7 @@ function Framebuffer(options) {
   }
 
   if (defined(options.depthStencilRenderbuffer)) {
-    renderbuffer = options.depthStencilRenderbuffer;
+    const renderbuffer = options.depthStencilRenderbuffer;
     attachRenderbuffer(this, this._gl.DEPTH_STENCIL_ATTACHMENT, renderbuffer);
     this._depthStencilRenderbuffer = renderbuffer;
   }
@@ -380,7 +382,7 @@ Framebuffer.prototype.getColorTexture = function (index) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(index) || index < 0 || index >= this._colorTextures.length) {
     throw new DeveloperError(
-      "index is required, must be greater than or equal to zero and must be less than the number of color attachments."
+      "index is required, must be greater than or equal to zero and must be less than the number of color attachments.",
     );
   }
   //>>includeEnd('debug');
@@ -396,7 +398,7 @@ Framebuffer.prototype.getColorRenderbuffer = function (index) {
     index >= this._colorRenderbuffers.length
   ) {
     throw new DeveloperError(
-      "index is required, must be greater than or equal to zero and must be less than the number of color attachments."
+      "index is required, must be greater than or equal to zero and must be less than the number of color attachments.",
     );
   }
   //>>includeEnd('debug');
@@ -411,10 +413,8 @@ Framebuffer.prototype.isDestroyed = function () {
 Framebuffer.prototype.destroy = function () {
   if (this.destroyAttachments) {
     // If the color texture is a cube map face, it is owned by the cube map, and will not be destroyed.
-    let i = 0;
     const textures = this._colorTextures;
-    let length = textures.length;
-    for (; i < length; ++i) {
+    for (let i = 0; i < textures.length; ++i) {
       const texture = textures[i];
       if (defined(texture)) {
         texture.destroy();
@@ -422,8 +422,7 @@ Framebuffer.prototype.destroy = function () {
     }
 
     const renderbuffers = this._colorRenderbuffers;
-    length = renderbuffers.length;
-    for (i = 0; i < length; ++i) {
+    for (let i = 0; i < renderbuffers.length; ++i) {
       const renderbuffer = renderbuffers[i];
       if (defined(renderbuffer)) {
         renderbuffer.destroy();

package/Source/Renderer/FramebufferManager.js

@@ -36,7 +36,7 @@ function FramebufferManager(options) {
   this._numSamples = defaultValue(options.numSamples, 1);
   this._colorAttachmentsLength = defaultValue(
     options.colorAttachmentsLength,
-    1
+    1,
   );
 
   this._color = defaultValue(options.color, true);
@@ -44,28 +44,28 @@ function FramebufferManager(options) {
   this._depthStencil = defaultValue(options.depthStencil, false);
   this._supportsDepthTexture = defaultValue(
     options.supportsDepthTexture,
-    false
+    false,
   );
   //>>includeStart('debug', pragmas.debug);
   if (!this._color && !this._depth && !this._depthStencil) {
     throw new DeveloperError(
-      "Must enable at least one type of framebuffer attachment."
+      "Must enable at least one type of framebuffer attachment.",
     );
   }
   if (this._depth && this._depthStencil) {
     throw new DeveloperError(
-      "Cannot have both a depth and depth-stencil attachment."
+      "Cannot have both a depth and depth-stencil attachment.",
     );
   }
   //>>includeEnd('debug');
 
   this._createColorAttachments = defaultValue(
     options.createColorAttachments,
-    true
+    true,
   );
   this._createDepthAttachments = defaultValue(
     options.createDepthAttachments,
-    true
+    true,
   );
 
   this._pixelDatatype = options.pixelDatatype;
@@ -116,7 +116,7 @@ FramebufferManager.prototype.isDirty = function (
   height,
   numSamples,
   pixelDatatype,
-  pixelFormat
+  pixelFormat,
 ) {
   numSamples = defaultValue(numSamples, 1);
   const dimensionChanged = this._width !== width || this._height !== height;
@@ -145,7 +145,7 @@ FramebufferManager.prototype.update = function (
   height,
   numSamples,
   pixelDatatype,
-  pixelFormat
+  pixelFormat,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (!defined(width) || !defined(height)) {
@@ -157,11 +157,11 @@ FramebufferManager.prototype.update = function (
     pixelDatatype,
     this._color
       ? defaultValue(this._pixelDatatype, PixelDatatype.UNSIGNED_BYTE)
-      : undefined
+      : undefined,
   );
   pixelFormat = defaultValue(
     pixelFormat,
-    this._color ? defaultValue(this._pixelFormat, PixelFormat.RGBA) : undefined
+    this._color ? defaultValue(this._pixelFormat, PixelFormat.RGBA) : undefined,
   );
 
   if (this.isDirty(width, height, numSamples, pixelDatatype, pixelFormat)) {
@@ -278,7 +278,7 @@ FramebufferManager.prototype.getColorTexture = function (index) {
   //>>includeStart('debug', pragmas.debug);
   if (index >= this._colorAttachmentsLength) {
     throw new DeveloperError(
-      "index must be smaller than total number of color attachments."
+      "index must be smaller than total number of color attachments.",
     );
   }
   //>>includeEnd('debug');
@@ -290,12 +290,12 @@ FramebufferManager.prototype.setColorTexture = function (texture, index) {
   //>>includeStart('debug', pragmas.debug);
   if (this._createColorAttachments) {
     throw new DeveloperError(
-      "createColorAttachments must be false if setColorTexture is called."
+      "createColorAttachments must be false if setColorTexture is called.",
     );
   }
   if (index >= this._colorAttachmentsLength) {
     throw new DeveloperError(
-      "index must be smaller than total number of color attachments."
+      "index must be smaller than total number of color attachments.",
     );
   }
   //>>includeEnd('debug');
@@ -308,7 +308,7 @@ FramebufferManager.prototype.getColorRenderbuffer = function (index) {
   //>>includeStart('debug', pragmas.debug);
   if (index >= this._colorAttachmentsLength) {
     throw new DeveloperError(
-      "index must be smaller than total number of color attachments."
+      "index must be smaller than total number of color attachments.",
     );
   }
   //>>includeEnd('debug');
@@ -317,18 +317,18 @@ FramebufferManager.prototype.getColorRenderbuffer = function (index) {
 
 FramebufferManager.prototype.setColorRenderbuffer = function (
   renderbuffer,
-  index
+  index,
 ) {
   index = defaultValue(index, 0);
   //>>includeStart('debug', pragmas.debug);
   if (this._createColorAttachments) {
     throw new DeveloperError(
-      "createColorAttachments must be false if setColorRenderbuffer is called."
+      "createColorAttachments must be false if setColorRenderbuffer is called.",
     );
   }
   if (index >= this._colorAttachmentsLength) {
     throw new DeveloperError(
-      "index must be smaller than total number of color attachments."
+      "index must be smaller than total number of color attachments.",
     );
   }
   //>>includeEnd('debug');
@@ -344,7 +344,7 @@ FramebufferManager.prototype.setDepthRenderbuffer = function (renderbuffer) {
   //>>includeStart('debug', pragmas.debug);
   if (this._createDepthAttachments) {
     throw new DeveloperError(
-      "createDepthAttachments must be false if setDepthRenderbuffer is called."
+      "createDepthAttachments must be false if setDepthRenderbuffer is called.",
     );
   }
   //>>includeEnd('debug');
@@ -360,7 +360,7 @@ FramebufferManager.prototype.setDepthTexture = function (texture) {
   //>>includeStart('debug', pragmas.debug);
   if (this._createDepthAttachments) {
     throw new DeveloperError(
-      "createDepthAttachments must be false if setDepthTexture is called."
+      "createDepthAttachments must be false if setDepthTexture is called.",
     );
   }
   //>>includeEnd('debug');
@@ -373,12 +373,12 @@ FramebufferManager.prototype.getDepthStencilRenderbuffer = function () {
 };
 
 FramebufferManager.prototype.setDepthStencilRenderbuffer = function (
-  renderbuffer
+  renderbuffer,
 ) {
   //>>includeStart('debug', pragmas.debug);
   if (this._createDepthAttachments) {
     throw new DeveloperError(
-      "createDepthAttachments must be false if setDepthStencilRenderbuffer is called."
+      "createDepthAttachments must be false if setDepthStencilRenderbuffer is called.",
     );
   }
   //>>includeEnd('debug');
@@ -394,7 +394,7 @@ FramebufferManager.prototype.setDepthStencilTexture = function (texture) {
   //>>includeStart('debug', pragmas.debug);
   if (this._createDepthAttachments) {
     throw new DeveloperError(
-      "createDepthAttachments must be false if setDepthStencilTexture is called."
+      "createDepthAttachments must be false if setDepthStencilTexture is called.",
     );
   }
   //>>includeEnd('debug');
@@ -402,6 +402,14 @@ FramebufferManager.prototype.setDepthStencilTexture = function (texture) {
   this._depthStencilTexture = texture;
 };
 
+/**
+ * If using MSAA, resolve the stencil.
+ *
+ * @param {Context} context
+ * @param {boolean} blitStencil
+ *
+ * @private
+ */
 FramebufferManager.prototype.prepareTextures = function (context, blitStencil) {
   if (this._numSamples > 1) {
     this._multisampleFramebuffer.blitFramebuffers(context, blitStencil);
@@ -411,7 +419,7 @@ FramebufferManager.prototype.prepareTextures = function (context, blitStencil) {
 FramebufferManager.prototype.clear = function (
   context,
   clearCommand,
-  passState
+  passState,
 ) {
   const framebuffer = clearCommand.framebuffer;
   clearCommand.framebuffer = this.framebuffer;
@@ -427,28 +435,26 @@ FramebufferManager.prototype.destroyFramebuffer = function () {
 
 FramebufferManager.prototype.destroy = function () {
   if (this._color) {
-    let i;
-    const length = this._colorTextures.length;
-    for (i = 0; i < length; ++i) {
-      const texture = this._colorTextures[i];
+    const colorTextures = this._colorTextures;
+    const colorRenderbuffers = this._colorRenderbuffers;
+    for (let i = 0; i < colorTextures.length; ++i) {
+      const texture = colorTextures[i];
       if (this._createColorAttachments) {
         if (defined(texture) && !texture.isDestroyed()) {
-          this._colorTextures[i].destroy();
-          this._colorTextures[i] = undefined;
+          texture.destroy();
         }
       }
       if (defined(texture) && texture.isDestroyed()) {
-        this._colorTextures[i] = undefined;
+        colorTextures[i] = undefined;
       }
-      const renderbuffer = this._colorRenderbuffers[i];
+      const renderbuffer = colorRenderbuffers[i];
       if (this._createColorAttachments) {
         if (defined(renderbuffer) && !renderbuffer.isDestroyed()) {
-          this._colorRenderbuffers[i].destroy();
-          this._colorRenderbuffers[i] = undefined;
+          renderbuffer.destroy();
         }
       }
       if (defined(renderbuffer) && renderbuffer.isDestroyed()) {
-        this._colorRenderbuffers[i] = undefined;
+        colorRenderbuffers[i] = undefined;
       }
     }
   }