@cesium/engine 9.1.0 → 10.0.0

package/Source/Widget/CesiumWidget.js

@@ -1,4 +1,3 @@
-import buildModuleUrl from "../Core/buildModuleUrl.js";
 import Cartesian3 from "../Core/Cartesian3.js";
 import Clock from "../Core/Clock.js";
 import defaultValue from "../Core/defaultValue.js";
@@ -20,10 +19,6 @@ import SkyAtmosphere from "../Scene/SkyAtmosphere.js";
 import SkyBox from "../Scene/SkyBox.js";
 import Sun from "../Scene/Sun.js";
 
-function getDefaultSkyBoxUrl(suffix) {
-  return buildModuleUrl(`Assets/Textures/SkyBox/tycho2t3_80_${suffix}.jpg`);
-}
-
 function startRenderLoop(widget) {
   widget._renderLoopRunning = true;
 
@@ -123,16 +118,17 @@ function configureCameraFrustum(widget) {
  * @param {Element|string} container The DOM element or ID that will contain the widget.
  * @param {object} [options] Object with the following properties:
  * @param {Clock} [options.clock=new Clock()] The clock to use to control current time.
+ * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.default] The default ellipsoid.
  * @param {ImageryLayer|false} [options.baseLayer=ImageryLayer.fromWorldImagery()] The bottommost imagery layer applied to the globe. If set to <code>false</code>, no imagery provider will be added.
- * @param {TerrainProvider} [options.terrainProvider=new EllipsoidTerrainProvider] The terrain provider.
+ * @param {TerrainProvider} [options.terrainProvider=new EllipsoidTerrainProvider(options.ellipsoid)] The terrain provider.
  * @param {Terrain} [options.terrain] A terrain object which handles asynchronous terrain provider. Can only specify if options.terrainProvider is undefined.
- * @param {SkyBox| false} [options.skyBox] The skybox used to render the stars.  When <code>undefined</code>, the default stars are used. If set to <code>false</code>, no skyBox, Sun, or Moon will be added.
- * @param {SkyAtmosphere | false} [options.skyAtmosphere] Blue sky, and the glow around the Earth's limb.  Set to <code>false</code> to turn it off.
+ * @param {SkyBox| false} [options.skyBox] The skybox used to render the stars. When <code>undefined</code> and the WGS84 ellipsoid used, the default stars are used. If set to <code>false</code>, no skyBox, Sun, or Moon will be added.
+ * @param {SkyAtmosphere | false} [options.skyAtmosphere] Blue sky, and the glow around the Earth's limb. Enabled when the default ellipsoid used. Set to <code>false</code> to turn it off.
  * @param {SceneMode} [options.sceneMode=SceneMode.SCENE3D] The initial scene mode.
  * @param {boolean} [options.scene3DOnly=false] When <code>true</code>, each geometry instance will only be rendered in 3D to save GPU memory.
  * @param {boolean} [options.orderIndependentTranslucency=true] If true and the configuration supports it, use order independent translucency.
- * @param {MapProjection} [options.mapProjection=new GeographicProjection()] The map projection to use in 2D and Columbus View modes.
- * @param {Globe | false} [options.globe=new Globe(mapProjection.ellipsoid)] The globe to use in the scene.  If set to <code>false</code>, no globe will be added and the sky atmosphere will be hidden by default.
+ * @param {MapProjection} [options.mapProjection=new GeographicProjection(options.ellipsoid)] The map projection to use in 2D and Columbus View modes.
+ * @param {Globe | false} [options.globe=new Globe(options.ellipsoid)] The globe to use in the scene.  If set to <code>false</code>, no globe will be added and the sky atmosphere will be hidden by default.
  * @param {boolean} [options.useDefaultRenderLoop=true] True if this widget should control the render loop, false otherwise.
  * @param {boolean} [options.useBrowserRecommendedResolution=true] If true, render at the browser's recommended resolution and ignore <code>window.devicePixelRatio</code>.
  * @param {number} [options.targetFrameRate] The target frame rate when using the default render loop.
@@ -274,11 +270,14 @@ function CesiumWidget(container, options) {
   configureCanvasSize(this);
 
   try {
+    const ellipsoid = defaultValue(options.ellipsoid, Ellipsoid.default);
+
     const scene = new Scene({
       canvas: canvas,
       contextOptions: options.contextOptions,
       creditContainer: innerCreditContainer,
       creditViewport: creditViewport,
+      ellipsoid: ellipsoid,
       mapProjection: options.mapProjection,
       orderIndependentTranslucency: options.orderIndependentTranslucency,
       scene3DOnly: defaultValue(options.scene3DOnly, false),
@@ -296,11 +295,6 @@ function CesiumWidget(container, options) {
     configurePixelRatio(this);
     configureCameraFrustum(this);
 
-    const ellipsoid = defaultValue(
-      scene.mapProjection.ellipsoid,
-      Ellipsoid.WGS84
-    );
-
     let globe = options.globe;
     if (!defined(globe)) {
       globe = new Globe(ellipsoid);
@@ -314,27 +308,21 @@ function CesiumWidget(container, options) {
     }
 
     let skyBox = options.skyBox;
-    if (!defined(skyBox)) {
-      skyBox = new SkyBox({
-        sources: {
-          positiveX: getDefaultSkyBoxUrl("px"),
-          negativeX: getDefaultSkyBoxUrl("mx"),
-          positiveY: getDefaultSkyBoxUrl("py"),
-          negativeY: getDefaultSkyBoxUrl("my"),
-          positiveZ: getDefaultSkyBoxUrl("pz"),
-          negativeZ: getDefaultSkyBoxUrl("mz"),
-        },
-      });
+    if (!defined(skyBox) && Ellipsoid.WGS84.equals(ellipsoid)) {
+      skyBox = SkyBox.createEarthSkyBox();
     }
     if (skyBox !== false) {
       scene.skyBox = skyBox;
       scene.sun = new Sun();
-      scene.moon = new Moon();
+
+      if (Ellipsoid.WGS84.equals(ellipsoid)) {
+        scene.moon = new Moon();
+      }
     }
 
     // Blue sky, and the glow around the Earth's limb.
     let skyAtmosphere = options.skyAtmosphere;
-    if (!defined(skyAtmosphere)) {
+    if (!defined(skyAtmosphere) && Ellipsoid.WGS84.equals(ellipsoid)) {
       skyAtmosphere = new SkyAtmosphere(ellipsoid);
       skyAtmosphere.show = options.globe !== false && globe.show;
     }
@@ -529,6 +517,19 @@ Object.defineProperties(CesiumWidget.prototype, {
     },
   },
 
+  /**
+   * Gets the default ellipsoid for the scene.
+   * @memberof CesiumWidget.prototype
+   *
+   * @type {Ellipsoid}
+   * @readonly
+   */
+  ellipsoid: {
+    get: function () {
+      return this._scene.ellipsoid;
+    },
+  },
+
   /**
    * Gets the clock.
    * @memberof CesiumWidget.prototype