Merge pull request #13010 from CesiumGS/remove-splat-deprecation

Remove support for the legacy splats extension

Author: jjhembd

CHANGES.md

@@ -8,6 +8,7 @@
 
 - `scene.drillPick` now uses a breadth-first search strategy instead of depth-first. This may change which entities are picked when
   using large values of `width` and `height` when providing a `limit`, prioritizing entities closer to the camera.
+- Removed support for the `KHR_spz_gaussian_splats_compression` extension in favor of the latest 3D Gaussian splatting extensions for glTF, `KHR_gaussian_splatting` and `KHR_gaussian_splatting_compression_spz_2`. Please re-tile existing Gaussian splatting 3D Tiles [#12837](https://github.com/CesiumGS/cesium/issues/12837)
 
 #### Additions :tada:
 

Documentation/Contributors/ReleaseGuide/README.md

@@ -21,7 +21,8 @@ There is no one release manager; instead, [our community shares the responsibili
    - If `prettier` needs updated you _should_ still update it but keep the version pinned. If you run `npm install prettier@latest` you must remove the `^` in `package.json`. If the number of changes when running `npm run prettier` is large it may be worth opening a separate PR for only those.
 3. Verify each update. If an update can be resolved, open a PR with your changes. If an update is incompatible, open an issue. Check the [`dependencies` label](https://github.com/CesiumGS/cesium/issues?q=is%3Aissue+is%3Aopen+label%3Adependencies) for any open issues pinning versions.
 4. Check the [`priority - next release` issues and PRs](https://github.com/CesiumGS/cesium/labels/priority%20-%20next%20release). If there are any outstanding items, post a message to the `CesiumJS` channel in Teams to figure out what needs to be addressed before we can release.
-5. Ensure you've generated valid [end to end testing snapshots](../TestingGuide/README.md) against a previous release tag with `npm run test-e2e-update`.
+5. Check the [`remove in [this version number]` issues](https://github.com/CesiumGS/cesium/labels?q=remove) and open PRs to address any deprecations.
+6. Ensure you've generated valid [end to end testing snapshots](../TestingGuide/README.md) against a previous release tag with `npm run test-e2e-update`.
 
 ## Release testing and packaging
 

Specs/Data/Cesium3DTiles/GaussianSplats/tower_legacy/0/0.glb

@@ -125,30 +125,27 @@ GaussianSplat3DTileContent.tilesetRequiresGaussianSplattingExt = function (
   tileset,
 ) {
   let hasGaussianSplatExtension = false;
-  let hasLegacyGaussianSplatExtension = false;
   if (tileset.isGltfExtensionRequired instanceof Function) {
     hasGaussianSplatExtension =
       tileset.isGltfExtensionRequired("KHR_gaussian_splatting") &&
       tileset.isGltfExtensionRequired(
         "KHR_gaussian_splatting_compression_spz_2",
       );
 
-    hasLegacyGaussianSplatExtension = tileset.isGltfExtensionRequired(
-      "KHR_spz_gaussian_splats_compression",
-    );
-  }
-
-  if (hasLegacyGaussianSplatExtension) {
-    deprecationWarning(
-      "KHR_spz_gaussian_splats_compression",
-      "Support for the original KHR_spz_gaussian_splats_compression extension has been deprecated in favor " +
-        "of the up to date KHR_gaussian_splatting and KHR_gaussian_splatting_compression_spz_2 extensions and will be " +
-        "removed in CesiumJS 1.135.\n\nPlease retile your tileset with the KHR_gaussian_splatting and " +
-        "KHR_gaussian_splatting_compression_spz_2 extensions.",
-    );
+    if (
+      tileset.isGltfExtensionRequired("KHR_spz_gaussian_splats_compression")
+    ) {
+      deprecationWarning(
+        "KHR_spz_gaussian_splats_compression",
+        "Support for the original KHR_spz_gaussian_splats_compression extension has been removed in favor " +
+          "of the up to date KHR_gaussian_splatting and KHR_gaussian_splatting_compression_spz_2 extensions" +
+          "\n\nPlease retile your tileset with the KHR_gaussian_splatting and " +
+          "KHR_gaussian_splatting_compression_spz_2 extensions.",
+      );
+    }
   }
 
-  return hasGaussianSplatExtension || hasLegacyGaussianSplatExtension;
+  return hasGaussianSplatExtension;
 };
 
 Object.defineProperties(GaussianSplat3DTileContent.prototype, {

Specs/Data/Cesium3DTiles/GaussianSplats/tower_legacy/tileset.json

@@ -1999,11 +1999,6 @@ function fetchSpzExtensionFrom(extensions) {
     return spz;
   }
 
-  const legacySpz = extensions?.KHR_spz_gaussian_splats_compression;
-  if (defined(legacySpz)) {
-    return legacySpz;
-  }
-
   return undefined;
 }
 

packages/engine/Source/Scene/GaussianSplat3DTileContent.js

@@ -370,7 +370,6 @@ ModelUtility.supportedExtensions = {
   KHR_texture_transform: true,
   KHR_gaussian_splatting: true,
   KHR_gaussian_splatting_compression_spz_2: true,
-  KHR_spz_gaussian_splats_compression: true,
   WEB3D_quantized_attributes: true,
 };
 

packages/engine/Source/Scene/GltfLoader.js

@@ -184,112 +184,3 @@ describe(
   },
   "WebGL",
 );
-
-describe(
-  "Scene/GaussianSplat3DTileContent_Legacy",
-  function () {
-    const tilesetUrl =
-      "./Data/Cesium3DTiles/GaussianSplats/tower_legacy/tileset.json";
-
-    let scene;
-    let options;
-
-    beforeAll(function () {
-      scene = createScene();
-    });
-
-    afterAll(function () {
-      scene.destroyForSpecs();
-    });
-
-    beforeEach(function () {
-      RequestScheduler.clearForSpecs();
-      scene.morphTo3D(0.0);
-
-      const camera = scene.camera;
-      camera.frustum = new PerspectiveFrustum();
-      camera.frustum.aspectRatio =
-        scene.drawingBufferWidth / scene.drawingBufferHeight;
-      camera.frustum.fov = CesiumMath.toRadians(60.0);
-
-      options = {
-        cullRequestsWhileMoving: false,
-        maximumScreenSpaceError: 1,
-      };
-    });
-
-    afterEach(function () {
-      scene.primitives.removeAll();
-      ResourceCache.clearForSpecs();
-    });
-
-    it("loads Gaussian Splat content", function () {
-      return Cesium3DTilesTester.loadTileset(scene, tilesetUrl, options).then(
-        function (tileset) {
-          scene.camera.lookAt(
-            tileset.boundingSphere.center,
-            new HeadingPitchRange(0.0, -1.57, tileset.boundingSphere.radius),
-          );
-
-          return Cesium3DTilesTester.waitForTileContentReady(
-            scene,
-            tileset.root,
-          ).then(function (tile) {
-            const content = tile.content;
-            expect(content).toBeDefined();
-            expect(content instanceof GaussianSplat3DTileContent).toBe(true);
-
-            const gltfPrimitive = content.gltfPrimitive;
-            expect(gltfPrimitive).toBeDefined();
-            expect(gltfPrimitive.attributes.length).toBeGreaterThan(0);
-            const positions = ModelUtility.getAttributeBySemantic(
-              gltfPrimitive,
-              VertexAttributeSemantic.POSITION,
-            ).typedArray;
-
-            const rotations = ModelUtility.getAttributeBySemantic(
-              gltfPrimitive,
-              VertexAttributeSemantic.ROTATION,
-            ).typedArray;
-
-            const scales = ModelUtility.getAttributeBySemantic(
-              gltfPrimitive,
-              VertexAttributeSemantic.SCALE,
-            ).typedArray;
-
-            const colors = ModelUtility.getAttributeBySemantic(
-              gltfPrimitive,
-              VertexAttributeSemantic.COLOR,
-            ).typedArray;
-
-            expect(positions.length).toBeGreaterThan(0);
-            expect(rotations.length).toBeGreaterThan(0);
-            expect(scales.length).toBeGreaterThan(0);
-            expect(colors.length).toBeGreaterThan(0);
-          });
-        },
-      );
-    });
-    it("Create and destroy GaussianSplat3DTileContent", async function () {
-      const tileset = await Cesium3DTilesTester.loadTileset(
-        scene,
-        tilesetUrl,
-        options,
-      );
-      scene.camera.lookAt(
-        tileset.boundingSphere.center,
-        new HeadingPitchRange(0.0, -1.57, tileset.boundingSphere.radius),
-      );
-      const tile = await Cesium3DTilesTester.waitForTileContentReady(
-        scene,
-        tileset.root,
-      );
-
-      scene.primitives.remove(tileset);
-      expect(tileset.isDestroyed()).toBe(true);
-      expect(tile.isDestroyed()).toBe(true);
-      expect(tile.content).toBeUndefined();
-    });
-  },
-  "WebGL",
-);

packages/engine/Source/Scene/Model/ModelUtility.js

@@ -214,71 +214,3 @@ describe(
   },
   "WebGL",
 );
-
-describe(
-  "Scene/GaussianSplatPrimitive_Legacy",
-  function () {
-    const tilesetUrl =
-      "./Data/Cesium3DTiles/GaussianSplats/tower_legacy/tileset.json";
-
-    let scene;
-    let options;
-
-    beforeAll(function () {
-      scene = createScene();
-    });
-
-    afterAll(function () {
-      scene.destroyForSpecs();
-    });
-
-    beforeEach(function () {
-      RequestScheduler.clearForSpecs();
-      scene.morphTo3D(0.0);
-
-      const camera = scene.camera;
-      camera.frustum = new PerspectiveFrustum();
-      camera.frustum.aspectRatio =
-        scene.drawingBufferWidth / scene.drawingBufferHeight;
-      camera.frustum.fov = CesiumMath.toRadians(60.0);
-
-      options = {
-        cullRequestsWhileMoving: false,
-        maximumScreenSpaceError: 1,
-      };
-    });
-
-    afterEach(function () {
-      scene.primitives.removeAll();
-      ResourceCache.clearForSpecs();
-    });
-
-    it("loads a Gaussian splats tileset", async function () {
-      const tileset = await Cesium3DTilesTester.loadTileset(
-        scene,
-        tilesetUrl,
-        options,
-      );
-      scene.camera.lookAt(
-        tileset.boundingSphere.center,
-        new HeadingPitchRange(0.0, -1.57, tileset.boundingSphere.radius),
-      );
-      expect(tileset.hasExtension("3DTILES_content_gltf")).toBe(true);
-      expect(
-        tileset.isGltfExtensionUsed("KHR_spz_gaussian_splats_compression"),
-      ).toBe(true);
-      expect(
-        tileset.isGltfExtensionRequired("KHR_spz_gaussian_splats_compression"),
-      ).toBe(true);
-
-      const tile = await Cesium3DTilesTester.waitForTileContentReady(
-        scene,
-        tileset.root,
-      );
-
-      expect(tile.content).toBeDefined();
-      expect(tile.content instanceof GaussianSplat3DTileContent).toBe(true);
-    });
-  },
-  "WebGL",
-);