Rename BSL -> BuildingSceneLayer

Apps/Sandcastle/gallery/I3S Building Scene Layer.html

@@ -81,7 +81,7 @@ <h1>Loading...</h1>
             i3sOptions
           );
 
-          Cesium.I3SBSLExplorer("toolbar", i3sProvider);
+          Cesium.I3SBuildingSceneLayerExplorer("toolbar", i3sProvider);
 
           // Add the i3s layer provider as a primitive data type
           viewer.scene.primitives.add(i3sProvider);

CHANGES.md

@@ -26,6 +26,12 @@
 
 - `Cesium3DTileset.disableCollision` has been deprecated and will be removed in 1.116. Use `Cesium3DTileset.enableCollision` instead.
 
+#### @cesium/engine
+
+##### Additions :tada:
+
+- Added `I3SBuildingSceneLayerExplorer` widget for working with I3S Building Scene Layer data. [#11678](https://github.com/CesiumGS/cesium/pull/11678)
+
 ### 1.114 - 2024-02-01
 
 #### @cesium/engine

packages/engine/Specs/Scene/I3SDecoderSpec.js

@@ -38,6 +38,11 @@ describe("Scene/I3SDecoder", function () {
     },
   ];
 
+  beforeEach(function () {
+    // Reset the initialized state
+    I3SDecoder._promise = undefined;
+  });
+
   it("constructor", function () {
     expect(new I3SDecoder()).toBeDefined();
   });
@@ -59,14 +64,12 @@ describe("Scene/I3SDecoder", function () {
   });
 
   it("throws if not initialized", async function () {
-    I3SDecoder._promise = undefined;
     spyOn(TaskProcessor.prototype, "initWebAssemblyModule").and.returnValue(
       Promise.resolve(false)
     );
     await expectAsync(
       I3SDecoder.decode("mockUrl", defaultGeometrySchema, geometryDataObb)
     ).toBeRejectedWithError(RuntimeError);
-    I3SDecoder._promise = undefined;
   });
 
   it("empty geometry with obb", async function () {

packages/engine/Specs/Scene/I3SNodeSpec.js

@@ -3,6 +3,7 @@ import {
   Cartographic,
   Cesium3DTileRefine,
   Cesium3DTileset,
+  clone,
   Math as CesiumMath,
   Ellipsoid,
   Event,
@@ -18,7 +19,6 @@ import {
   Resource,
   WebMercatorProjection,
 } from "../../index.js";
-import clone from "../../Source/Core/clone.js";
 
 describe("Scene/I3SNode", function () {
   // Mock geoid data. 2x2 pixels for the whole world

packages/widgets/Source/I3SBSLExplorer/I3SBSLExplorer.js → packages/widgets/Source/I3SBuildingSceneLayerExplorer/I3SBuildingSceneLayerExplorer.js

@@ -1,19 +1,19 @@
 import { Check, defined } from "@cesium/engine";
 import knockout from "../ThirdParty/knockout.js";
-import I3SBSLExplorerViewModel from "./I3SBSLExplorerViewModel.js";
+import I3SBuildingSceneLayerExplorerViewModel from "./I3SBuildingSceneLayerExplorerViewModel.js";
 
 /**
  * I3S Building Scene Layer widget
  *
- * @alias I3SBSLExplorer
+ * @alias I3SBuildingSceneLayerExplorer
  * @constructor
  *
  * @param {string} containerId The DOM element ID that will contain the widget.
  * @param {I3SDataProvider} i3sProvider I3S Data provider instance.
  *
  * @demo {@link https://sandcastle.cesium.com/index.html?src=I3S%20Building%20Scene%20Layer.html|I3S Building Scene Layer}
  */
-function I3SBSLExplorer(containerId, i3sProvider) {
+function I3SBuildingSceneLayerExplorer(containerId, i3sProvider) {
   const container = document.getElementById(containerId);
 
   //>>includeStart('debug', pragmas.debug);
@@ -67,7 +67,7 @@ function I3SBSLExplorer(containerId, i3sProvider) {
         </div>`;
   container.appendChild(htmlWrapper);
 
-  const viewModel = new I3SBSLExplorerViewModel(i3sProvider);
+  const viewModel = new I3SBuildingSceneLayerExplorerViewModel(i3sProvider);
 
   knockout.track(viewModel);
   knockout.applyBindings(viewModel, container);
@@ -77,4 +77,4 @@ function I3SBSLExplorer(containerId, i3sProvider) {
     viewModel.currentLayer = viewModel.defaultLayer;
   }
 }
-export default I3SBSLExplorer;
+export default I3SBuildingSceneLayerExplorer;

packages/widgets/Source/I3SBSLExplorer/I3SBSLExplorerViewModel.js → packages/widgets/Source/I3SBuildingSceneLayerExplorer/I3SBuildingSceneLayerExplorerViewModel.js

@@ -85,13 +85,13 @@ async function setLevels(i3sProvider, levels) {
 }
 
 /**
- * The view model for {@link I3SBSLExplorer}.
- * @alias I3SBSLExplorerViewModel
+ * The view model for {@link I3SBuildingSceneLayerExplorer}.
+ * @alias I3sBslExplorerViewModel
  * @constructor
  *
  * @param {I3SDataProvider} i3sProvider I3S Data provider instance.
  */
-function I3SBSLExplorerViewModel(i3sProvider) {
+function I3SBuildingSceneLayerExplorerViewModel(i3sProvider) {
   const that = this;
   this.levels = [];
   this.viewModel = {
@@ -169,4 +169,4 @@ function I3SBSLExplorerViewModel(i3sProvider) {
   return this.viewModel;
 }
 
-export default I3SBSLExplorerViewModel;
+export default I3SBuildingSceneLayerExplorerViewModel;

packages/widgets/Source/widgets.css

@@ -16,4 +16,4 @@
 @import url(./SelectionIndicator/SelectionIndicator.css);
 @import url(./Timeline/Timeline.css);
 @import url(./Viewer/Viewer.css);
-@import url(./I3SBSLExplorer/I3SBSLExplorer.css);
+@import url(./I3SBuildingSceneLayerExplorer/I3SBuildingSceneLayerExplorer.css);

packages/widgets/Specs/I3SBSLExplorer/I3SBSLExplorerSpec.js

@@ -1,7 +1,7 @@
-import { I3SBSLExplorer } from "../../index.js";
+import { I3SBuildingSceneLayerExplorer } from "../../index.js";
 import DomEventSimulator from "../../../../Specs/DomEventSimulator.js";
 
-describe("Widgets/I3SBSLExplorer/I3SBSLExplorer", function () {
+describe("Widgets/I3SBuildingSceneLayerExplorer/I3SBuildingSceneLayerExplorer", function () {
   const i3sProvider = {
     sublayers: [
       {
@@ -39,8 +39,10 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorer", function () {
     container.id = "testContainer";
     document.body.appendChild(container);
 
-    const widget = new I3SBSLExplorer("testContainer", { sublayers: [] });
-    expect(widget).toBeInstanceOf(I3SBSLExplorer);
+    const widget = new I3SBuildingSceneLayerExplorer("testContainer", {
+      sublayers: [],
+    });
+    expect(widget).toBeInstanceOf(I3SBuildingSceneLayerExplorer);
 
     expect(container.childElementCount).toEqual(1);
     expect(container.children[0].childElementCount).toEqual(3);
@@ -60,7 +62,7 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorer", function () {
 
   it("throws dev error with no container", function () {
     expect(function () {
-      return new I3SBSLExplorer();
+      return new I3SBuildingSceneLayerExplorer();
     }).toThrowDeveloperError();
   });
 
@@ -70,7 +72,7 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorer", function () {
     document.body.appendChild(container);
 
     expect(function () {
-      return new I3SBSLExplorer("testContainer");
+      return new I3SBuildingSceneLayerExplorer("testContainer");
     }).toThrowDeveloperError();
     document.body.removeChild(container);
   });
@@ -81,8 +83,11 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorer", function () {
     document.body.appendChild(container);
 
     i3sProvider.filterByAttributes = jasmine.createSpy();
-    const widget = new I3SBSLExplorer("testContainer", i3sProvider);
-    expect(widget).toBeInstanceOf(I3SBSLExplorer);
+    const widget = new I3SBuildingSceneLayerExplorer(
+      "testContainer",
+      i3sProvider
+    );
+    expect(widget).toBeInstanceOf(I3SBuildingSceneLayerExplorer);
 
     const expander = document.querySelector(".expandItem");
     const nestedList = expander.parentElement.parentElement.querySelector(

packages/widgets/Specs/I3SBSLExplorer/I3SBSLExplorerViewModelSpec.js

@@ -1,8 +1,8 @@
-import { I3SBSLExplorerViewModel } from "../../index.js";
+import { I3SBuildingSceneLayerExplorerViewModel } from "../../index.js";
 
 import { knockout } from "../../index.js";
 
-describe("Widgets/I3SBSLExplorer/I3SBSLExplorerViewModel", function () {
+describe("Widgets/I3SBuildingSceneLayerExplorer/I3SBuildingSceneLayerExplorerViewModel", function () {
   const i3sProvider = {
     sublayers: [
       {
@@ -49,7 +49,7 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorerViewModel", function () {
   };
 
   it("can create bsl explorer ViewModel", function () {
-    const viewModel = new I3SBSLExplorerViewModel(i3sProvider);
+    const viewModel = new I3SBuildingSceneLayerExplorerViewModel(i3sProvider);
     expect(viewModel.levels).toEqual(["All", 0, 1]);
     expect(viewModel.selectedLevel).toEqual("All");
 
@@ -89,7 +89,9 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorerViewModel", function () {
   });
 
   it("can create bsl explorer ViewModel if no Overview", function () {
-    const viewModel = new I3SBSLExplorerViewModel(i3sProviderWithoutOverview);
+    const viewModel = new I3SBuildingSceneLayerExplorerViewModel(
+      i3sProviderWithoutOverview
+    );
     expect(viewModel.sublayers.length).toEqual(1);
     expect(viewModel.sublayers[0].name).toEqual("Full Model");
     expect(viewModel.sublayers[0].modelName).toEqual("FullModel");
@@ -123,7 +125,7 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorerViewModel", function () {
 
   it("can handle filtering by level", function () {
     i3sProvider.filterByAttributes = jasmine.createSpy();
-    const viewModel = new I3SBSLExplorerViewModel(i3sProvider);
+    const viewModel = new I3SBuildingSceneLayerExplorerViewModel(i3sProvider);
     knockout.track(viewModel);
 
     viewModel.currentLevel = 1;
@@ -144,7 +146,7 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorerViewModel", function () {
     document.body.appendChild(bslWrapper);
 
     i3sProvider.filterByAttributes = jasmine.createSpy();
-    const viewModel = new I3SBSLExplorerViewModel(i3sProvider);
+    const viewModel = new I3SBuildingSceneLayerExplorerViewModel(i3sProvider);
     knockout.track(viewModel);
 
     viewModel.currentLayer = {
@@ -183,7 +185,9 @@ describe("Widgets/I3SBSLExplorer/I3SBSLExplorerViewModel", function () {
     document.body.appendChild(bslWrapper);
 
     i3sProviderWithoutOverview.filterByAttributes = jasmine.createSpy();
-    const viewModel = new I3SBSLExplorerViewModel(i3sProviderWithoutOverview);
+    const viewModel = new I3SBuildingSceneLayerExplorerViewModel(
+      i3sProviderWithoutOverview
+    );
     knockout.track(viewModel);
 
     viewModel.currentLayer = {