Implement support for KHR_gaussian_splatting and KHR_gaussian_splatting_compression_spz_2

CHANGES.md

@@ -12,6 +12,11 @@
 - Added `AzureMapsRasterOverlay`.
 - Added `Uri::ensureTrailingSlash`, which is helpful when the `Uri` represents a base URL.
 
+##### Additions :tada:
+
+- Added support for the `KHR_gaussian_splatting` extension.
+  - SPZ payloads for `KHR_guassian_splatting` using the `KHR_gaussian_splatting_compression_spz_2` extension will now be decoded.
+
 ##### Fixes :wrench:
 
 - Fixed a bug in `GoogleMapTilesRasterOverlay` that tried to parse credits from an erroneous viewport service response.

CMakeLists.txt

@@ -100,7 +100,7 @@ set(PACKAGES_PUBLIC asyncplusplus expected-lite fmt glm rapidjson spdlog stb ada
 set(PACKAGES_PRIVATE
     abseil draco ktx modp-base64 meshoptimizer openssl s2geometry
     libjpeg-turbo sqlite3 tinyxml2 libwebp zlib-ng picosha2
-    earcut-hpp cpp-httplib[core] libmorton zstd
+    earcut-hpp cpp-httplib[core] libmorton zstd spz zlib
 )
 
 # asmjit needed by blend2d on non-iOS platforms (iOS doesn't support JIT)
@@ -326,6 +326,7 @@ find_package(meshoptimizer CONFIG REQUIRED)
 find_package(OpenSSL REQUIRED)
 find_package(s2 CONFIG REQUIRED)
 find_package(spdlog CONFIG REQUIRED)
+find_package(spz CONFIG REQUIRED)
 find_package(tinyxml2 CONFIG REQUIRED)
 find_package(unofficial-sqlite3 CONFIG REQUIRED)
 find_package(WebP CONFIG REQUIRED)

CesiumGltf/generated/include/CesiumGltf/ExtensionKhrGaussianSplatting.h

@@ -0,0 +1,59 @@
+// This file was generated by generate-classes.
+// DO NOT EDIT THIS FILE!
+#pragma once
+
+#include <CesiumGltf/ExtensionKhrGaussianSplattingHintsValue.h>
+#include <CesiumGltf/Library.h>
+#include <CesiumUtility/ExtensibleObject.h>
+
+#include <optional>
+#include <string>
+
+namespace CesiumGltf {
+/**
+ * @brief Data for a 3D Gaussian Splat primitive.
+ */
+struct CESIUMGLTF_API ExtensionKhrGaussianSplatting final
+    : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
+  static constexpr const char* TypeName = "ExtensionKhrGaussianSplatting";
+  /** @brief The official name of the extension. This should be the same as its
+   * key in the `extensions` object. */
+  static constexpr const char* ExtensionName = "KHR_gaussian_splatting";
+
+  /**
+   * @brief The shape of the Gaussian to render. Gaussians may be available in
+   * different shapes, so this is a freeform field that defaults to ellipsoid.
+   * See the extension specification for futher known types.
+   */
+  std::string shape = "ellipsoid";
+
+  /**
+   * @brief Optional rendering hints for rendering the 3D Gaussian splats.
+   * Renderers are free to ignore any of these.
+   */
+  std::optional<CesiumGltf::ExtensionKhrGaussianSplattingHintsValue> hints;
+
+  /**
+   * @brief Calculates the size in bytes of this object, including the contents
+   * of all collections, pointers, and strings. This will NOT include the size
+   * of any extensions attached to the object. Calling this method may be slow
+   * as it requires traversing the object's entire structure.
+   */
+  int64_t getSizeBytes() const {
+    int64_t accum = 0;
+    accum += int64_t(sizeof(ExtensionKhrGaussianSplatting));
+    accum += CesiumUtility::ExtensibleObject::getSizeBytes() -
+             int64_t(sizeof(CesiumUtility::ExtensibleObject));
+    accum += int64_t(this->shape.capacity() * sizeof(char));
+    if (this->hints) {
+      accum +=
+          this->hints->getSizeBytes() -
+          int64_t(sizeof(CesiumGltf::ExtensionKhrGaussianSplattingHintsValue));
+    }
+    return accum;
+  }
+};
+} // namespace CesiumGltf

CesiumGltf/generated/include/CesiumGltf/ExtensionKhrGaussianSplattingCompressionSpz2.h

@@ -0,0 +1,46 @@
+// This file was generated by generate-classes.
+// DO NOT EDIT THIS FILE!
+#pragma once
+
+#include <CesiumGltf/Library.h>
+#include <CesiumUtility/ExtensibleObject.h>
+
+#include <cstdint>
+
+namespace CesiumGltf {
+/**
+ * @brief Compressed data for SPZ v2 primitive.
+ */
+struct CESIUMGLTF_API ExtensionKhrGaussianSplattingCompressionSpz2 final
+    : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
+  static constexpr const char* TypeName =
+      "ExtensionKhrGaussianSplattingCompressionSpz2";
+  /** @brief The official name of the extension. This should be the same as its
+   * key in the `extensions` object. */
+  static constexpr const char* ExtensionName =
+      "KHR_gaussian_splatting_compression_spz_2";
+
+  /**
+   * @brief The index of the bufferView.
+   */
+  int32_t bufferView = -1;
+
+  /**
+   * @brief Calculates the size in bytes of this object, including the contents
+   * of all collections, pointers, and strings. This will NOT include the size
+   * of any extensions attached to the object. Calling this method may be slow
+   * as it requires traversing the object's entire structure.
+   */
+  int64_t getSizeBytes() const {
+    int64_t accum = 0;
+    accum += int64_t(sizeof(ExtensionKhrGaussianSplattingCompressionSpz2));
+    accum += CesiumUtility::ExtensibleObject::getSizeBytes() -
+             int64_t(sizeof(CesiumUtility::ExtensibleObject));
+
+    return accum;
+  }
+};
+} // namespace CesiumGltf

CesiumGltf/generated/include/CesiumGltf/ExtensionKhrGaussianSplattingHintsValue.h

@@ -0,0 +1,53 @@
+// This file was generated by generate-classes.
+// DO NOT EDIT THIS FILE!
+#pragma once
+
+#include <CesiumGltf/Library.h>
+#include <CesiumUtility/ExtensibleObject.h>
+
+#include <string>
+
+namespace CesiumGltf {
+/**
+ * @brief Optional rendering hints for rendering the 3D Gaussian splats.
+ * Renderers are free to ignore any of these.
+ */
+struct CESIUMGLTF_API ExtensionKhrGaussianSplattingHintsValue final
+    : public CesiumUtility::ExtensibleObject {
+  /**
+   * @brief The original name of this type.
+   */
+  static constexpr const char* TypeName =
+      "ExtensionKhrGaussianSplattingHintsValue";
+
+  /**
+   * @brief Provides a hint specifying how to project the Gaussians to achieve a
+   * perspective correct value. This is a freeform field that defaults to
+   * perspective. See the extension specification for further known types.
+   */
+  std::string projection = "perspective";
+
+  /**
+   * @brief Provides a hint specifying how to sort the Gaussians during
+   * rendering. This is a freeform field defaulting to cameraDistance. See the
+   * extension specification for further known types.
+   */
+  std::string sortingMethod = "cameraDistance";
+
+  /**
+   * @brief Calculates the size in bytes of this object, including the contents
+   * of all collections, pointers, and strings. This will NOT include the size
+   * of any extensions attached to the object. Calling this method may be slow
+   * as it requires traversing the object's entire structure.
+   */
+  int64_t getSizeBytes() const {
+    int64_t accum = 0;
+    accum += int64_t(sizeof(ExtensionKhrGaussianSplattingHintsValue));
+    accum += CesiumUtility::ExtensibleObject::getSizeBytes() -
+             int64_t(sizeof(CesiumUtility::ExtensibleObject));
+    accum += int64_t(this->projection.capacity() * sizeof(char));
+    accum += int64_t(this->sortingMethod.capacity() * sizeof(char));
+    return accum;
+  }
+};
+} // namespace CesiumGltf

CesiumGltf/generated/include/CesiumGltf/ExtensionTextureWebp.h

@@ -22,7 +22,7 @@ struct CESIUMGLTF_API ExtensionTextureWebp final
   static constexpr const char* ExtensionName = "EXT_texture_webp";
 
   /**
-   * @brief The index of the images node which points to a WebP image.
+   * @brief The index of the WebP image.
    */
   int32_t source = -1;
 

CesiumGltfReader/CMakeLists.txt

@@ -62,6 +62,7 @@ target_link_libraries(CesiumGltfReader
         meshoptimizer::meshoptimizer
         modp_b64::modp_b64
         KTX::ktx
+        spz::spz
         WebP::webp WebP::webpdecoder
         $<IF:$<TARGET_EXISTS:libjpeg-turbo::turbojpeg>,libjpeg-turbo::turbojpeg,libjpeg-turbo::turbojpeg-static>
 )

CesiumGltfReader/generated/include/CesiumGltfReader/ExtensionKhrGaussianSplattingCompressionSpz2Reader.h

@@ -0,0 +1,79 @@
+// This file was generated by generate-classes.
+// DO NOT EDIT THIS FILE!
+#pragma once
+
+#include <CesiumGltf/ExtensionKhrGaussianSplattingCompressionSpz2.h>
+#include <CesiumGltfReader/Library.h>
+#include <CesiumJsonReader/JsonReader.h>
+#include <CesiumJsonReader/JsonReaderOptions.h>
+
+#include <rapidjson/fwd.h>
+
+#include <span>
+#include <vector>
+
+namespace CesiumGltf {
+struct ExtensionKhrGaussianSplattingCompressionSpz2;
+} // namespace CesiumGltf
+
+namespace CesiumGltfReader {
+
+/**
+ * @brief Reads \ref CesiumGltf::ExtensionKhrGaussianSplattingCompressionSpz2
+ * "ExtensionKhrGaussianSplattingCompressionSpz2" instances from JSON.
+ */
+class CESIUMGLTFREADER_API ExtensionKhrGaussianSplattingCompressionSpz2Reader {
+public:
+  /**
+   * @brief Constructs a new instance.
+   */
+  ExtensionKhrGaussianSplattingCompressionSpz2Reader();
+
+  /**
+   * @brief Gets the options controlling how the JSON is read.
+   */
+  CesiumJsonReader::JsonReaderOptions& getOptions();
+
+  /**
+   * @brief Gets the options controlling how the JSON is read.
+   */
+  const CesiumJsonReader::JsonReaderOptions& getOptions() const;
+
+  /**
+   * @brief Reads an instance of ExtensionKhrGaussianSplattingCompressionSpz2
+   * from a byte buffer.
+   *
+   * @param data The buffer from which to read the instance.
+   * @return The result of reading the instance.
+   */
+  CesiumJsonReader::ReadJsonResult<
+      CesiumGltf::ExtensionKhrGaussianSplattingCompressionSpz2>
+  readFromJson(const std::span<const std::byte>& data) const;
+
+  /**
+   * @brief Reads an instance of ExtensionKhrGaussianSplattingCompressionSpz2
+   * from a rapidJson::Value.
+   *
+   * @param value The value from which to read the instance.
+   * @return The result of reading the instance.
+   */
+  CesiumJsonReader::ReadJsonResult<
+      CesiumGltf::ExtensionKhrGaussianSplattingCompressionSpz2>
+  readFromJson(const rapidjson::Value& value) const;
+
+  /**
+   * @brief Reads an array of instances of
+   * ExtensionKhrGaussianSplattingCompressionSpz2 from a rapidJson::Value.
+   *
+   * @param value The value from which to read the array of instances.
+   * @return The result of reading the array of instances.
+   */
+  CesiumJsonReader::ReadJsonResult<
+      std::vector<CesiumGltf::ExtensionKhrGaussianSplattingCompressionSpz2>>
+  readArrayFromJson(const rapidjson::Value& value) const;
+
+private:
+  CesiumJsonReader::JsonReaderOptions _options;
+};
+
+} // namespace CesiumGltfReader

CesiumGltfReader/generated/include/CesiumGltfReader/ExtensionKhrGaussianSplattingHintsValueReader.h

@@ -0,0 +1,79 @@
+// This file was generated by generate-classes.
+// DO NOT EDIT THIS FILE!
+#pragma once
+
+#include <CesiumGltf/ExtensionKhrGaussianSplattingHintsValue.h>
+#include <CesiumGltfReader/Library.h>
+#include <CesiumJsonReader/JsonReader.h>
+#include <CesiumJsonReader/JsonReaderOptions.h>
+
+#include <rapidjson/fwd.h>
+
+#include <span>
+#include <vector>
+
+namespace CesiumGltf {
+struct ExtensionKhrGaussianSplattingHintsValue;
+} // namespace CesiumGltf
+
+namespace CesiumGltfReader {
+
+/**
+ * @brief Reads \ref CesiumGltf::ExtensionKhrGaussianSplattingHintsValue
+ * "ExtensionKhrGaussianSplattingHintsValue" instances from JSON.
+ */
+class CESIUMGLTFREADER_API ExtensionKhrGaussianSplattingHintsValueReader {
+public:
+  /**
+   * @brief Constructs a new instance.
+   */
+  ExtensionKhrGaussianSplattingHintsValueReader();
+
+  /**
+   * @brief Gets the options controlling how the JSON is read.
+   */
+  CesiumJsonReader::JsonReaderOptions& getOptions();
+
+  /**
+   * @brief Gets the options controlling how the JSON is read.
+   */
+  const CesiumJsonReader::JsonReaderOptions& getOptions() const;
+
+  /**
+   * @brief Reads an instance of ExtensionKhrGaussianSplattingHintsValue from a
+   * byte buffer.
+   *
+   * @param data The buffer from which to read the instance.
+   * @return The result of reading the instance.
+   */
+  CesiumJsonReader::ReadJsonResult<
+      CesiumGltf::ExtensionKhrGaussianSplattingHintsValue>
+  readFromJson(const std::span<const std::byte>& data) const;
+
+  /**
+   * @brief Reads an instance of ExtensionKhrGaussianSplattingHintsValue from a
+   * rapidJson::Value.
+   *
+   * @param value The value from which to read the instance.
+   * @return The result of reading the instance.
+   */
+  CesiumJsonReader::ReadJsonResult<
+      CesiumGltf::ExtensionKhrGaussianSplattingHintsValue>
+  readFromJson(const rapidjson::Value& value) const;
+
+  /**
+   * @brief Reads an array of instances of
+   * ExtensionKhrGaussianSplattingHintsValue from a rapidJson::Value.
+   *
+   * @param value The value from which to read the array of instances.
+   * @return The result of reading the array of instances.
+   */
+  CesiumJsonReader::ReadJsonResult<
+      std::vector<CesiumGltf::ExtensionKhrGaussianSplattingHintsValue>>
+  readArrayFromJson(const rapidjson::Value& value) const;
+
+private:
+  CesiumJsonReader::JsonReaderOptions _options;
+};
+
+} // namespace CesiumGltfReader