@cesium/engine 2.0.0 → 2.2.0

package/Source/Scene/Model/I3dmLoader.js

@@ -53,19 +53,19 @@ const Instances = ModelComponents.Instances;
  * @augments ResourceLoader
  * @private
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Resource} options.i3dmResource The {@link Resource} containing the i3dm.
  * @param {ArrayBuffer} options.arrayBuffer The array buffer of the i3dm contents.
- * @param {Number} [options.byteOffset=0] The byte offset to the beginning of the i3dm contents in the array buffer.
+ * @param {number} [options.byteOffset=0] The byte offset to the beginning of the i3dm contents in the array buffer.
  * @param {Resource} [options.baseResource] The {@link Resource} that paths in the glTF JSON are relative to.
- * @param {Boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective.
- * @param {Boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
- * @param {Boolean} [options.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded.
+ * @param {boolean} [options.releaseGltfJson=false] When true, the glTF JSON is released once the glTF is loaded. This is is especially useful for cases like 3D Tiles, where each .gltf model is unique and caching the glTF JSON is not effective.
+ * @param {boolean} [options.asynchronous=true] Determines if WebGL resource creation will be spread out over several frames or block until all WebGL resources are created.
+ * @param {boolean} [options.incrementallyLoadTextures=true] Determine if textures may continue to stream in after the glTF is loaded.
  * @param {Axis} [options.upAxis=Axis.Y] The up-axis of the glTF model.
  * @param {Axis} [options.forwardAxis=Axis.X] The forward-axis of the glTF model.
- * @param {Boolean} [options.loadAttributesAsTypedArray=false] Load all attributes as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array.
- * @param {Boolean} [options.loadIndicesForWireframe=false] Load the index buffer as a typed array so wireframe indices can be created for WebGL1.
- * @param {Boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time.
+ * @param {boolean} [options.loadAttributesAsTypedArray=false] Load all attributes as typed arrays instead of GPU buffers. If the attributes are interleaved in the glTF they will be de-interleaved in the typed array.
+ * @param {boolean} [options.loadIndicesForWireframe=false] Load the index buffer as a typed array so wireframe indices can be created for WebGL1.
+ * @param {boolean} [options.loadPrimitiveOutline=true] If true, load outlines from the {@link https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Vendor/CESIUM_primitive_outline|CESIUM_primitive_outline} extension. This can be set false to avoid post-processing geometry at load time.
  */
 function I3dmLoader(options) {
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
@@ -116,9 +116,6 @@ function I3dmLoader(options) {
   this._promise = undefined;
 
   this._gltfLoader = undefined;
-  this._gltfLoaderPromise = undefined;
-  this._process = function (loader, frameState) {};
-  this._postProcess = function (loader, frameState) {};
 
   // Instanced attributes are initially parsed as typed arrays, but if they
   // do not need to be further processed (e.g. turned into transform matrices),
@@ -140,34 +137,17 @@ if (defined(Object.create)) {
 
 Object.defineProperties(I3dmLoader.prototype, {
   /**
-   * A promise that resolves to the resource when the resource is ready, or undefined if the resource hasn't started loading.
+   * true if textures are loaded, useful when incrementallyLoadTextures is true
    *
-   * @memberof I3dmLoader.prototype
-   *
-   * @type {Promise.<I3dmLoader>|undefined}
-   * @readonly
-   * @private
-   */
-  promise: {
-    get: function () {
-      return this._promise;
-    },
-  },
-
-  /**
-   * A promise that resolves when all textures are loaded.
-   * When <code>incrementallyLoadTextures</code> is true this may resolve after
-   * <code>promise</code> resolves.
+   * @memberof  I3dmLoader.prototype
    *
-   * @memberof I3dmLoader.prototype
-   *
-   * @type {Promise}
+   * @type {boolean}
    * @readonly
    * @private
    */
-  texturesLoadedPromise: {
+  texturesLoaded: {
     get: function () {
-      return this._gltfLoader.texturesLoadedPromise;
+      return this._gltfLoader?.texturesLoaded;
     },
   },
   /**
@@ -175,7 +155,7 @@ Object.defineProperties(I3dmLoader.prototype, {
    *
    * @memberof I3dmLoader.prototype
    *
-   * @type {String}
+   * @type {string}
    * @readonly
    * @private
    */
@@ -204,10 +184,14 @@ Object.defineProperties(I3dmLoader.prototype, {
 
 /**
  * Loads the resource.
- * @returns {Promise.<I3dmLoader>} A promise which resolves to the loader when the resource loading is completed.
+ * @returns {Promise<I3dmLoader>} A promise which resolves to the loader when the resource loading is completed.
  * @private
  */
 I3dmLoader.prototype.load = function () {
+  if (defined(this._promise)) {
+    return this._promise;
+  }
+
   // Parse the i3dm into its various sections.
   const i3dm = I3dmParser.parse(this._arrayBuffer, this._byteOffset);
 
@@ -282,53 +266,21 @@ I3dmLoader.prototype.load = function () {
   this._gltfLoader = gltfLoader;
   this._state = I3dmLoaderState.LOADING;
 
-  gltfLoader.load();
-
-  const that = this;
-  const processPromise = new Promise(function (resolve) {
-    that._process = function (loader, frameState) {
-      loader._gltfLoader.process(frameState);
-    };
-
-    that._postProcess = function (loader, frameState) {
-      const gltfLoader = loader._gltfLoader;
-      const components = gltfLoader.components;
-
-      // Combine the RTC_CENTER transform from the i3dm and the CESIUM_RTC
-      // transform from the glTF. In practice CESIUM_RTC is not set for
-      // instanced models but multiply the transforms just in case.
-      components.transform = Matrix4.multiplyTransformation(
-        loader._transform,
-        components.transform,
-        components.transform
-      );
-
-      createInstances(loader, components, frameState);
-      createStructuralMetadata(loader, components);
-      loader._components = components;
-
-      // Now that we have the parsed components, we can release the array buffer
-      loader._arrayBuffer = undefined;
-
-      loader._state = I3dmLoaderState.READY;
-      resolve(loader);
-    };
-  });
-
-  this._promise = gltfLoader.promise
-    .then(function () {
-      if (that.isDestroyed()) {
+  this._promise = gltfLoader
+    .load()
+    .then(() => {
+      if (this.isDestroyed()) {
         return;
       }
-      that._state = I3dmLoaderState.POST_PROCESSING;
 
-      return processPromise;
+      this._state = I3dmLoaderState.PROCESSING;
+      return this;
     })
-    .catch(function (error) {
-      if (that.isDestroyed()) {
+    .catch((error) => {
+      if (this.isDestroyed()) {
         return;
       }
-      return handleError(that, error);
+      throw handleError(this, error);
     });
 
   return this._promise;
@@ -338,8 +290,7 @@ function handleError(i3dmLoader, error) {
   i3dmLoader.unload();
   i3dmLoader._state = I3dmLoaderState.FAILED;
   const errorMessage = "Failed to load i3dm";
-  error = i3dmLoader.getError(errorMessage, error);
-  return Promise.reject(error);
+  return i3dmLoader.getError(errorMessage, error);
 }
 
 I3dmLoader.prototype.process = function (frameState) {
@@ -347,17 +298,40 @@ I3dmLoader.prototype.process = function (frameState) {
   Check.typeOf.object("frameState", frameState);
   //>>includeEnd('debug');
 
-  if (this._state === I3dmLoaderState.LOADING) {
-    this._state = I3dmLoaderState.PROCESSING;
+  if (this._state === I3dmLoaderState.READY) {
+    return true;
   }
 
+  const gltfLoader = this._gltfLoader;
+  let ready = false;
   if (this._state === I3dmLoaderState.PROCESSING) {
-    this._process(this, frameState);
+    ready = gltfLoader.process(frameState);
   }
 
-  if (this._state === I3dmLoaderState.POST_PROCESSING) {
-    this._postProcess(this, frameState);
+  if (!ready) {
+    return false;
   }
+
+  const components = gltfLoader.components;
+
+  // Combine the RTC_CENTER transform from the i3dm and the CESIUM_RTC
+  // transform from the glTF. In practice CESIUM_RTC is not set for
+  // instanced models but multiply the transforms just in case.
+  components.transform = Matrix4.multiplyTransformation(
+    this._transform,
+    components.transform,
+    components.transform
+  );
+
+  createInstances(this, components, frameState);
+  createStructuralMetadata(this, components);
+  this._components = components;
+
+  // Now that we have the parsed components, we can release the array buffer
+  this._arrayBuffer = undefined;
+
+  this._state = I3dmLoaderState.READY;
+  return true;
 };
 
 function createStructuralMetadata(loader, components) {
@@ -895,7 +869,7 @@ I3dmLoader.prototype.isUnloaded = function () {
 };
 
 I3dmLoader.prototype.unload = function () {
-  if (defined(this._gltfLoader)) {
+  if (defined(this._gltfLoader) && !this._gltfLoader.isDestroyed()) {
     this._gltfLoader.unload();
   }
 

package/Source/Scene/Model/LightingModel.js

@@ -1,7 +1,7 @@
 /**
  * The lighting model to use for lighting a {@link Model}.
  *
- * @enum {Number}
+ * @enum {number}
  *
  * @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.
  */
@@ -12,7 +12,7 @@ const LightingModel = {
    * when computing <code>out_FragColor</code>. The alpha mode is still
    * applied.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   UNLIT: 0,
@@ -21,7 +21,7 @@ const LightingModel = {
    * both PBR metallic roughness and PBR specular glossiness. Image-based
    * lighting is also applied when possible.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   PBR: 1,

package/Source/Scene/Model/MaterialPipelineStage.js

@@ -142,10 +142,10 @@ MaterialPipelineStage.process = function (
  * Process a single texture transformation and add it to the shader and uniform map.
  *
  * @param {ShaderBuilder} shaderBuilder The shader builder to modify
- * @param {Object.<String, Function>} uniformMap The uniform map to modify.
+ * @param {Object<string, Function>} uniformMap The uniform map to modify.
  * @param {ModelComponents.TextureReader} textureReader The texture to add to the shader
- * @param {String} uniformName The name of the sampler uniform such as <code>u_baseColorTexture</code>
- * @param {String} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE"
+ * @param {string} uniformName The name of the sampler uniform such as <code>u_baseColorTexture</code>
+ * @param {string} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE"
  *
  * @private
  */
@@ -180,10 +180,10 @@ function processTextureTransform(
  * Process a single texture and add it to the shader and uniform map.
  *
  * @param {ShaderBuilder} shaderBuilder The shader builder to modify
- * @param {Object.<String, Function>} uniformMap The uniform map to modify.
+ * @param {Object<string, Function>} uniformMap The uniform map to modify.
  * @param {ModelComponents.TextureReader} textureReader The texture to add to the shader
- * @param {String} uniformName The name of the sampler uniform such as <code>u_baseColorTexture</code>
- * @param {String} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE"
+ * @param {string} uniformName The name of the sampler uniform such as <code>u_baseColorTexture</code>
+ * @param {string} defineName The name of the texture for use in the defines, minus any prefix or suffix. For example, "BASE_COLOR" or "EMISSIVE"
  *
  * @private
  */

package/Source/Scene/Model/MetadataPipelineStage.js

@@ -120,7 +120,7 @@ MetadataPipelineStage.process = function (
  * return as a flattened Array
  * @param {PropertyAttribute[]} propertyAttributes The PropertyAttributes with properties to be described
  * @param {ModelComponents.Primitive} primitive The primitive to be rendered
- * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
+ * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
  * @returns {Object[]} An array of objects containing information about each PropertyAttributeProperty
  * @private
  */
@@ -137,7 +137,7 @@ function getPropertyAttributesInfo(propertyAttributes, primitive, statistics) {
  * Collect info about the properties of a single PropertyAttribute
  * @param {PropertyAttribute} propertyAttribute The PropertyAttribute with properties to be described
  * @param {ModelComponents.Primitive} primitive The primitive to be rendered
- * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
+ * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
  * @returns {Object[]} An array of objects containing information about each PropertyAttributeProperty
  * @private
  */
@@ -177,7 +177,7 @@ function getPropertyAttributeInfo(propertyAttribute, primitive, statistics) {
  * Collect info about all properties of all propertyTextures, and
  * return as a flattened Array
  * @param {PropertyTexture[]} propertyTextures The PropertyTextures with properties to be described
- * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
+ * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
  * @returns {Object[]} An array of objects containing information about each PropertyTextureProperty
  * @private
  */
@@ -193,7 +193,7 @@ function getPropertyTexturesInfo(propertyTextures, statistics) {
 /**
  * Collect info about the properties of a single PropertyTexture
  * @param {PropertyTexture} propertyTexture The PropertyTexture with properties to be described
- * @param {Object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
+ * @param {object} [statistics] Statistics about the properties (if the model is from a 3DTiles tileset)
  * @returns {Object[]} An array of objects containing information about each PropertyTextureProperty
  * @private
  */
@@ -278,8 +278,8 @@ const floatConversions = {
 
 /**
  * For a type with integer components, find a corresponding float-component type
- * @param {String} type The name of a GLSL type with integer components
- * @returns {String} The name of a GLSL type of the same dimension with float components, if available; otherwise the input type
+ * @param {string} type The name of a GLSL type with integer components
+ * @returns {string} The name of a GLSL type of the same dimension with float components, if available; otherwise the input type
  * @private
  */
 function convertToFloatComponents(type) {
@@ -354,7 +354,7 @@ function declareStructsAndFunctions(shaderBuilder) {
 /**
  * Update the shader for a single PropertyAttributeProperty
  * @param {PrimitiveRenderResources} renderResources The render resources for the primitive
- * @param {Object} propertyInfo Info about the PropertyAttributeProperty
+ * @param {object} propertyInfo Info about the PropertyAttributeProperty
  * @private
  */
 function processPropertyAttributeProperty(renderResources, propertyInfo) {
@@ -367,7 +367,7 @@ function processPropertyAttributeProperty(renderResources, propertyInfo) {
  * Add fields to the Metadata struct, and metadata value assignments to the
  * initializeMetadata function, for a PropertyAttributeProperty
  * @param {PrimitiveRenderResources} renderResources The render resources for the primitive
- * @param {Object} propertyInfo Info about the PropertyAttributeProperty
+ * @param {object} propertyInfo Info about the PropertyAttributeProperty
  * @private
  */
 function addPropertyAttributePropertyMetadata(renderResources, propertyInfo) {
@@ -423,7 +423,7 @@ function processPropertyTextureProperty(renderResources, propertyInfo) {
  * Add fields to the Metadata struct, and metadata value expressions to the
  * initializeMetadata function, for a PropertyTextureProperty
  * @param {PrimitiveRenderResources} renderResources The render resources for the primitive
- * @param {Object} propertyInfo Info about the PropertyTextureProperty
+ * @param {object} propertyInfo Info about the PropertyTextureProperty
  * @private
  */
 function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
@@ -480,7 +480,7 @@ function addPropertyTexturePropertyMetadata(renderResources, propertyInfo) {
  * to the initializeMetadata function, for a PropertyAttributeProperty or
  * PropertyTextureProperty
  * @param {ShaderBuilder} shaderBuilder The shader builder for the primitive
- * @param {Object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty
+ * @param {object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty
  * @private
  */
 function addPropertyMetadataClass(shaderBuilder, propertyInfo) {
@@ -525,7 +525,7 @@ function addPropertyMetadataClass(shaderBuilder, propertyInfo) {
  * expressions to the initializeMetadata function, for a
  * PropertyAttributeProperty or PropertyTextureProperty
  * @param {ShaderBuilder} shaderBuilder The shader builder for the primitive
- * @param {Object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty
+ * @param {object} propertyInfo Info about the PropertyAttributeProperty or PropertyTextureProperty
  * @private
  */
 function addPropertyMetadataStatistics(shaderBuilder, propertyInfo) {
@@ -577,39 +577,38 @@ function addPropertyMetadataStatistics(shaderBuilder, propertyInfo) {
 /**
  * Construct GLSL assignment statements to set metadata spec values in a struct
  * @param {Object[]} fieldNames An object with the following properties:
- * @param {String} fieldNames[].specName The name of the property in the spec
- * @param {String} fieldNames[].shaderName The name of the property in the shader
- * @param {Object} values A source of property values, keyed on fieldNames[].specName
- * @param {String} struct The name of the struct to which values will be assigned
- * @param {String} type The type of the values to be assigned
- * @returns {Array.<{name: String, value}>} Objects containing the property name (in the shader) and a GLSL assignment statement for the property value
+ * @param {string} fieldNames[].specName The name of the property in the spec
+ * @param {string} fieldNames[].shaderName The name of the property in the shader
+ * @param {object} values A source of property values, keyed on fieldNames[].specName
+ * @param {string} struct The name of the struct to which values will be assigned
+ * @param {string} type The type of the values to be assigned
+ * @returns {Array<{name: string, value: any}>} Objects containing the property name (in the shader) and a GLSL assignment statement for the property value
  * @private
  */
 function getStructAssignments(fieldNames, values, struct, type) {
-  return defined(values)
-    ? fieldNames.map(constructAssignment).filter(defined)
-    : [];
-
   function constructAssignment(field) {
     const value = values[field.specName];
     if (defined(value)) {
       return `${struct}.${field.shaderName} = ${type}(${value});`;
     }
   }
+  return defined(values)
+    ? fieldNames.map(constructAssignment).filter(defined)
+    : [];
 }
 
 /**
  * Handle offset/scale transform for a property value
  * This wraps the GLSL value expression with a czm_valueTransform() call
  *
- * @param {Object} options Object with the following properties:
- * @param {String} options.valueExpression The GLSL value expression without the transform
- * @param {String} options.metadataVariable The name of the GLSL variable that will contain the property value
- * @param {String} options.glslType The GLSL type of the variable
+ * @param {object} options Object with the following properties:
+ * @param {string} options.valueExpression The GLSL value expression without the transform
+ * @param {string} options.metadataVariable The name of the GLSL variable that will contain the property value
+ * @param {string} options.glslType The GLSL type of the variable
  * @param {ShaderDestination} options.shaderDestination Which shader(s) use this variable
  * @param {PrimitiveRenderResources} options.renderResources The render resources for this primitive
  * @param {(PropertyAttributeProperty|PropertyTextureProperty)} options.property The property from which the value is derived
- * @returns {String} A wrapped GLSL value expression
+ * @returns {string} A wrapped GLSL value expression
  * @private
  */
 function addValueTransformUniforms(options) {