@cesium/engine 22.3.0 → 23.0.0

package/Source/Scene/ResourceLoader.js

@@ -10,16 +10,10 @@ import RuntimeError from "../Core/RuntimeError.js";
  * This type describes an interface and is not intended to be instantiated directly.
  * </p>
  *
- * @alias ResourceLoader
- * @constructor
- *
  * @see ResourceCache
- *
  * @private
  */
-function ResourceLoader() {}
-
-Object.defineProperties(ResourceLoader.prototype, {
+class ResourceLoader {
   /**
    * The cache key of the resource.
    *
@@ -29,99 +23,97 @@ Object.defineProperties(ResourceLoader.prototype, {
    * @readonly
    * @private
    */
-  cacheKey: {
-    // eslint-disable-next-line getter-return
-    get: function () {
-      DeveloperError.throwInstantiationError();
-    },
-  },
-});
+  // eslint-disable-next-line getter-return
+  get cacheKey() {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Loads the resource.
- * @returns {Promise<ResourceLoader>} A promise which resolves to the loader when the resource loading is completed.
- * @private
- */
-ResourceLoader.prototype.load = function () {
-  DeveloperError.throwInstantiationError();
-};
+  /**
+   * Loads the resource.
+   * @returns {Promise<ResourceLoader>} A promise which resolves to the loader when the resource loading is completed.
+   * @private
+   */
+  load() {
+    DeveloperError.throwInstantiationError();
+  }
 
-/**
- * Unloads the resource.
- * @private
- */
-ResourceLoader.prototype.unload = function () {};
+  /**
+   * Unloads the resource.
+   * @private
+   */
+  unload() {}
 
-/**
- * Processes the resource until it becomes ready.
- *
- * @param {FrameState} frameState The frame state.
- * @returns {boolean} true once all resourced are ready.
- * @private
- */
-ResourceLoader.prototype.process = function (frameState) {
-  return false;
-};
+  /**
+   * Processes the resource until it becomes ready.
+   *
+   * @param {FrameState} frameState The frame state.
+   * @returns {boolean} true once all resourced are ready.
+   * @private
+   */
+  process(frameState) {
+    return false;
+  }
 
-/**
- * Constructs a {@link RuntimeError} from an errorMessage and an error.
- *
- * @param {string} errorMessage The error message.
- * @param {Error} [error] The error.
- *
- * @returns {RuntimeError} The runtime error.
- * @private
- */
-ResourceLoader.prototype.getError = function (errorMessage, error) {
-  //>>includeStart('debug', pragmas.debug);
-  Check.typeOf.string("errorMessage", errorMessage);
-  //>>includeEnd('debug');
+  /**
+   * Constructs a {@link RuntimeError} from an errorMessage and an error.
+   *
+   * @param {string} errorMessage The error message.
+   * @param {Error} [error] The error.
+   *
+   * @returns {RuntimeError} The runtime error.
+   * @private
+   */
+  getError(errorMessage, error) {
+    //>>includeStart('debug', pragmas.debug);
+    Check.typeOf.string("errorMessage", errorMessage);
+    //>>includeEnd('debug');
 
-  if (defined(error) && defined(error.message)) {
-    errorMessage += `\n${error.message}`;
-  }
+    if (defined(error) && defined(error.message)) {
+      errorMessage += `\n${error.message}`;
+    }
 
-  const runtimeError = new RuntimeError(errorMessage);
-  if (defined(error)) {
-    runtimeError.stack = `Original stack:\n${error.stack}\nHandler stack:\n${runtimeError.stack}`;
-  }
+    const runtimeError = new RuntimeError(errorMessage);
+    if (defined(error)) {
+      runtimeError.stack = `Original stack:\n${error.stack}\nHandler stack:\n${runtimeError.stack}`;
+    }
 
-  return runtimeError;
-};
+    return runtimeError;
+  }
 
-/**
- * Returns true if this object was destroyed; otherwise, false.
- * <br /><br />
- * 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} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
- *
- * @see ResourceLoader#destroy
- * @private
- */
-ResourceLoader.prototype.isDestroyed = function () {
-  return false;
-};
+  /**
+   * Returns true if this object was destroyed; otherwise, false.
+   * <br /><br />
+   * 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} <code>true</code> if this object was destroyed; otherwise, <code>false</code>.
+   *
+   * @see ResourceLoader#destroy
+   * @private
+   */
+  isDestroyed() {
+    return false;
+  }
 
-/**
- * Destroys the loaded resource.
- * <br /><br />
- * Once an object is destroyed, it should not be used; calling any function other than
- * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.  Therefore,
- * assign the return value (<code>undefined</code>) to the object as done in the example.
- *
- * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
- *
- * @example
- * resourceLoader = resourceLoader && resourceLoader.destroy();
- *
- * @see ResourceLoader#isDestroyed
- * @private
- */
-ResourceLoader.prototype.destroy = function () {
-  this.unload();
-  return destroyObject(this);
-};
+  /**
+   * Destroys the loaded resource.
+   * <br /><br />
+   * Once an object is destroyed, it should not be used; calling any function other than
+   * <code>isDestroyed</code> will result in a {@link DeveloperError} exception.  Therefore,
+   * assign the return value (<code>undefined</code>) to the object as done in the example.
+   *
+   * @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
+   *
+   * @example
+   * resourceLoader = resourceLoader && resourceLoader.destroy();
+   *
+   * @see ResourceLoader#isDestroyed
+   * @private
+   */
+  destroy() {
+    this.unload();
+    return destroyObject(this);
+  }
+}
 
 export default ResourceLoader;

package/Source/Scene/Scene.js

@@ -3022,6 +3022,18 @@ function renderEnvironment(scene, passState) {
   if (environmentState.isMoonVisible) {
     environmentState.moonCommand.execute(context, passState);
   }
+
+  // execute panorama commands, drop removed primitives
+  const panoramaCommandList = scene.frameState.panoramaCommandList;
+  for (let i = panoramaCommandList.length - 1; i >= 0; i--) {
+    const panoramaCommand = panoramaCommandList[i];
+    if (defined(panoramaCommand.shaderProgram)) {
+      executeCommand(panoramaCommandList[i], scene, passState);
+    } else {
+      //primitive was removed
+      panoramaCommandList.splice(i, 1);
+    }
+  }
 }
 
 /**

package/Source/Scene/SkyBox.js

@@ -1,25 +1,7 @@
 import buildModuleUrl from "../Core/buildModuleUrl.js";
-import BoxGeometry from "../Core/BoxGeometry.js";
-import Cartesian3 from "../Core/Cartesian3.js";
-import Check from "../Core/Check.js";
-import defined from "../Core/defined.js";
-import destroyObject from "../Core/destroyObject.js";
-import DeveloperError from "../Core/DeveloperError.js";
-import GeometryPipeline from "../Core/GeometryPipeline.js";
-import Matrix4 from "../Core/Matrix4.js";
-import VertexFormat from "../Core/VertexFormat.js";
-import BufferUsage from "../Renderer/BufferUsage.js";
-import CubeMap from "../Renderer/CubeMap.js";
-import DrawCommand from "../Renderer/DrawCommand.js";
-import loadCubeMap from "../Renderer/loadCubeMap.js";
-import RenderState from "../Renderer/RenderState.js";
-import ShaderProgram from "../Renderer/ShaderProgram.js";
-import ShaderSource from "../Renderer/ShaderSource.js";
-import VertexArray from "../Renderer/VertexArray.js";
-import SkyBoxFS from "../Shaders/SkyBoxFS.js";
-import SkyBoxVS from "../Shaders/SkyBoxVS.js";
-import BlendingState from "./BlendingState.js";
+import CubeMapPanorama from "./CubeMapPanorama.js";
 import SceneMode from "./SceneMode.js";
+import destroyObject from "../Core/destroyObject.js";
 
 /**
  * A sky box around the scene to draw stars.  The sky box is defined using the True Equator Mean Equinox (TEME) axes.
@@ -52,17 +34,7 @@ import SceneMode from "./SceneMode.js";
  * @see Transforms.computeTemeToPseudoFixedMatrix
  */
 function SkyBox(options) {
-  /**
-   * The sources used to create the cube map faces: an object
-   * with <code>positiveX</code>, <code>negativeX</code>, <code>positiveY</code>,
-   * <code>negativeY</code>, <code>positiveZ</code>, and <code>negativeZ</code> properties.
-   * These can be either URLs or <code>Image</code> objects.
-   *
-   * @type {object}
-   * @default undefined
-   */
-  this.sources = options.sources;
-  this._sources = undefined;
+  this._sources = options.sources;
 
   /**
    * Determines if the sky box will be shown.
@@ -71,19 +43,29 @@ function SkyBox(options) {
    * @default true
    */
   this.show = options.show ?? true;
-
-  this._command = new DrawCommand({
-    modelMatrix: Matrix4.clone(Matrix4.IDENTITY),
-    owner: this,
+  this._panorama = new CubeMapPanorama({
+    sources: this._sources,
+    show: this._show,
+    returnCommand: true,
   });
-  this._cubeMap = undefined;
-
-  this._attributeLocations = undefined;
-  this._useHdr = undefined;
-  this._hasError = false;
-  this._error = undefined;
 }
 
+Object.defineProperties(SkyBox.prototype, {
+  /**
+   * Gets or sets the the primitive object.
+   * @memberof SkyBox.prototype
+   * @type {object}
+   */
+  sources: {
+    get: function () {
+      return this._panorama.sources;
+    },
+    set: function (value) {
+      this._panorama.sources = value;
+    },
+  },
+});
+
 /**
  * Called when {@link Viewer} or {@link CesiumWidget} render the scene to
  * get the draw commands needed to render this primitive.
@@ -96,131 +78,18 @@ function SkyBox(options) {
  * @exception {DeveloperError} this.sources properties must all be the same type.
  */
 SkyBox.prototype.update = function (frameState, useHdr) {
-  const that = this;
-  const { mode, passes, context } = frameState;
-
-  if (!this.show) {
-    return undefined;
-  }
+  const { mode, passes } = frameState;
 
   if (mode !== SceneMode.SCENE3D && mode !== SceneMode.MORPHING) {
-    return undefined;
+    return;
   }
 
-  // The sky box is only rendered during the render pass; it is not pickable, it doesn't cast shadows, etc.
   if (!passes.render) {
-    return undefined;
-  }
-
-  // Throw any errors that had previously occurred asynchronously so they aren't
-  // ignored when running.  See https://github.com/CesiumGS/cesium/pull/12307
-  if (this._hasError) {
-    const error = this._error;
-    this._hasError = false;
-    this._error = undefined;
-    throw error;
-  }
-
-  if (this._sources !== this.sources) {
-    this._sources = this.sources;
-    const sources = this.sources;
-
-    //>>includeStart('debug', pragmas.debug);
-    Check.defined("this.sources", sources);
-    if (
-      Object.values(CubeMap.FaceName).some(
-        (faceName) => !defined(sources[faceName]),
-      )
-    ) {
-      throw new DeveloperError(
-        "this.sources must have positiveX, negativeX, positiveY, negativeY, positiveZ, and negativeZ properties.",
-      );
-    }
-
-    const sourceType = typeof sources.positiveX;
-    if (
-      Object.values(CubeMap.FaceName).some(
-        (faceName) => typeof sources[faceName] !== sourceType,
-      )
-    ) {
-      throw new DeveloperError(
-        "this.sources properties must all be the same type.",
-      );
-    }
-    //>>includeEnd('debug');
-
-    if (typeof sources.positiveX === "string") {
-      // Given urls for cube-map images.  Load them.
-      loadCubeMap(context, this._sources)
-        .then(function (cubeMap) {
-          that._cubeMap = that._cubeMap && that._cubeMap.destroy();
-          that._cubeMap = cubeMap;
-        })
-        .catch((error) => {
-          // Defer throwing the error until the next call to update to prevent
-          // test from failing in `afterAll` if this is rejected after the test
-          // using the Skybox ends.  See https://github.com/CesiumGS/cesium/pull/12307
-          this._hasError = true;
-          this._error = error;
-        });
-    } else {
-      this._cubeMap = this._cubeMap && this._cubeMap.destroy();
-      this._cubeMap = new CubeMap({
-        context: context,
-        source: sources,
-      });
-    }
-  }
-
-  const command = this._command;
-
-  if (!defined(command.vertexArray)) {
-    command.uniformMap = {
-      u_cubeMap: function () {
-        return that._cubeMap;
-      },
-    };
-
-    const geometry = BoxGeometry.createGeometry(
-      BoxGeometry.fromDimensions({
-        dimensions: new Cartesian3(2.0, 2.0, 2.0),
-        vertexFormat: VertexFormat.POSITION_ONLY,
-      }),
-    );
-    const attributeLocations = (this._attributeLocations =
-      GeometryPipeline.createAttributeLocations(geometry));
-
-    command.vertexArray = VertexArray.fromGeometry({
-      context: context,
-      geometry: geometry,
-      attributeLocations: attributeLocations,
-      bufferUsage: BufferUsage.STATIC_DRAW,
-    });
-
-    command.renderState = RenderState.fromCache({
-      blending: BlendingState.ALPHA_BLEND,
-    });
-  }
-
-  if (!defined(command.shaderProgram) || this._useHdr !== useHdr) {
-    const fs = new ShaderSource({
-      defines: [useHdr ? "HDR" : ""],
-      sources: [SkyBoxFS],
-    });
-    command.shaderProgram = ShaderProgram.fromCache({
-      context: context,
-      vertexShaderSource: SkyBoxVS,
-      fragmentShaderSource: fs,
-      attributeLocations: this._attributeLocations,
-    });
-    this._useHdr = useHdr;
-  }
-
-  if (!defined(this._cubeMap)) {
-    return undefined;
+    return;
   }
 
-  return command;
+  // Delegate completely
+  return this._panorama.update(frameState, useHdr);
 };
 
 /**
@@ -254,11 +123,7 @@ SkyBox.prototype.isDestroyed = function () {
  * @see SkyBox#isDestroyed
  */
 SkyBox.prototype.destroy = function () {
-  const command = this._command;
-  command.vertexArray = command.vertexArray && command.vertexArray.destroy();
-  command.shaderProgram =
-    command.shaderProgram && command.shaderProgram.destroy();
-  this._cubeMap = this._cubeMap && this._cubeMap.destroy();
+  this._panorama = this._panorama && this._panorama.destroy();
   return destroyObject(this);
 };
 

package/Source/Scene/StructuralMetadata.js

@@ -1,3 +1,4 @@
+import { destroyObject } from "@cesium/engine";
 import Check from "../Core/Check.js";
 import Frozen from "../Core/Frozen.js";
 import defined from "../Core/defined.js";
@@ -35,9 +36,9 @@ function StructuralMetadata(options) {
   this._propertyTableCount = defined(propertyTables)
     ? propertyTables.length
     : 0;
-  this._propertyTables = propertyTables;
-  this._propertyTextures = options.propertyTextures;
-  this._propertyAttributes = options.propertyAttributes;
+  this._propertyTables = propertyTables ?? [];
+  this._propertyTextures = options.propertyTextures ?? [];
+  this._propertyAttributes = options.propertyAttributes ?? [];
   this._statistics = options.statistics;
   this._extras = options.extras;
   this._extensions = options.extensions;
@@ -240,4 +241,18 @@ StructuralMetadata.prototype.getPropertyAttribute = function (
   return this._propertyAttributes[propertyAttributeId];
 };
 
+/**
+ * Destroys any resources that need cleaning up in the structural metadata.
+ *
+ * @private
+ */
+StructuralMetadata.prototype.destroy = function () {
+  const propertyTables = this._propertyTables;
+  for (let i = 0; i < propertyTables.length; i++) {
+    propertyTables[i] = propertyTables[i] && propertyTables[i].destroy();
+  }
+
+  return destroyObject(this);
+};
+
 export default StructuralMetadata;