@cesium/engine 2.1.0 → 2.2.0

package/Source/Scene/Vector3DTilePolylines.js

@@ -87,10 +87,8 @@ function Vector3DTilePolylines(options) {
   this._geometryByteLength = 0;
 
   this._ready = false;
-  this._update = function (polylines, frameState) {};
-  this._readyPromise = initialize(this);
-
-  this._verticesPromise = undefined;
+  this._promise = undefined;
+  this._error = undefined;
 }
 
 Object.defineProperties(Vector3DTilePolylines.prototype, {
@@ -101,6 +99,7 @@ Object.defineProperties(Vector3DTilePolylines.prototype, {
    *
    * @type {number}
    * @readonly
+   * @private
    */
   trianglesLength: {
     get: function () {
@@ -115,6 +114,7 @@ Object.defineProperties(Vector3DTilePolylines.prototype, {
    *
    * @type {number}
    * @readonly
+   * @private
    */
   geometryByteLength: {
     get: function () {
@@ -123,14 +123,15 @@ Object.defineProperties(Vector3DTilePolylines.prototype, {
   },
 
   /**
-   * Gets a promise that resolves when the primitive is ready to render.
+   * Returns true when the primitive is ready to render.
    * @memberof Vector3DTilePolylines.prototype
-   * @type {Promise<void>}
+   * @type {boolean}
    * @readonly
+   * @private
    */
-  readyPromise: {
+  ready: {
     get: function () {
-      return this._readyPromise;
+      return this._ready;
     },
   },
 });
@@ -181,51 +182,55 @@ function createVertexArray(polylines, context) {
     return;
   }
 
-  if (!defined(polylines._verticesPromise)) {
-    let positions = polylines._positions;
-    let widths = polylines._widths;
-    let counts = polylines._counts;
-    let batchIds = polylines._transferrableBatchIds;
+  let positions = polylines._positions;
+  let widths = polylines._widths;
+  let counts = polylines._counts;
+  let batchIds = polylines._transferrableBatchIds;
 
-    let packedBuffer = polylines._packedBuffer;
+  let packedBuffer = polylines._packedBuffer;
 
-    if (!defined(packedBuffer)) {
-      // Copy because they may be the views on the same buffer.
-      positions = polylines._positions = positions.slice();
-      widths = polylines._widths = widths.slice();
-      counts = polylines._counts = counts.slice();
+  if (!defined(packedBuffer)) {
+    // Copy because they may be the views on the same buffer.
+    positions = polylines._positions = positions.slice();
+    widths = polylines._widths = widths.slice();
+    counts = polylines._counts = counts.slice();
 
-      batchIds = polylines._transferrableBatchIds = polylines._batchIds.slice();
+    batchIds = polylines._transferrableBatchIds = polylines._batchIds.slice();
 
-      packedBuffer = polylines._packedBuffer = packBuffer(polylines);
-    }
+    packedBuffer = polylines._packedBuffer = packBuffer(polylines);
+  }
 
-    const transferrableObjects = [
-      positions.buffer,
-      widths.buffer,
-      counts.buffer,
-      batchIds.buffer,
-      packedBuffer.buffer,
-    ];
-    const parameters = {
-      positions: positions.buffer,
-      widths: widths.buffer,
-      counts: counts.buffer,
-      batchIds: batchIds.buffer,
-      packedBuffer: packedBuffer.buffer,
-      keepDecodedPositions: polylines._keepDecodedPositions,
-    };
-
-    const verticesPromise = (polylines._verticesPromise = createVerticesTaskProcessor.scheduleTask(
-      parameters,
-      transferrableObjects
-    ));
-    if (!defined(verticesPromise)) {
-      // Postponed
-      return;
-    }
+  const transferrableObjects = [
+    positions.buffer,
+    widths.buffer,
+    counts.buffer,
+    batchIds.buffer,
+    packedBuffer.buffer,
+  ];
+  const parameters = {
+    positions: positions.buffer,
+    widths: widths.buffer,
+    counts: counts.buffer,
+    batchIds: batchIds.buffer,
+    packedBuffer: packedBuffer.buffer,
+    keepDecodedPositions: polylines._keepDecodedPositions,
+  };
+
+  const verticesPromise = createVerticesTaskProcessor.scheduleTask(
+    parameters,
+    transferrableObjects
+  );
+  if (!defined(verticesPromise)) {
+    // Postponed
+    return;
+  }
+
+  return verticesPromise
+    .then(function (result) {
+      if (polylines.isDestroyed()) {
+        return;
+      }
 
-    return verticesPromise.then(function (result) {
       if (polylines._keepDecodedPositions) {
         polylines._decodedPositions = new Float64Array(result.decodedPositions);
         polylines._decodedPositionOffsets = new Uint32Array(
@@ -245,13 +250,22 @@ function createVertexArray(polylines, context) {
           ? new Uint16Array(result.indices)
           : new Uint32Array(result.indices);
 
+      finishVertexArray(polylines, context);
+
       polylines._ready = true;
+    })
+    .catch((error) => {
+      if (polylines.isDestroyed()) {
+        return;
+      }
+
+      // Throw the error next frame
+      polylines._error = error;
     });
-  }
 }
 
 function finishVertexArray(polylines, context) {
-  if (polylines._ready && !defined(polylines._va)) {
+  if (!defined(polylines._va)) {
     const curPositions = polylines._currentPositions;
     const prevPositions = polylines._previousPositions;
     const nextPositions = polylines._nextPositions;
@@ -603,45 +617,35 @@ Vector3DTilePolylines.prototype.applyStyle = function (style, features) {
   }
 };
 
-function initialize(polylines) {
-  return new Promise(function (resolve, reject) {
-    polylines._update = function (polylines, frameState) {
-      const context = frameState.context;
-      const promise = createVertexArray(polylines, context);
-      createUniformMap(polylines, context);
-      createShaders(polylines, context);
-      createRenderStates(polylines);
-
-      if (polylines._ready) {
-        const passes = frameState.passes;
-        if (passes.render || passes.pick) {
-          queueCommands(polylines, frameState);
-        }
-      }
-
-      if (!defined(promise)) {
-        return;
-      }
-
-      promise
-        .then(function () {
-          finishVertexArray(polylines, context);
-          resolve();
-        })
-        .catch(function (e) {
-          reject(e);
-        });
-    };
-  });
-}
-
 /**
  * Updates the batches and queues the commands for rendering.
  *
  * @param {FrameState} frameState The current frame state.
  */
 Vector3DTilePolylines.prototype.update = function (frameState) {
-  this._update(this, frameState);
+  const context = frameState.context;
+  if (!this._ready) {
+    if (!defined(this._promise)) {
+      this._promise = createVertexArray(this, context);
+    }
+
+    if (defined(this._error)) {
+      const error = this._error;
+      this._error = undefined;
+      throw error;
+    }
+
+    return;
+  }
+
+  createUniformMap(this, context);
+  createShaders(this, context);
+  createRenderStates(this);
+
+  const passes = frameState.passes;
+  if (passes.render || passes.pick) {
+    queueCommands(this, frameState);
+  }
 };
 
 /**

package/Source/Scene/Vector3DTilePrimitive.js

@@ -249,7 +249,6 @@ function createVertexArray(primitive, context) {
   primitive._batchedPositions = undefined;
   primitive._transferrableBatchIds = undefined;
   primitive._vertexBatchIds = undefined;
-  primitive._verticesPromise = undefined;
 }
 
 function createShaders(primitive, context) {

package/Source/Scene/VoxelContent.js

@@ -11,58 +11,20 @@ import MetadataTable from "./MetadataTable.js";
  * @constructor
  *
  * @param {Resource} resource The resource for this voxel content. This is used for fetching external buffers as needed.
- * @param {object} [json] Voxel JSON contents. Mutually exclusive with binary.
- * @param {Uint8Array} [binary] Voxel binary contents. Mutually exclusive with json.
- * @param {MetadataSchema} metadataSchema The metadata schema used by property tables in the voxel content
- *
- * @exception {DeveloperError} One of json and binary must be defined.
  *
  * @private
  * @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
  */
-function VoxelContent(resource, json, binary, metadataSchema) {
+function VoxelContent(resource) {
   //>>includeStart('debug', pragmas.debug);
   Check.typeOf.object("resource", resource);
-  if (defined(json) === defined(binary)) {
-    throw new DeveloperError("One of json and binary must be defined.");
-  }
   //>>includeEnd('debug');
 
   this._resource = resource;
   this._metadataTable = undefined;
-
-  let chunks;
-  if (defined(json)) {
-    chunks = {
-      json: json,
-      binary: undefined,
-    };
-  } else {
-    chunks = parseVoxelChunks(binary);
-  }
-
-  this._readyPromise = initialize(
-    this,
-    chunks.json,
-    chunks.binary,
-    metadataSchema
-  );
 }
 
 Object.defineProperties(VoxelContent.prototype, {
-  /**
-   * A promise that resolves once all buffers are loaded.
-   *
-   * @type {Promise}
-   * @readonly
-   * @private
-   */
-  readyPromise: {
-    get: function () {
-      return this._readyPromise;
-    },
-  },
-
   /**
    * The {@link MetadataTable} storing voxel property values.
    *
@@ -77,38 +39,74 @@ Object.defineProperties(VoxelContent.prototype, {
   },
 });
 
-function initialize(content, json, binary, metadataSchema) {
-  return requestBuffers(content, json, binary).then(function (buffersU8) {
-    const bufferViewsU8 = {};
-    const bufferViewsLength = json.bufferViews.length;
-    for (let i = 0; i < bufferViewsLength; ++i) {
-      const bufferViewJson = json.bufferViews[i];
-      const start = bufferViewJson.byteOffset;
-      const end = start + bufferViewJson.byteLength;
-      const buffer = buffersU8[bufferViewJson.buffer];
-      const bufferView = buffer.subarray(start, end);
-      bufferViewsU8[i] = bufferView;
-    }
+/**
+ * Creates an object representing voxel content for a {@link Cesium3DTilesVoxelProvider}.
+ *
+ * @param {Resource} resource The resource for this voxel content. This is used for fetching external buffers as needed.
+ * @param {object} [json] Voxel JSON contents. Mutually exclusive with binary.
+ * @param {Uint8Array} [binary] Voxel binary contents. Mutually exclusive with json.
+ * @param {MetadataSchema} metadataSchema The metadata schema used by property tables in the voxel content
+ * @returns {Promise<VoxelContent>}
+ *
+ * @exception {DeveloperError} One of json and binary must be defined.
+ */
+VoxelContent.fromJson = async function (
+  resource,
+  json,
+  binary,
+  metadataSchema
+) {
+  //>>includeStart('debug', pragmas.debug);
+  Check.typeOf.object("resource", resource);
+  if (defined(json) === defined(binary)) {
+    throw new DeveloperError("One of json and binary must be defined.");
+  }
+  //>>includeEnd('debug');
+
+  let chunks;
+  if (defined(json)) {
+    chunks = {
+      json: json,
+      binary: undefined,
+    };
+  } else {
+    chunks = parseVoxelChunks(binary);
+  }
+
+  const buffersU8 = await requestBuffers(resource, chunks.json, chunks.binary);
+  const bufferViewsU8 = {};
+  const bufferViewsLength = chunks.json.bufferViews.length;
+  for (let i = 0; i < bufferViewsLength; ++i) {
+    const bufferViewJson = chunks.json.bufferViews[i];
+    const start = bufferViewJson.byteOffset;
+    const end = start + bufferViewJson.byteLength;
+    const buffer = buffersU8[bufferViewJson.buffer];
+    const bufferView = buffer.subarray(start, end);
+    bufferViewsU8[i] = bufferView;
+  }
+
+  const propertyTableIndex = chunks.json.voxelTable;
+  const propertyTableJson = chunks.json.propertyTables[propertyTableIndex];
 
-    const propertyTableIndex = json.voxelTable;
-    const propertyTableJson = json.propertyTables[propertyTableIndex];
-    content._metadataTable = new MetadataTable({
-      count: propertyTableJson.count,
-      properties: propertyTableJson.properties,
-      class: metadataSchema.classes[propertyTableJson.class],
-      bufferViews: bufferViewsU8,
-    });
-    return content;
+  const content = new VoxelContent(resource);
+
+  content._metadataTable = new MetadataTable({
+    count: propertyTableJson.count,
+    properties: propertyTableJson.properties,
+    class: metadataSchema.classes[propertyTableJson.class],
+    bufferViews: bufferViewsU8,
   });
-}
 
-function requestBuffers(content, json, binary) {
+  return content;
+};
+
+function requestBuffers(resource, json, binary) {
   const buffersLength = json.buffers.length;
   const bufferPromises = new Array(buffersLength);
   for (let i = 0; i < buffersLength; i++) {
     const buffer = json.buffers[i];
     if (defined(buffer.uri)) {
-      const baseResource = content._resource;
+      const baseResource = resource;
       const bufferResource = baseResource.getDerivedResource({
         url: buffer.uri,
       });

package/Source/Scene/VoxelPrimitive.js

@@ -8,8 +8,8 @@ import clone from "../Core/clone.js";
 import Color from "../Core/Color.js";
 import defaultValue from "../Core/defaultValue.js";
 import defined from "../Core/defined.js";
+import deprecationWarning from "../Core/deprecationWarning.js";
 import destroyObject from "../Core/destroyObject.js";
-import DeveloperError from "../Core/DeveloperError.js";
 import Event from "../Core/Event.js";
 import JulianDate from "../Core/JulianDate.js";
 import Matrix3 from "../Core/Matrix3.js";
@@ -426,7 +426,7 @@ function VoxelPrimitive(options) {
   this._readyPromise = initialize(this, provider);
 }
 
-function initialize(primitive, provider) {
+async function initialize(primitive, provider) {
   const promise = new Promise(function (resolve) {
     primitive._completeLoad = function (primitive, frameState) {
       // Set the primitive as ready after the first frame render since the user might set up events subscribed to
@@ -439,9 +439,35 @@ function initialize(primitive, provider) {
     };
   });
 
-  return provider.readyPromise.then(function () {
-    return promise;
-  });
+  // This is here for backwards compatibility. It can be removed when readyPromise is removed.
+  if (defined(provider._readyPromise) && !provider._ready) {
+    await provider._readyPromise;
+  }
+
+  // Set the bounds
+  const {
+    shape: shapeType,
+    minBounds = VoxelShapeType.getMinBounds(shapeType),
+    maxBounds = VoxelShapeType.getMaxBounds(shapeType),
+  } = provider;
+
+  primitive.minBounds = minBounds;
+  primitive.maxBounds = maxBounds;
+  primitive.minClippingBounds = VoxelShapeType.getMinBounds(shapeType);
+  primitive.maxClippingBounds = VoxelShapeType.getMaxBounds(shapeType);
+
+  checkTransformAndBounds(primitive, provider);
+
+  // Create the shape object, and update it so it is valid for VoxelTraversal
+  const ShapeConstructor = VoxelShapeType.getShapeConstructor(shapeType);
+  primitive._shape = new ShapeConstructor();
+  primitive._shapeVisible = updateShapeAndTransforms(
+    primitive,
+    primitive._shape,
+    provider
+  );
+
+  return promise;
 }
 
 Object.defineProperties(VoxelPrimitive.prototype, {
@@ -464,9 +490,14 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * @memberof VoxelPrimitive.prototype
    * @type {Promise<VoxelPrimitive>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: function () {
+      deprecationWarning(
+        "VoxelPrimitive.readyPromise",
+        "VoxelPrimitive.readyPromise was deprecated in CesiumJS 1.104. It will be removed in 1.107. Wait for VoxelPrimitive.ready to return true instead."
+      );
       return this._readyPromise;
     },
   },
@@ -490,19 +521,9 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * @memberof VoxelPrimitive.prototype
    * @type {BoundingSphere}
    * @readonly
-   *
-   * @exception {DeveloperError} If the primitive is not ready.
    */
   boundingSphere: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "boundingSphere must not be called before the primitive is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
       return this._shape.boundingSphere;
     },
   },
@@ -513,20 +534,10 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * @memberof VoxelPrimitive.prototype
    * @type {OrientedBoundingBox}
    * @readonly
-   *
-   * @exception {DeveloperError} If the primitive is not ready.
    */
   orientedBoundingBox: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "orientedBoundingBox must not be called before the primitive is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
-      return this._shape.orientedBoundingBox;
+      return this.shape.orientedBoundingBox;
     },
   },
 
@@ -556,19 +567,9 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * @memberof VoxelPrimitive.prototype
    * @type {VoxelShapeType}
    * @readonly
-   *
-   * @exception {DeveloperError} If the primitive is not ready.
    */
   shape: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "shape must not be called before the primitive is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
       return this._provider.shape;
     },
   },
@@ -579,19 +580,9 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * @memberof VoxelPrimitive.prototype
    * @type {Cartesian3}
    * @readonly
-   *
-   * @exception {DeveloperError} If the primitive is not ready.
    */
   dimensions: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "dimensions must not be called before the primitive is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
       return this._provider.dimensions;
     },
   },
@@ -602,19 +593,9 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * @memberof VoxelPrimitive.prototype
    * @type {number[][]}
    * @readonly
-   *
-   * @exception {DeveloperError} If the primitive is not ready.
    */
   minimumValues: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "minimumValues must not be called before the primitive is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
       return this._provider.minimumValues;
     },
   },
@@ -625,19 +606,9 @@ Object.defineProperties(VoxelPrimitive.prototype, {
    * @memberof VoxelPrimitive.prototype
    * @type {number[][]}
    * @readonly
-   *
-   * @exception {DeveloperError} If the primitive is not ready.
    */
   maximumValues: {
     get: function () {
-      //>>includeStart('debug', pragmas.debug);
-      if (!this._ready) {
-        throw new DeveloperError(
-          "maximumValues must not be called before the primitive is ready."
-        );
-      }
-      //>>includeEnd('debug');
-
       return this._provider.maximumValues;
     },
   },
@@ -1018,7 +989,8 @@ VoxelPrimitive.prototype.update = function (frameState) {
   this._customShader.update(frameState);
 
   // Exit early if it's not ready yet.
-  if (!this._ready && !provider.ready) {
+  // This is here for backward compatibility. It can be removed when readyPromise is removed.
+  if ((defined(provider._ready) && !provider._ready) || !defined(this._shape)) {
     return;
   }
 
@@ -1188,29 +1160,6 @@ function initFromProvider(primitive, provider, context) {
   primitive._pickId = context.createPickId({ primitive });
   uniforms.pickColor = Color.clone(primitive._pickId.color, uniforms.pickColor);
 
-  // Set the bounds
-  const {
-    shape: shapeType,
-    minBounds = VoxelShapeType.getMinBounds(shapeType),
-    maxBounds = VoxelShapeType.getMaxBounds(shapeType),
-  } = provider;
-
-  primitive.minBounds = minBounds;
-  primitive.maxBounds = maxBounds;
-  primitive.minClippingBounds = VoxelShapeType.getMinBounds(shapeType);
-  primitive.maxClippingBounds = VoxelShapeType.getMaxBounds(shapeType);
-
-  checkTransformAndBounds(primitive, provider);
-
-  // Create the shape object, and update it so it is valid for VoxelTraversal
-  const ShapeConstructor = VoxelShapeType.getShapeConstructor(shapeType);
-  primitive._shape = new ShapeConstructor();
-  primitive._shapeVisible = updateShapeAndTransforms(
-    primitive,
-    primitive._shape,
-    provider
-  );
-
   const { shaderDefines, shaderUniforms: shapeUniforms } = primitive._shape;
   primitive._shapeDefinesOld = clone(shaderDefines, true);
 
@@ -1896,7 +1845,6 @@ VoxelPrimitive.DefaultCustomShader = new CustomShader({
 
 function DefaultVoxelProvider() {
   this.ready = true;
-  this.readyPromise = Promise.resolve(this);
   this.shape = VoxelShapeType.BOX;
   this.dimensions = new Cartesian3(1, 1, 1);
   this.names = ["data"];

package/Source/Scene/VoxelProvider.js

@@ -24,6 +24,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * @memberof VoxelProvider.prototype
    * @type {boolean}
    * @readonly
+   * @deprecated
    */
   ready: {
     get: DeveloperError.throwInstantiationError,
@@ -35,6 +36,7 @@ Object.defineProperties(VoxelProvider.prototype, {
    * @memberof VoxelProvider.prototype
    * @type {Promise<VoxelProvider>}
    * @readonly
+   * @deprecated
    */
   readyPromise: {
     get: DeveloperError.throwInstantiationError,
@@ -247,8 +249,6 @@ Object.defineProperties(VoxelProvider.prototype, {
  * @param {number} [options.tileZ=0] The tile's Z coordinate.
  * @privateparam {number} [options.keyframe=0] The requested keyframe.
  * @returns {Promise<Array[]>|undefined} A promise to an array of typed arrays containing the requested voxel data or undefined if there was a problem loading the data.
- *
- * @exception {DeveloperError} The provider must be ready.
  */
 VoxelProvider.prototype.requestData = DeveloperError.throwInstantiationError;