Merge pull request #567 from CesiumGS/fix-play-mode-credits

Fix credits not appearing in Play Mode

Author: kring

CHANGES.md

@@ -6,6 +6,10 @@
 
 - Added `CesiumUrlTemplateRasterOverlay` component, allowing a raster overlay to be added using tiles requested based on a specified URL template.
 
+##### Fixes :wrench:
+
+- Fixed a bug where credits would not display in the Game tab after entering Play Mode.
+
 ## v1.15.5 - 2025-04-01
 
 ##### Fixes :wrench:

Editor/CesiumCreditSystemManager.cs

@@ -0,0 +1,64 @@
+using UnityEditor;
+using UnityEditor.SceneManagement;
+using UnityEngine;
+using UnityEngine.SceneManagement;
+
+namespace CesiumForUnity
+{
+    [InitializeOnLoad]
+    public static class CesiumCreditSystemManager
+    {
+        static CesiumCreditSystemManager()
+        {
+            EditorApplication.playModeStateChanged += HandleEnteringPlayMode;
+            EditorSceneManager.sceneClosing += HandleClosingScene;
+        }
+
+        /// <summary>
+        /// This handles the destruction of the default credit system between scene switches in the 
+        /// Unity Editor.
+        /// Without this, the credit system will live between instances and fail to capture the current 
+        /// scene's credits.
+        /// </summary>
+        /// <param name="scene">The scene.</param>
+        /// <param name="removingScene">Whether the scene is being removed.</param>
+        private static void HandleClosingScene(Scene scene, bool removingScene)
+        {
+            Destroy(CesiumCreditSystem.GetDefaultCreditSystem());
+        }
+
+        /// <summary>   
+        /// This handles the destruction of the default credit system while entering Play Mode.
+        /// Without this, the persisting credit system's UI will not register with the Play Mode view, leading
+        /// to missing credits.
+        /// </summary>
+        /// <param name="state">The state change between the Edit and Play modes.</param>
+        private static void HandleEnteringPlayMode(PlayModeStateChange state)
+        {
+            if (state == PlayModeStateChange.EnteredPlayMode)
+            {
+                Destroy(CesiumCreditSystem.GetDefaultCreditSystem());
+            }
+        }
+
+        /// <summary>
+        /// Destroys the input credit system depending on the current Editor context. This is the same as
+        /// the internal UnityLifetime class (which is currently inaccessible from Editor classes).
+        /// </summary>
+        /// <param name="creditSystem">The credit system.</param>
+        private static void Destroy(CesiumCreditSystem creditSystem)
+        {
+            if (creditSystem == null) { return; }
+
+            // In the Editor, we must use DestroyImmediate because Destroy won't
+            // actually destroy the object.
+            if (!EditorApplication.isPlaying)
+            {
+                Object.DestroyImmediate(creditSystem.gameObject);
+                return;
+            }
+
+            Object.Destroy(creditSystem.gameObject);
+        }
+    }
+}

Editor/CesiumCreditSystemManager.cs.meta

@@ -8,6 +8,7 @@
 
 #if UNITY_EDITOR
 using UnityEditor.SceneManagement;
+using UnityEditor;
 #endif
 
 namespace CesiumForUnity
@@ -102,8 +103,8 @@ public partial class CesiumCreditSystem : MonoBehaviour
         private int _numLoadingImages = 0;
 
         const string base64Prefix = "data:image/png;base64,";
-        const string defaultName = "CesiumCreditSystemDefault";
         const string creditSystemPrefabName = "CesiumCreditSystem";
+        const string defaultName = "CesiumCreditSystemDefault";
 
         #region Fields and Events
         /// <summary>
@@ -159,9 +160,6 @@ private void OnEnable()
             this._images = new List<Texture2D>();
 
             Cesium3DTileset.OnSetShowCreditsOnScreen += this.ForceUpdateCredits;
-#if UNITY_EDITOR
-            EditorSceneManager.sceneClosing += HandleClosingSceneView;
-#endif
         }
 
         private void Update()
@@ -183,7 +181,7 @@ private void OnDestroy()
 
             this._images.Clear();
 
-            if (_defaultCreditSystem == this)
+            if (this == _defaultCreditSystem)
             {
                 _defaultCreditSystem = null;
             }
@@ -246,7 +244,7 @@ private static CesiumCreditSystem CreateDefaultCreditSystem()
         /// Gets the default credit system, or creates a new default credit system instance if none exist.
         /// </summary>
         /// <returns>The default CesiumCreditSystem instance.</returns>
-        internal static CesiumCreditSystem GetDefaultCreditSystem()
+        public static CesiumCreditSystem GetDefaultCreditSystem()
         {
             if (_defaultCreditSystem == null)
             {
@@ -321,23 +319,5 @@ internal IEnumerator LoadImage(string url)
 
             texture.wrapMode = TextureWrapMode.Clamp;
         }
-
-
-#if UNITY_EDITOR
-        /// <summary>
-        /// This handles the destruction of the credit system between scene switches in the Unity Editor.
-        /// Without this, the credit system will live between instances and won't properly render the 
-        /// current scene's credits.
-        /// </summary>
-        /// <param name="scene">The scene.</param>
-        /// <param name="removingScene">Whether or not the closing scene is also being removed.</param>
-        private static void HandleClosingSceneView(Scene scene, bool removingScene)
-        {
-            if (_defaultCreditSystem != null && _defaultCreditSystem.gameObject.scene == scene)
-            {
-                UnityLifetime.Destroy(_defaultCreditSystem.gameObject);
-            }
-        }
-#endif
     }
 }

Runtime/CesiumCreditSystem.cs

@@ -133,9 +133,12 @@ void Cesium3DTilesetImpl::Update(
   std::vector<ViewState> viewStates =
       CameraManager::getAllCameras(tileset, *this);
 
-  const ViewUpdateResult& updateResult = this->_pTileset->updateView(
+  const ViewUpdateResult& updateResult = this->_pTileset->updateViewGroup(
+      this->_pTileset->getDefaultViewGroup(),
       viewStates,
       DotNet::UnityEngine::Time::deltaTime());
+  this->_pTileset->loadTiles();
+
   this->updateLastViewUpdateResultState(tileset, updateResult);
 
   for (auto pTile : updateResult.tilesFadingOut) {

native~/Runtime/src/Cesium3DTilesetImpl.cpp

@@ -51,12 +51,14 @@ void CesiumCreditSystemImpl::UpdateCredits(
     this->_creditsUpdated = false;
   }
 
+  const CesiumUtility::CreditsSnapshot& credits = _pCreditSystem->getSnapshot();
   const std::vector<CesiumUtility::Credit>& creditsToShowThisFrame =
-      this->_pCreditSystem->getCreditsToShowThisFrame();
+      credits.currentCredits;
+
   size_t creditsCount = creditsToShowThisFrame.size();
-  this->_creditsUpdated =
-      forceUpdate || creditsCount != this->_lastCreditsCount ||
-      this->_pCreditSystem->getCreditsToNoLongerShowThisFrame().size() > 0;
+  this->_creditsUpdated = forceUpdate ||
+                          creditsToShowThisFrame.size() != _lastCreditsCount ||
+                          credits.removedCredits.size() > 0;
 
   if (this->_creditsUpdated) {
     List1<CesiumForUnity::CesiumCredit> popupCredits =
@@ -95,8 +97,6 @@ void CesiumCreditSystemImpl::UpdateCredits(
     this->_creditsUpdated = true;
     this->_lastCreditsCount = creditsCount;
   }
-
-  this->_pCreditSystem->startNextFrame();
 }
 
 namespace {