@cesium/engine 22.3.0 → 23.0.0

package/Source/Scene/GltfDracoLoader.js

@@ -13,62 +13,56 @@ import VertexAttributeSemantic from "./VertexAttributeSemantic.js";
  * Implements the {@link ResourceLoader} interface.
  * </p>
  *
- * @alias GltfDracoLoader
- * @constructor
- * @augments ResourceLoader
- *
- * @param {object} options Object with the following properties:
- * @param {ResourceCache} options.resourceCache The {@link ResourceCache} (to avoid circular dependencies).
- * @param {object} options.gltf The glTF JSON.
- * @param {object} options.primitive The primitive containing the Draco extension.
- * @param {object} options.draco The Draco extension object.
- * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
- * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to.
- * @param {string} [options.cacheKey] The cache key of the resource.
- *
  * @private
  */
-function GltfDracoLoader(options) {
-  options = options ?? Frozen.EMPTY_OBJECT;
-  const resourceCache = options.resourceCache;
-  const gltf = options.gltf;
-  const primitive = options.primitive;
-  const draco = options.draco;
-  const gltfResource = options.gltfResource;
-  const baseResource = options.baseResource;
-  const cacheKey = options.cacheKey;
-
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.func("options.resourceCache", resourceCache);
-  Check.typeOf.object("options.gltf", gltf);
-  Check.typeOf.object("options.primitive", primitive);
-  Check.typeOf.object("options.draco", draco);
-  Check.typeOf.object("options.gltfResource", gltfResource);
-  Check.typeOf.object("options.baseResource", baseResource);
-  //>>includeEnd('debug');
-
-  this._resourceCache = resourceCache;
-  this._gltfResource = gltfResource;
-  this._baseResource = baseResource;
-  this._gltf = gltf;
-  this._primitive = primitive;
-  this._draco = draco;
-  this._cacheKey = cacheKey;
-  this._bufferViewLoader = undefined;
-  this._bufferViewTypedArray = undefined;
-  this._decodePromise = undefined;
-  this._decodedData = undefined;
-  this._state = ResourceLoaderState.UNLOADED;
-  this._promise = undefined;
-  this._dracoError = undefined;
-}
-
-if (defined(Object.create)) {
-  GltfDracoLoader.prototype = Object.create(ResourceLoader.prototype);
-  GltfDracoLoader.prototype.constructor = GltfDracoLoader;
-}
+class GltfDracoLoader extends ResourceLoader {
+  /**
+   * @param {object} options Object with the following properties:
+   * @param {ResourceCache} options.resourceCache The {@link ResourceCache} (to avoid circular dependencies).
+   * @param {object} options.gltf The glTF JSON.
+   * @param {object} options.primitive The primitive containing the Draco extension.
+   * @param {object} options.draco The Draco extension object.
+   * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
+   * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to.
+   * @param {string} [options.cacheKey] The cache key of the resource.
+   */
+  constructor(options) {
+    super();
+
+    options = options ?? Frozen.EMPTY_OBJECT;
+    const resourceCache = options.resourceCache;
+    const gltf = options.gltf;
+    const primitive = options.primitive;
+    const draco = options.draco;
+    const gltfResource = options.gltfResource;
+    const baseResource = options.baseResource;
+    const cacheKey = options.cacheKey;
+
+    //>>includeStart('debug', pragmas.debug);
+    Check.typeOf.func("options.resourceCache", resourceCache);
+    Check.typeOf.object("options.gltf", gltf);
+    Check.typeOf.object("options.primitive", primitive);
+    Check.typeOf.object("options.draco", draco);
+    Check.typeOf.object("options.gltfResource", gltfResource);
+    Check.typeOf.object("options.baseResource", baseResource);
+    //>>includeEnd('debug');
+
+    this._resourceCache = resourceCache;
+    this._gltfResource = gltfResource;
+    this._baseResource = baseResource;
+    this._gltf = gltf;
+    this._primitive = primitive;
+    this._draco = draco;
+    this._cacheKey = cacheKey;
+    this._bufferViewLoader = undefined;
+    this._bufferViewTypedArray = undefined;
+    this._decodePromise = undefined;
+    this._decodedData = undefined;
+    this._state = ResourceLoaderState.UNLOADED;
+    this._promise = undefined;
+    this._dracoError = undefined;
+  }
 
-Object.defineProperties(GltfDracoLoader.prototype, {
   /**
    * The cache key of the resource.
    *
@@ -78,11 +72,10 @@ Object.defineProperties(GltfDracoLoader.prototype, {
    * @readonly
    * @private
    */
-  cacheKey: {
-    get: function () {
-      return this._cacheKey;
-    },
-  },
+  get cacheKey() {
+    return this._cacheKey;
+  }
+
   /**
    * The decoded data.
    *
@@ -92,12 +85,122 @@ Object.defineProperties(GltfDracoLoader.prototype, {
    * @readonly
    * @private
    */
-  decodedData: {
-    get: function () {
-      return this._decodedData;
-    },
-  },
-});
+  get decodedData() {
+    return this._decodedData;
+  }
+
+  /**
+   * Loads the resource.
+   * @returns {Promise<GltfDracoLoader>} A promise which resolves to the loader when the resource loading is completed.
+   * @private
+   */
+  async load() {
+    if (defined(this._promise)) {
+      return this._promise;
+    }
+
+    this._state = ResourceLoaderState.LOADING;
+    this._promise = loadResources(this);
+    return this._promise;
+  }
+
+  /**
+   * Processes the resource until it becomes ready.
+   *
+   * @param {FrameState} frameState The frame state.
+   * @private
+   */
+  process(frameState) {
+    //>>includeStart('debug', pragmas.debug);
+    Check.typeOf.object("frameState", frameState);
+    //>>includeEnd('debug');
+
+    if (this._state === ResourceLoaderState.READY) {
+      return true;
+    }
+
+    if (this._state !== ResourceLoaderState.PROCESSING) {
+      return false;
+    }
+
+    if (defined(this._dracoError)) {
+      handleError(this, this._dracoError);
+    }
+
+    if (!defined(this._bufferViewTypedArray)) {
+      // Not ready to decode the Draco buffer
+      return false;
+    }
+
+    if (defined(this._decodePromise)) {
+      // Currently decoding
+      return false;
+    }
+
+    const draco = this._draco;
+    const primitive = this._primitive;
+    const gltf = this._gltf;
+    const bufferViews = gltf.bufferViews;
+    const bufferViewId = draco.bufferView;
+    const bufferView = bufferViews[bufferViewId];
+    const compressedAttributes = draco.attributes;
+
+    // Skip de-quantization transform if present for floating point attributes.
+    // They will stay quantized in memory and be dequantized in the shader.
+    const attributesToSkipTransform = [];
+
+    for (const attribute in primitive.attributes) {
+      if (primitive.attributes.hasOwnProperty(attribute)) {
+        const dracoAttributeType = getDracoAttributeType(attribute);
+        if (defined(dracoAttributeType)) {
+          const accessor = gltf.accessors[primitive.attributes[attribute]];
+          if (accessor.componentType === ComponentDatatype.FLOAT) {
+            if (!attributesToSkipTransform.includes(dracoAttributeType)) {
+              attributesToSkipTransform.push(dracoAttributeType);
+            }
+          }
+        }
+      }
+    }
+
+    const decodeOptions = {
+      // Need to make a copy of the typed array otherwise the underlying
+      // ArrayBuffer may be accessed on both the worker and the main thread. This
+      // leads to errors such as "ArrayBuffer at index 0 is already detached".
+      // PERFORMANCE_IDEA: Look into SharedArrayBuffer to get around this.
+      array: new Uint8Array(this._bufferViewTypedArray),
+      bufferView: bufferView,
+      compressedAttributes: compressedAttributes,
+      dequantizeInShader: true,
+      attributesToSkipTransform: attributesToSkipTransform,
+    };
+
+    const decodePromise = DracoLoader.decodeBufferView(decodeOptions);
+
+    if (!defined(decodePromise)) {
+      // Cannot schedule task this frame
+      return false;
+    }
+
+    this._decodePromise = processDecode(this, decodePromise);
+  }
+
+  /**
+   * Unloads the resource.
+   * @private
+   */
+  unload() {
+    if (defined(this._bufferViewLoader)) {
+      this._resourceCache.unload(this._bufferViewLoader);
+    }
+
+    this._bufferViewLoader = undefined;
+    this._bufferViewTypedArray = undefined;
+    this._decodedData = undefined;
+    this._gltf = undefined;
+    this._primitive = undefined;
+  }
+}
 
 async function loadResources(loader) {
   const resourceCache = loader._resourceCache;
@@ -127,21 +230,6 @@ async function loadResources(loader) {
   }
 }
 
-/**
- * Loads the resource.
- * @returns {Promise<GltfDracoLoader>} A promise which resolves to the loader when the resource loading is completed.
- * @private
- */
-GltfDracoLoader.prototype.load = async function () {
-  if (defined(this._promise)) {
-    return this._promise;
-  }
-
-  this._state = ResourceLoaderState.LOADING;
-  this._promise = loadResources(this);
-  return this._promise;
-};
-
 function handleError(dracoLoader, error) {
   dracoLoader.unload();
   dracoLoader._state = ResourceLoaderState.FAILED;
@@ -193,101 +281,4 @@ function getDracoAttributeType(attribute) {
   return undefined;
 }
 
-/**
- * Processes the resource until it becomes ready.
- *
- * @param {FrameState} frameState The frame state.
- * @private
- */
-GltfDracoLoader.prototype.process = function (frameState) {
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.object("frameState", frameState);
-  //>>includeEnd('debug');
-
-  if (this._state === ResourceLoaderState.READY) {
-    return true;
-  }
-
-  if (this._state !== ResourceLoaderState.PROCESSING) {
-    return false;
-  }
-
-  if (defined(this._dracoError)) {
-    handleError(this, this._dracoError);
-  }
-
-  if (!defined(this._bufferViewTypedArray)) {
-    // Not ready to decode the Draco buffer
-    return false;
-  }
-
-  if (defined(this._decodePromise)) {
-    // Currently decoding
-    return false;
-  }
-
-  const draco = this._draco;
-  const primitive = this._primitive;
-  const gltf = this._gltf;
-  const bufferViews = gltf.bufferViews;
-  const bufferViewId = draco.bufferView;
-  const bufferView = bufferViews[bufferViewId];
-  const compressedAttributes = draco.attributes;
-
-  // Skip de-quantization transform if present for floating point attributes.
-  // They will stay quantized in memory and be dequantized in the shader.
-  const attributesToSkipTransform = [];
-
-  for (const attribute in primitive.attributes) {
-    if (primitive.attributes.hasOwnProperty(attribute)) {
-      const dracoAttributeType = getDracoAttributeType(attribute);
-      if (defined(dracoAttributeType)) {
-        const accessor = gltf.accessors[primitive.attributes[attribute]];
-        if (accessor.componentType === ComponentDatatype.FLOAT) {
-          if (!attributesToSkipTransform.includes(dracoAttributeType)) {
-            attributesToSkipTransform.push(dracoAttributeType);
-          }
-        }
-      }
-    }
-  }
-
-  const decodeOptions = {
-    // Need to make a copy of the typed array otherwise the underlying
-    // ArrayBuffer may be accessed on both the worker and the main thread. This
-    // leads to errors such as "ArrayBuffer at index 0 is already detached".
-    // PERFORMANCE_IDEA: Look into SharedArrayBuffer to get around this.
-    array: new Uint8Array(this._bufferViewTypedArray),
-    bufferView: bufferView,
-    compressedAttributes: compressedAttributes,
-    dequantizeInShader: true,
-    attributesToSkipTransform: attributesToSkipTransform,
-  };
-
-  const decodePromise = DracoLoader.decodeBufferView(decodeOptions);
-
-  if (!defined(decodePromise)) {
-    // Cannot schedule task this frame
-    return false;
-  }
-
-  this._decodePromise = processDecode(this, decodePromise);
-};
-
-/**
- * Unloads the resource.
- * @private
- */
-GltfDracoLoader.prototype.unload = function () {
-  if (defined(this._bufferViewLoader)) {
-    this._resourceCache.unload(this._bufferViewLoader);
-  }
-
-  this._bufferViewLoader = undefined;
-  this._bufferViewTypedArray = undefined;
-  this._decodedData = undefined;
-  this._gltf = undefined;
-  this._primitive = undefined;
-};
-
 export default GltfDracoLoader;

package/Source/Scene/GltfImageLoader.js

@@ -13,61 +13,55 @@ import ResourceLoaderState from "./ResourceLoaderState.js";
  * Implements the {@link ResourceLoader} interface.
  * </p>
  *
- * @alias GltfImageLoader
- * @constructor
- * @augments ResourceLoader
- *
- * @param {object} options Object with the following properties:
- * @param {ResourceCache} options.resourceCache The {@link ResourceCache} (to avoid circular dependencies).
- * @param {object} options.gltf The glTF JSON.
- * @param {number} options.imageId The image ID.
- * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
- * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to.
- * @param {string} [options.cacheKey] The cache key of the resource.
- *
  * @private
  */
-function GltfImageLoader(options) {
-  options = options ?? Frozen.EMPTY_OBJECT;
-  const resourceCache = options.resourceCache;
-  const gltf = options.gltf;
-  const imageId = options.imageId;
-  const gltfResource = options.gltfResource;
-  const baseResource = options.baseResource;
-  const cacheKey = options.cacheKey;
-
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.func("options.resourceCache", resourceCache);
-  Check.typeOf.object("options.gltf", gltf);
-  Check.typeOf.number("options.imageId", imageId);
-  Check.typeOf.object("options.gltfResource", gltfResource);
-  Check.typeOf.object("options.baseResource", baseResource);
-  //>>includeEnd('debug');
-
-  const image = gltf.images[imageId];
-  const bufferViewId = image.bufferView;
-  const uri = image.uri;
-
-  this._resourceCache = resourceCache;
-  this._gltfResource = gltfResource;
-  this._baseResource = baseResource;
-  this._gltf = gltf;
-  this._bufferViewId = bufferViewId;
-  this._uri = uri;
-  this._cacheKey = cacheKey;
-  this._bufferViewLoader = undefined;
-  this._image = undefined;
-  this._mipLevels = undefined;
-  this._state = ResourceLoaderState.UNLOADED;
-  this._promise = undefined;
-}
-
-if (defined(Object.create)) {
-  GltfImageLoader.prototype = Object.create(ResourceLoader.prototype);
-  GltfImageLoader.prototype.constructor = GltfImageLoader;
-}
+class GltfImageLoader extends ResourceLoader {
+  /**
+   * @param {object} options Object with the following properties:
+   * @param {ResourceCache} options.resourceCache The {@link ResourceCache} (to avoid circular dependencies).
+   * @param {object} options.gltf The glTF JSON.
+   * @param {number} options.imageId The image ID.
+   * @param {Resource} options.gltfResource The {@link Resource} containing the glTF.
+   * @param {Resource} options.baseResource The {@link Resource} that paths in the glTF JSON are relative to.
+   * @param {string} [options.cacheKey] The cache key of the resource.
+   */
+  constructor(options) {
+    super();
+
+    options = options ?? Frozen.EMPTY_OBJECT;
+    const resourceCache = options.resourceCache;
+    const gltf = options.gltf;
+    const imageId = options.imageId;
+    const gltfResource = options.gltfResource;
+    const baseResource = options.baseResource;
+    const cacheKey = options.cacheKey;
+
+    //>>includeStart('debug', pragmas.debug);
+    Check.typeOf.func("options.resourceCache", resourceCache);
+    Check.typeOf.object("options.gltf", gltf);
+    Check.typeOf.number("options.imageId", imageId);
+    Check.typeOf.object("options.gltfResource", gltfResource);
+    Check.typeOf.object("options.baseResource", baseResource);
+    //>>includeEnd('debug');
+
+    const image = gltf.images[imageId];
+    const bufferViewId = image.bufferView;
+    const uri = image.uri;
+
+    this._resourceCache = resourceCache;
+    this._gltfResource = gltfResource;
+    this._baseResource = baseResource;
+    this._gltf = gltf;
+    this._bufferViewId = bufferViewId;
+    this._uri = uri;
+    this._cacheKey = cacheKey;
+    this._bufferViewLoader = undefined;
+    this._image = undefined;
+    this._mipLevels = undefined;
+    this._state = ResourceLoaderState.UNLOADED;
+    this._promise = undefined;
+  }
 
-Object.defineProperties(GltfImageLoader.prototype, {
   /**
    * The cache key of the resource.
    *
@@ -77,11 +71,10 @@ Object.defineProperties(GltfImageLoader.prototype, {
    * @readonly
    * @private
    */
-  cacheKey: {
-    get: function () {
-      return this._cacheKey;
-    },
-  },
+  get cacheKey() {
+    return this._cacheKey;
+  }
+
   /**
    * The image.
    *
@@ -91,11 +84,10 @@ Object.defineProperties(GltfImageLoader.prototype, {
    * @readonly
    * @private
    */
-  image: {
-    get: function () {
-      return this._image;
-    },
-  },
+  get image() {
+    return this._image;
+  }
+
   /**
    * The mip levels. Only defined for KTX2 files containing mip levels.
    *
@@ -105,31 +97,48 @@ Object.defineProperties(GltfImageLoader.prototype, {
    * @readonly
    * @private
    */
-  mipLevels: {
-    get: function () {
-      return this._mipLevels;
-    },
-  },
-});
-
-/**
- * Loads the resource.
- * @returns {Promise<GltfImageLoader>} A promise which resolves to the loader when the resource loading is completed.
- * @private
- */
-GltfImageLoader.prototype.load = function () {
-  if (defined(this._promise)) {
-    return this._promise;
+  get mipLevels() {
+    return this._mipLevels;
   }
 
-  if (defined(this._bufferViewId)) {
-    this._promise = loadFromBufferView(this);
+  /**
+   * Loads the resource.
+   * @returns {Promise<GltfImageLoader>} A promise which resolves to the loader when the resource loading is completed.
+   * @private
+   */
+  load() {
+    if (defined(this._promise)) {
+      return this._promise;
+    }
+
+    if (defined(this._bufferViewId)) {
+      this._promise = loadFromBufferView(this);
+      return this._promise;
+    }
+
+    this._promise = loadFromUri(this);
     return this._promise;
   }
 
-  this._promise = loadFromUri(this);
-  return this._promise;
-};
+  /**
+   * Unloads the resource.
+   * @private
+   */
+  unload() {
+    if (
+      defined(this._bufferViewLoader) &&
+      !this._bufferViewLoader.isDestroyed()
+    ) {
+      this._resourceCache.unload(this._bufferViewLoader);
+    }
+
+    this._bufferViewLoader = undefined;
+    this._uri = undefined; // Free in case the uri is a data uri
+    this._image = undefined;
+    this._mipLevels = undefined;
+    this._gltf = undefined;
+  }
+}
 
 function getImageAndMipLevels(image) {
   // Images transcoded from KTX2 can contain multiple mip levels:
@@ -295,25 +304,6 @@ function loadImageFromUri(resource) {
   });
 }
 
-/**
- * Unloads the resource.
- * @private
- */
-GltfImageLoader.prototype.unload = function () {
-  if (
-    defined(this._bufferViewLoader) &&
-    !this._bufferViewLoader.isDestroyed()
-  ) {
-    this._resourceCache.unload(this._bufferViewLoader);
-  }
-
-  this._bufferViewLoader = undefined;
-  this._uri = undefined; // Free in case the uri is a data uri
-  this._image = undefined;
-  this._mipLevels = undefined;
-  this._gltf = undefined;
-};
-
 // Exposed for testing
 GltfImageLoader._loadImageFromTypedArray = loadImageFromTypedArray;