@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/Model/NodeRenderResources.js

@@ -45,7 +45,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) {
    * A dictionary mapping uniform name to functions that return the uniform
    * values. Inherited from the model render resources.
    *
-   * @type {Object.<String, Function>}
+   * @type {Object<string, Function>}
    * @readonly
    *
    * @private
@@ -69,7 +69,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) {
    * when the {@link DrawCommand} is constructed. Inherited from the model
    * render resources.
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    *
    * @private
@@ -83,7 +83,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) {
    * Whether the model has a silhouette. This value indicates what draw commands
    * are needed. Inherited from the model render resources.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @private
@@ -95,7 +95,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) {
    * optimization. This value indicates what draw commands are needed.
    * Inherited from the model render resources.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @private
@@ -129,7 +129,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) {
    * The index to give to the next vertex attribute added to the attributes array.
    * POSITION takes index 0.
    *
-   * @type {Number}
+   * @type {number}
    *
    * @private
    */
@@ -139,7 +139,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) {
    * The set index to assign to feature ID vertex attribute(s) created from the
    * offset/repeat in the feature ID attribute.
    *
-   * @type {Number}
+   * @type {number}
    * @default 0
    *
    * @private
@@ -149,7 +149,7 @@ function NodeRenderResources(modelRenderResources, runtimeNode) {
   /**
    * The number of instances. This value is set by InstancingPipelineStage.
    *
-   * @type {Number}
+   * @type {number}
    * @default 0
    *
    * @private

package/Source/Scene/Model/PntsLoader.js

@@ -42,10 +42,10 @@ const MetallicRoughness = ModelComponents.MetallicRoughness;
  * @augments ResourceLoader
  * @private
  *
- * @param {Object} options An object containing the following properties
+ * @param {object} options An object containing the following properties
  * @param {ArrayBuffer} options.arrayBuffer The array buffer of the pnts contents
- * @param {Number} [options.byteOffset] The byte offset to the beginning of the pnts contents in the array buffer
- * @param {Boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer as a typed array for accurately projecting models to 2D.
+ * @param {number} [options.byteOffset] The byte offset to the beginning of the pnts contents in the array buffer
+ * @param {boolean} [options.loadAttributesFor2D=false] If true, load the positions buffer as a typed array for accurately projecting models to 2D.
  */
 function PntsLoader(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
@@ -66,7 +66,7 @@ function PntsLoader(options) {
   this._decodedAttributes = undefined;
 
   this._promise = undefined;
-  this._process = function (frameState) {};
+  this._error = undefined;
   this._state = ResourceLoaderState.UNLOADED;
   this._buffers = [];
 
@@ -81,26 +81,12 @@ if (defined(Object.create)) {
 }
 
 Object.defineProperties(PntsLoader.prototype, {
-  /**
-   * A promise that resolves to the resource when the resource is ready, or undefined if the resource hasn't started loading.
-   *
-   * @memberof PntsLoader.prototype
-   *
-   * @type {Promise.<PntsLoader>|undefined}
-   * @readonly
-   * @private
-   */
-  promise: {
-    get: function () {
-      return this._promise;
-    },
-  },
   /**
    * The cache key of the resource
    *
    * @memberof PntsLoader.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -144,32 +130,40 @@ Object.defineProperties(PntsLoader.prototype, {
 
 /**
  * Loads the resource.
- * @returns {Promise.<PntsLoader>} A promise which resolves to the loader when the resource loading is completed.
+ * @returns {Promise<PntsLoader>} A promise which resolves to the loader when the resource loading is completed.
  * @private
  */
 PntsLoader.prototype.load = function () {
+  if (defined(this._promise)) {
+    return this._promise;
+  }
+
   this._parsedContent = PntsParser.parse(this._arrayBuffer, this._byteOffset);
   this._state = ResourceLoaderState.PROCESSING;
 
-  const loader = this;
-  this._promise = new Promise(function (resolve, reject) {
-    loader._process = function (frameState) {
-      if (loader._state === ResourceLoaderState.PROCESSING) {
-        if (defined(loader._decodePromise)) {
-          return;
-        }
-
-        const decodePromise = decodeDraco(loader, frameState.context);
-        if (defined(decodePromise)) {
-          decodePromise.then(resolve).catch(reject);
-        }
-      }
-    };
-  });
+  this._promise = Promise.resolve(this);
 };
 
 PntsLoader.prototype.process = function (frameState) {
-  this._process(frameState);
+  if (defined(this._error)) {
+    const error = this._error;
+    this._error = undefined;
+    throw error;
+  }
+
+  if (this._state === ResourceLoaderState.READY) {
+    return true;
+  }
+
+  if (this._state === ResourceLoaderState.PROCESSING) {
+    if (defined(this._decodePromise)) {
+      return false;
+    }
+
+    this._decodePromise = decodeDraco(this, frameState.context);
+  }
+
+  return false;
 };
 
 function decodeDraco(loader, context) {
@@ -207,7 +201,8 @@ function decodeDraco(loader, context) {
       loader.unload();
       loader._state = ResourceLoaderState.FAILED;
       const errorMessage = "Failed to load Draco pnts";
-      return Promise.reject(loader.getError(errorMessage, error));
+      // This error will be thrown next time process is called;
+      loader._error = loader.getError(errorMessage, error);
     });
 }
 

package/Source/Scene/Model/PointCloudStylingPipelineStage.js

@@ -355,7 +355,7 @@ function addShaderFunctionsAndDefines(shaderBuilder, shaderFunctionInfo) {
  * function.
  *
  * @param {Function} source The style function.
- * @param {String[]} propertyNames The array of property names to add to.
+ * @param {string[]} propertyNames The array of property names to add to.
  *
  * @private
  */

package/Source/Scene/Model/PrimitiveOutlineGenerator.js

@@ -32,10 +32,10 @@ const MAX_GLTF_UINT8_INDEX = 255;
  * @alias PrimitiveOutlineGenerator
  * @constructor
  *
- * @param {Number} options Object with the following properties:
+ * @param {number} options Object with the following properties:
  * @param {Uint8Array|Uint16Array|Uint32Array} options.triangleIndices The original triangle indices of the primitive. The constructor takes ownership of this typed array as it will be modified internally. Use the updatedTriangleIndices getter to get the final result.
- * @param {Number[]} options.outlineIndices The indices of edges in the triangle from the CESIUM_primitive_outline extension
- * @param {Number} options.originalVertexCount The original number of vertices in the primitive
+ * @param {number[]} options.outlineIndices The indices of edges in the triangle from the CESIUM_primitive_outline extension
+ * @param {number} options.originalVertexCount The original number of vertices in the primitive
  * @example
  * // The constructor will compute the updated indices and generate outline
  * // coordinates.
@@ -88,7 +88,7 @@ function PrimitiveOutlineGenerator(options) {
   /**
    * How many vertices were originally in the primitive
    *
-   * @type {Number}
+   * @type {number}
    *
    * @private
    */
@@ -120,7 +120,7 @@ function PrimitiveOutlineGenerator(options) {
    * Array containing the indices of any vertices that must be copied and
    * appended to the list.
    *
-   * @type {Number[]}
+   * @type {number[]}
    *
    * @private
    */
@@ -294,14 +294,14 @@ function initialize(outlineGenerator) {
  * and if found, computes outline coordinates for the three vertices. If not
  * possible, one of the vertices is returned so it can be copied.
  *
- * @param {Number[]} outlineCoordinates An array to store the computed outline coordinates. There are 3 components per vertex. This will be modified in place.
- * @param {Number} i0 The index of the first vertex of the triangle.
- * @param {Number} i1 The index of the second vertex of the triangle.
- * @param {Number} i2 The index of the third vertex of the triangle.
- * @param {Boolean} hasEdge01 Whether there is an outline edge between vertices 0 and 1 of the triangle
- * @param {Boolean} hasEdge12 Whether there is an outline edge between vertices 1 and 2 of the triangle
- * @param {Boolean} hasEdge20 Whether there is an outline edge between vertices 2 and 0 of the triangle
- * @returns {Number} If it's not possible to compute consistent outline coordinates for this triangle, the index of the most constrained vertex of i0, i1 and i2 is returned. Otherwise, this function returns undefined to indicate a successful match.
+ * @param {number[]} outlineCoordinates An array to store the computed outline coordinates. There are 3 components per vertex. This will be modified in place.
+ * @param {number} i0 The index of the first vertex of the triangle.
+ * @param {number} i1 The index of the second vertex of the triangle.
+ * @param {number} i2 The index of the third vertex of the triangle.
+ * @param {boolean} hasEdge01 Whether there is an outline edge between vertices 0 and 1 of the triangle
+ * @param {boolean} hasEdge12 Whether there is an outline edge between vertices 1 and 2 of the triangle
+ * @param {boolean} hasEdge20 Whether there is an outline edge between vertices 2 and 0 of the triangle
+ * @returns {number} If it's not possible to compute consistent outline coordinates for this triangle, the index of the most constrained vertex of i0, i1 and i2 is returned. Otherwise, this function returns undefined to indicate a successful match.
  *
  * @private
  */
@@ -448,12 +448,12 @@ function matchAndStoreCoordinates(
  * Then we can find an ordering that works for all three vertices with a
  * bitwise AND.
  *
- * @param {Number[]} outlineCoordinates The array of outline coordinates
- * @param {Number} vertexIndex The index of the vertex to compute the mask for
- * @param {Number} a The outline coordinate for edge 2-0
- * @param {Number} b The outline coordinate for edge 0-1
- * @param {Number} c The outline coordinate for edge 1-2
- * @returns {Number} A bitmask with 6 bits where a 1 indicates the corresponding ordering is valid.
+ * @param {number[]} outlineCoordinates The array of outline coordinates
+ * @param {number} vertexIndex The index of the vertex to compute the mask for
+ * @param {number} a The outline coordinate for edge 2-0
+ * @param {number} b The outline coordinate for edge 0-1
+ * @param {number} c The outline coordinate for edge 1-2
+ * @returns {number} A bitmask with 6 bits where a 1 indicates the corresponding ordering is valid.
  *
  * @private
  */
@@ -483,8 +483,8 @@ function computeOrderMask(outlineCoordinates, vertexIndex, a, b, c) {
  * Compute the popcount for 6-bit integers (values 0-63). This is the
  * number of 1s in the binary representation of the value.
  *
- * @param {Number} value The value to compute the popcount for
- * @returns {Number} The number of 1s in the binary representation of value
+ * @param {number} value The value to compute the popcount for
+ * @returns {number} The number of 1s in the binary representation of value
  *
  * @private
  */
@@ -601,7 +601,7 @@ PrimitiveOutlineGenerator.createTexture = function (context) {
  * mostly 0 values, except for the last value which is brighter to indicate
  * the outline.
  *
- * @param {Number} size The width of the texture for this mip level
+ * @param {number} size The width of the texture for this mip level
  * @returns {Uint8Array} A typed array containing the texels of the mip level
  *
  * @private
@@ -634,8 +634,8 @@ function createMipLevel(size) {
  * @alias EdgeSet
  * @constructor
  *
- * @param {Number[]} edgeIndices An array of vertex indices with an even number of elements where each pair of indices defines an edge.
- * @param {Number} originalVertexCount The original number of vertices. This is used for computing a hash function.
+ * @param {number[]} edgeIndices An array of vertex indices with an even number of elements where each pair of indices defines an edge.
+ * @param {number} originalVertexCount The original number of vertices. This is used for computing a hash function.
  *
  * @private
  */
@@ -644,7 +644,7 @@ function EdgeSet(edgeIndices, originalVertexCount) {
    * Original number of vertices in the primitive. This is used for computing
    * the hash key
    *
-   * @type {Number}
+   * @type {number}
    *
    * @private
    */
@@ -673,9 +673,9 @@ function EdgeSet(edgeIndices, originalVertexCount) {
 /**
  * Check if an edge exists in the set. The order of the input vertices does
  * not matter.
- * @param {Number} a The first index
- * @param {Number} b The second index
- * @returns {Boolean} true if there is an edge between a and b
+ * @param {number} a The first index
+ * @param {number} b The second index
+ * @returns {boolean} true if there is an edge between a and b
  *
  * @private
  */

package/Source/Scene/Model/PrimitiveRenderResources.js

@@ -57,7 +57,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * The index to give to the next vertex attribute added to the attributes
    * array. POSITION takes index 0. Inherited from the node render resources.
    *
-   * @type {Number}
+   * @type {number}
    *
    * @private
    */
@@ -68,7 +68,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * offset/repeat in the feature ID attribute. Inherited from the node render
    * resources.
    *
-   * @type {Number}
+   * @type {number}
    *
    * @private
    */
@@ -79,7 +79,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * A dictionary mapping uniform name to functions that return the uniform
    * values. Inherited from the node render resources.
    *
-   * @type {Object.<String, Function>}
+   * @type {Object<string, Function>}
    * @readonly
    *
    * @private
@@ -103,7 +103,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * is created when the {@link DrawCommand} is constructed. Inherited from
    * the node render resources.
    *
-   * @type {Object}
+   * @type {object}
    * @readonly
    *
    * @private
@@ -114,7 +114,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * Whether the model has a silhouette. This value indicates what draw commands
    * are needed. Inherited from the node render resources.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @private
@@ -126,7 +126,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * optimization. This value indicates what draw commands are needed.
    * Inherited from the node render resources.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @readonly
    *
    * @private
@@ -148,7 +148,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * The number of instances. Default is 0, if instancing is not used.
    * Inherited from the node render resources.
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -180,7 +180,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * The number of indices in the primitive. The interpretation of this
    * depends on the primitive type.
    *
-   * @type {Number}
+   * @type {number}
    * @readonly
    *
    * @private
@@ -194,7 +194,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * When present, picking and styling can use this. This value is set by
    * SelectedFeatureIdPipelineStage.
    *
-   * @type {Boolean}
+   * @type {boolean}
    * @default false
    *
    * @private
@@ -287,7 +287,7 @@ function PrimitiveRenderResources(nodeRenderResources, runtimePrimitive) {
    * The shader variable to use for picking. If picking is enabled, this value
    * is set by PickingPipelineStage.
    *
-   * @type {String}
+   * @type {string}
    *
    * @private
    */

package/Source/Scene/Model/StyleCommandsNeeded.js

@@ -2,7 +2,7 @@
  * An enum describing what commands (opaque or translucent) are required by
  * a {@link Cesium3DTileStyle}.
  *
- * @enum {Number}
+ * @enum {number}
  * @private
  */
 const StyleCommandsNeeded = {

package/Source/Scene/Model/TextureManager.js

@@ -29,7 +29,7 @@ function TextureManager() {
 
 /**
  * Get one of the loaded textures
- * @param {String} textureId The unique ID of the texture loaded by {@link TextureManager#loadTexture2D}
+ * @param {string} textureId The unique ID of the texture loaded by {@link TextureManager#loadTexture2D}
  * @return {Texture} The texture or <code>undefined</code> if no texture exists
  */
 TextureManager.prototype.getTexture = function (textureId) {
@@ -60,7 +60,7 @@ function fetchTexture2D(textureManager, textureId, textureUniform) {
  * Load a texture 2D asynchronously. Note that {@link TextureManager#update}
  * must be called in the render loop to finish processing the textures.
  *
- * @param {String} textureId A unique ID to identify this texture.
+ * @param {string} textureId A unique ID to identify this texture.
  * @param {TextureUniform} textureUniform A description of the texture
  *
  * @private
@@ -203,7 +203,7 @@ TextureManager.prototype.update = function (frameState) {
  * If this object was destroyed, it should not be used; calling any function other than
  * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
  *
- * @returns {Boolean} True if this object was destroyed; otherwise, false.
+ * @returns {boolean} True if this object was destroyed; otherwise, false.
  *
  * @see TextureManager#destroy
  * @private

package/Source/Scene/Model/TextureUniform.js

@@ -11,17 +11,17 @@ import TextureWrap from "../../Renderer/TextureWrap.js";
  * A simple struct that serves as a value of a <code>sampler2D</code>-valued
  * uniform. This is used with {@link CustomShader} and {@link TextureManager}
  *
- * @param {Object} options An object with the following properties:
+ * @param {object} options An object with the following properties:
  * @param {Uint8Array} [options.typedArray] A typed array storing the contents of a texture. Values are stored in row-major order. Since WebGL uses a y-up convention for textures, rows are listed from bottom to top.
- * @param {Number} [options.width] The width of the image. Required when options.typedArray is present
- * @param {Number} [options.height] The height of the image. Required when options.typedArray is present.
- * @param {String|Resource} [options.url] A URL string or resource pointing to a texture image.
- * @param {Boolean} [options.repeat=true] When defined, the texture sampler will be set to wrap in both directions
+ * @param {number} [options.width] The width of the image. Required when options.typedArray is present
+ * @param {number} [options.height] The height of the image. Required when options.typedArray is present.
+ * @param {string|Resource} [options.url] A URL string or resource pointing to a texture image.
+ * @param {boolean} [options.repeat=true] When defined, the texture sampler will be set to wrap in both directions
  * @param {PixelFormat} [options.pixelFormat=PixelFormat.RGBA] When options.typedArray is defined, this is used to determine the pixel format of the texture
  * @param {PixelDatatype} [options.pixelDatatype=PixelDatatype.UNSIGNED_BYTE] When options.typedArray is defined, this is the data type of pixel values in the typed array.
  * @param {TextureMinificationFilter} [options.minificationFilter=TextureMinificationFilter.LINEAR] The minification filter of the texture sampler.
  * @param {TextureMagnificationFilter} [options.magnificationFilter=TextureMagnificationFilter.LINEAR] The magnification filter of the texture sampler.
- * @param {Number} [options.maximumAnisotropy=1.0] The maximum anisotropy of the texture sampler
+ * @param {number} [options.maximumAnisotropy=1.0] The maximum anisotropy of the texture sampler
  *
  * @alias TextureUniform
  * @constructor

package/Source/Scene/Model/UniformType.js

@@ -2,7 +2,7 @@
  * An enum of the basic GLSL uniform types. These can be used with
  * {@link CustomShader} to declare user-defined uniforms.
  *
- * @enum {String}
+ * @enum {string}
  *
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
  */
@@ -10,111 +10,111 @@ const UniformType = {
   /**
    * A single floating point value.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   FLOAT: "float",
   /**
    * A vector of 2 floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   VEC2: "vec2",
   /**
    * A vector of 3 floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   VEC3: "vec3",
   /**
    * A vector of 4 floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   VEC4: "vec4",
   /**
    * A single integer value
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   INT: "int",
   /**
    * A vector of 2 integer values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   INT_VEC2: "ivec2",
   /**
    * A vector of 3 integer values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   INT_VEC3: "ivec3",
   /**
    * A vector of 4 integer values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   INT_VEC4: "ivec4",
   /**
    * A single boolean value.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   BOOL: "bool",
   /**
    * A vector of 2 boolean values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   BOOL_VEC2: "bvec2",
   /**
    * A vector of 3 boolean values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   BOOL_VEC3: "bvec3",
   /**
    * A vector of 4 boolean values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   BOOL_VEC4: "bvec4",
   /**
    * A 2x2 matrix of floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   MAT2: "mat2",
   /**
    * A 3x3 matrix of floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   MAT3: "mat2",
   /**
    * A 3x3 matrix of floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   MAT4: "mat4",
   /**
    * A 2D sampled texture.
-   * @type {String}
+   * @type {string}
    * @constant
    */
   SAMPLER_2D: "sampler2D",

package/Source/Scene/Model/VaryingType.js

@@ -2,7 +2,7 @@
  * An enum for the GLSL varying types. These can be used for declaring varyings
  * in {@link CustomShader}
  *
- * @enum {String}
+ * @enum {string}
  *
  * @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
  */
@@ -10,49 +10,49 @@ const VaryingType = {
   /**
    * A single floating point value.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   FLOAT: "float",
   /**
    * A vector of 2 floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   VEC2: "vec2",
   /**
    * A vector of 3 floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   VEC3: "vec3",
   /**
    * A vector of 4 floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   VEC4: "vec4",
   /**
    * A 2x2 matrix of floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   MAT2: "mat2",
   /**
    * A 3x3 matrix of floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   MAT3: "mat2",
   /**
    * A 3x3 matrix of floating point values.
    *
-   * @type {String}
+   * @type {string}
    * @constant
    */
   MAT4: "mat4",