@cesium/engine 10.1.0 → 11.1.0

package/Source/Renderer/CubeMapFace.js

@@ -19,7 +19,7 @@ function CubeMapFace(
   size,
   preMultiplyAlpha,
   flipY,
-  initialized
+  initialized,
 ) {
   this._context = context;
   this._texture = texture;
@@ -86,26 +86,30 @@ CubeMapFace.prototype.copyFrom = function (options) {
   Check.defined("options", options);
   //>>includeEnd('debug');
 
-  const xOffset = defaultValue(options.xOffset, 0);
-  const yOffset = defaultValue(options.yOffset, 0);
+  const {
+    xOffset = 0,
+    yOffset = 0,
+    source,
+    skipColorSpaceConversion = false,
+  } = options;
 
   //>>includeStart('debug', pragmas.debug);
-  Check.defined("options.source", options.source);
+  Check.defined("options.source", source);
   Check.typeOf.number.greaterThanOrEquals("xOffset", xOffset, 0);
   Check.typeOf.number.greaterThanOrEquals("yOffset", yOffset, 0);
-  if (xOffset + options.source.width > this._size) {
+  if (xOffset + source.width > this._size) {
     throw new DeveloperError(
-      "xOffset + options.source.width must be less than or equal to width."
+      "xOffset + options.source.width must be less than or equal to width.",
     );
   }
-  if (yOffset + options.source.height > this._size) {
+  if (yOffset + source.height > this._size) {
     throw new DeveloperError(
-      "yOffset + options.source.height must be less than or equal to height."
+      "yOffset + options.source.height must be less than or equal to height.",
     );
   }
   //>>includeEnd('debug');
 
-  const source = options.source;
+  const { width, height } = source;
 
   const gl = this._context._gl;
   const target = this._textureTarget;
@@ -114,8 +118,6 @@ CubeMapFace.prototype.copyFrom = function (options) {
   gl.activeTexture(gl.TEXTURE0);
   gl.bindTexture(target, this._texture);
 
-  const width = source.width;
-  const height = source.height;
   let arrayBufferView = source.arrayBufferView;
 
   const size = this._size;
@@ -125,20 +127,15 @@ CubeMapFace.prototype.copyFrom = function (options) {
 
   const preMultiplyAlpha = this._preMultiplyAlpha;
   const flipY = this._flipY;
-  const skipColorSpaceConversion = defaultValue(
-    options.skipColorSpaceConversion,
-    false
-  );
 
   let unpackAlignment = 4;
   if (defined(arrayBufferView)) {
     unpackAlignment = PixelFormat.alignmentInBytes(
       pixelFormat,
       pixelDatatype,
-      width
+      width,
     );
   }
-
   gl.pixelStorei(gl.UNPACK_ALIGNMENT, unpackAlignment);
 
   if (skipColorSpaceConversion) {
@@ -146,76 +143,57 @@ CubeMapFace.prototype.copyFrom = function (options) {
   } else {
     gl.pixelStorei(
       gl.UNPACK_COLORSPACE_CONVERSION_WEBGL,
-      gl.BROWSER_DEFAULT_WEBGL
+      gl.BROWSER_DEFAULT_WEBGL,
     );
   }
 
   let uploaded = false;
   if (!this._initialized) {
+    let pixels;
     if (xOffset === 0 && yOffset === 0 && width === size && height === size) {
       // initialize the entire texture
       if (defined(arrayBufferView)) {
         gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, false);
         gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, false);
-
         if (flipY) {
           arrayBufferView = PixelFormat.flipY(
             arrayBufferView,
             pixelFormat,
             pixelDatatype,
             size,
-            size
+            size,
           );
         }
-        gl.texImage2D(
-          targetFace,
-          0,
-          internalFormat,
-          size,
-          size,
-          0,
-          pixelFormat,
-          PixelDatatype.toWebGLConstant(pixelDatatype, this._context),
-          arrayBufferView
-        );
+        pixels = arrayBufferView;
       } else {
         // Only valid for DOM-Element uploads
         gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, preMultiplyAlpha);
         gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, flipY);
-
-        gl.texImage2D(
-          targetFace,
-          0,
-          internalFormat,
-          pixelFormat,
-          PixelDatatype.toWebGLConstant(pixelDatatype, this._context),
-          source
-        );
+        pixels = source;
       }
       uploaded = true;
     } else {
+      // initialize the entire texture to zero
       gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, false);
       gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, false);
-
-      // initialize the entire texture to zero
-      const bufferView = PixelFormat.createTypedArray(
+      pixels = PixelFormat.createTypedArray(
         pixelFormat,
         pixelDatatype,
         size,
-        size
-      );
-      gl.texImage2D(
-        targetFace,
-        0,
-        internalFormat,
         size,
-        size,
-        0,
-        pixelFormat,
-        PixelDatatype.toWebGLConstant(pixelDatatype, this._context),
-        bufferView
       );
     }
+    gl.texImage2D(
+      targetFace,
+      0,
+      internalFormat,
+      size,
+      size,
+      0,
+      pixelFormat,
+      PixelDatatype.toWebGLConstant(pixelDatatype, this._context),
+      pixels,
+    );
     this._initialized = true;
   }
 
@@ -230,7 +208,7 @@ CubeMapFace.prototype.copyFrom = function (options) {
           pixelFormat,
           pixelDatatype,
           width,
-          height
+          height,
         );
       }
       gl.texSubImage2D(
@@ -242,7 +220,7 @@ CubeMapFace.prototype.copyFrom = function (options) {
         height,
         pixelFormat,
         PixelDatatype.toWebGLConstant(pixelDatatype, this._context),
-        arrayBufferView
+        arrayBufferView,
       );
     } else {
       // Only valid for DOM-Element uploads
@@ -257,7 +235,7 @@ CubeMapFace.prototype.copyFrom = function (options) {
         yOffset,
         pixelFormat,
         PixelDatatype.toWebGLConstant(pixelDatatype, this._context),
-        source
+        source,
       );
     }
   }
@@ -296,7 +274,7 @@ CubeMapFace.prototype.copyFromFramebuffer = function (
   framebufferXOffset,
   framebufferYOffset,
   width,
-  height
+  height,
 ) {
   xOffset = defaultValue(xOffset, 0);
   yOffset = defaultValue(yOffset, 0);
@@ -311,31 +289,31 @@ CubeMapFace.prototype.copyFromFramebuffer = function (
   Check.typeOf.number.greaterThanOrEquals(
     "framebufferXOffset",
     framebufferXOffset,
-    0
+    0,
   );
   Check.typeOf.number.greaterThanOrEquals(
     "framebufferYOffset",
     framebufferYOffset,
-    0
+    0,
   );
   if (xOffset + width > this._size) {
     throw new DeveloperError(
-      "xOffset + source.width must be less than or equal to width."
+      "xOffset + source.width must be less than or equal to width.",
     );
   }
   if (yOffset + height > this._size) {
     throw new DeveloperError(
-      "yOffset + source.height must be less than or equal to height."
+      "yOffset + source.height must be less than or equal to height.",
     );
   }
   if (this._pixelDatatype === PixelDatatype.FLOAT) {
     throw new DeveloperError(
-      "Cannot call copyFromFramebuffer when the texture pixel data type is FLOAT."
+      "Cannot call copyFromFramebuffer when the texture pixel data type is FLOAT.",
     );
   }
   if (this._pixelDatatype === PixelDatatype.HALF_FLOAT) {
     throw new DeveloperError(
-      "Cannot call copyFromFramebuffer when the texture pixel data type is HALF_FLOAT."
+      "Cannot call copyFromFramebuffer when the texture pixel data type is HALF_FLOAT.",
     );
   }
   //>>includeEnd('debug');
@@ -353,7 +331,7 @@ CubeMapFace.prototype.copyFromFramebuffer = function (
     framebufferXOffset,
     framebufferYOffset,
     width,
-    height
+    height,
   );
   gl.bindTexture(target, null);
   this._initialized = true;

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();