Move GltfModifier version to an extension.

Author: kring

Cesium3DTilesSelection/include/Cesium3DTilesSelection/GltfModifierVersionExtension.h

@@ -0,0 +1,55 @@
+#pragma once
+
+#include <Cesium3DTilesSelection/Library.h>
+#include <CesiumUtility/ExtensibleObject.h>
+
+#include <optional>
+
+namespace CesiumGltf {
+struct Model;
+}
+
+namespace Cesium3DTilesSelection {
+
+/** @brief An extension holding the "version" of a glTF produced by
+ * {@link GltfModifier}.
+ */
+struct CESIUM3DTILESSELECTION_API GltfModifierVersionExtension
+    : public CesiumUtility::ExtensibleObject {
+  static std::optional<int32_t>
+  getVersion(const CesiumGltf::Model& model) noexcept;
+
+  static void setVersion(CesiumGltf::Model& model, int32_t version) noexcept;
+
+  /**
+   * @brief The original name of this type.
+   */
+  static constexpr const char* TypeName = "GltfModifierVersionExtension";
+  /**
+   * @brief The official name of the extension. This should be the same as its
+   * key in the `extensions` object.
+   * */
+  static constexpr const char* ExtensionName =
+      "CESIUM_INTERNAL_gltf_modifier_version";
+
+  /**
+   * @brief The current {@link GltfModifier} version number of the model.
+   */
+  int32_t version = 0;
+
+  /**
+   * @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(GltfModifierVersionExtension));
+    accum += CesiumUtility::ExtensibleObject::getSizeBytes() -
+             int64_t(sizeof(CesiumUtility::ExtensibleObject));
+    return accum;
+  }
+};
+
+} // namespace Cesium3DTilesSelection

Cesium3DTilesSelection/src/GltfModifierVersionExtension.cpp

@@ -0,0 +1,22 @@
+#include <Cesium3DTilesSelection/GltfModifierVersionExtension.h>
+#include <CesiumGltf/Model.h>
+
+namespace Cesium3DTilesSelection {
+
+/* static */ std::optional<int32_t> GltfModifierVersionExtension::getVersion(
+    const CesiumGltf::Model& model) noexcept {
+  const auto* pExtension = model.getExtension<GltfModifierVersionExtension>();
+  return pExtension ? std::make_optional(pExtension->version) : std::nullopt;
+}
+
+/* static */ void GltfModifierVersionExtension::setVersion(
+    CesiumGltf::Model& model,
+    int32_t version) noexcept {
+  auto* pExtension = model.getExtension<GltfModifierVersionExtension>();
+  if (!pExtension) {
+    pExtension = &model.addExtension<GltfModifierVersionExtension>();
+  }
+  pExtension->version = version;
+}
+
+} // namespace Cesium3DTilesSelection

Cesium3DTilesSelection/src/Tile.cpp

@@ -1,6 +1,7 @@
 #include "TilesetContentManager.h"
 
 #include <Cesium3DTilesSelection/GltfModifier.h>
+#include <Cesium3DTilesSelection/GltfModifierVersionExtension.h>
 #include <Cesium3DTilesSelection/RasterMappedTo3DTile.h>
 #include <Cesium3DTilesSelection/Tile.h>
 #include <Cesium3DTilesSelection/TileContent.h>
@@ -285,10 +286,13 @@ bool Tile::needsWorkerThreadLoading(
       // finishLoading hasn't yet been called
       const std::optional<CesiumGltf::Model>& maybeModifiedModel =
           renderContent->getModifiedModel();
-      std::optional<int> latestVersion =
-          maybeModifiedModel ? maybeModifiedModel->version : std::nullopt;
+      std::optional<int32_t> latestVersion =
+          maybeModifiedModel
+              ? GltfModifierVersionExtension::getVersion(*maybeModifiedModel)
+              : std::nullopt;
       if (!latestVersion)
-        latestVersion = renderContent->getModel().version;
+        latestVersion =
+            GltfModifierVersionExtension::getVersion(renderContent->getModel());
       if (!latestVersion || latestVersion != modelVersion)
         return true;
     }

Cesium3DTilesSelection/src/TilesetContentManager.cpp

@@ -7,6 +7,7 @@
 
 #include <Cesium3DTilesSelection/BoundingVolume.h>
 #include <Cesium3DTilesSelection/GltfModifier.h>
+#include <Cesium3DTilesSelection/GltfModifierVersionExtension.h>
 #include <Cesium3DTilesSelection/IPrepareRendererResources.h>
 #include <Cesium3DTilesSelection/RasterMappedTo3DTile.h>
 #include <Cesium3DTilesSelection/RasterOverlayCollection.h>
@@ -1214,7 +1215,7 @@ void TilesetContentManager::loadTileContent(
     TileRenderContent* pRenderContent = tile.getContent().getRenderContent();
     if (pRenderContent &&
         pRenderContent->getGltfModifierState() == GltfModifier::State::Idle &&
-        pRenderContent->getModel().version !=
+        GltfModifierVersionExtension::getVersion(pRenderContent->getModel()) !=
             _externals.pGltfModifier->getCurrentVersion()) {
       this->reapplyGltfModifier(tile, tilesetOptions, pRenderContent);
       return;
@@ -1361,7 +1362,8 @@ void TilesetContentManager::loadTileContent(
               pTile->getContent().getRenderContent();
           CESIUM_ASSERT(!pRenderContent || !pRenderContent->getModifiedModel());
           if (pRenderContent &&
-              pRenderContent->getModel().version !=
+              GltfModifierVersionExtension::getVersion(
+                  pRenderContent->getModel()) !=
                   thiz->_externals.pGltfModifier->getCurrentVersion()) {
             thiz->_externals.pGltfModifier->onOldVersionContentLoadingComplete(
                 *pTile);
@@ -1634,7 +1636,8 @@ bool TilesetContentManager::discardOutdatedRenderResources(
       renderContent.getModifiedModel();
   const CesiumGltf::Model& model =
       maybeModifiedModel ? *maybeModifiedModel : renderContent.getModel();
-  if (model.version != _externals.pGltfModifier->getCurrentVersion()) {
+  if (GltfModifierVersionExtension::getVersion(model) !=
+      _externals.pGltfModifier->getCurrentVersion()) {
     _externals.pPrepareRendererResources->free(
         tile,
         maybeModifiedModel ? renderContent.getModifiedRenderResources()

Cesium3DTilesSelection/test/TestTilesetContentManager.cpp

@@ -4,6 +4,7 @@
 #include "TilesetJsonLoader.h"
 
 #include <Cesium3DTilesContent/registerAllTileContentTypes.h>
+#include <Cesium3DTilesSelection/GltfModifierVersionExtension.h>
 #include <Cesium3DTilesSelection/RasterOverlayCollection.h>
 #include <Cesium3DTilesSelection/Tile.h>
 #include <Cesium3DTilesSelection/TileLoadResult.h>
@@ -1879,7 +1880,9 @@ TEST_CASE("Test glTF modifier state machine") {
     apply(GltfModifierInput&& input) override {
       ++applyCallCount;
       GltfModifierOutput output{.modifiedModel = input.previousModel};
-      output.modifiedModel.version = getCurrentVersion();
+      GltfModifierVersionExtension::setVersion(
+          output.modifiedModel,
+          *getCurrentVersion());
       return input.asyncSystem.createResolvedFuture(
           std::make_optional(std::move(output)));
     }

CesiumGltf/include/CesiumGltf/Model.h

@@ -12,11 +12,6 @@ namespace CesiumGltf {
 
 /** @copydoc ModelSpec */
 struct CESIUMGLTF_API Model : public ModelSpec {
-
-  /** An optional version number for the model. This can be used by clients to
-   * indicate state about the model.*/
-  std::optional<int> version = std::nullopt;
-
   Model() = default;
 
   /**