Refresh when server property changes, fill API URL.

Author: kring

Source/CesiumEditor/Private/CesiumIonServerManager.cpp

@@ -2,12 +2,16 @@
 
 #include "CesiumIonServerManager.h"
 #include "AssetRegistry/AssetRegistryModule.h"
+#include "Cesium3DTileset.h"
 #include "CesiumEditorSettings.h"
+#include "CesiumIonRasterOverlay.h"
 #include "CesiumIonServer.h"
 #include "CesiumIonSession.h"
 #include "CesiumRuntime.h"
 #include "CesiumRuntimeSettings.h"
 #include "CesiumSourceControl.h"
+#include "Editor.h"
+#include "EngineUtils.h"
 #include "FileHelpers.h"
 
 CesiumIonServerManager::CesiumIonServerManager() noexcept {
@@ -19,6 +23,9 @@ CesiumIonServerManager::CesiumIonServerManager() noexcept {
   AssetRegistryModule.GetRegistry().OnAssetRemoved().AddRaw(
       this,
       &CesiumIonServerManager::OnAssetRemoved);
+  AssetRegistryModule.GetRegistry().OnAssetUpdated().AddRaw(
+      this,
+      &CesiumIonServerManager::OnAssetUpdated);
 }
 
 CesiumIonServerManager::~CesiumIonServerManager() noexcept {
@@ -27,6 +34,7 @@ CesiumIonServerManager::~CesiumIonServerManager() noexcept {
   if (pAssetRegistryModule) {
     pAssetRegistryModule->GetRegistry().OnAssetAdded().RemoveAll(this);
     pAssetRegistryModule->GetRegistry().OnAssetRemoved().RemoveAll(this);
+    pAssetRegistryModule->GetRegistry().OnAssetUpdated().RemoveAll(this);
   }
 }
 
@@ -194,3 +202,36 @@ void CesiumIonServerManager::OnAssetRemoved(const FAssetData& asset) {
     }
   }
 }
+
+void CesiumIonServerManager::OnAssetUpdated(const FAssetData& asset) {
+  if (!GEditor)
+    return;
+
+  if (asset.AssetClassPath !=
+      UCesiumIonServer::StaticClass()->GetClassPathName())
+    return;
+
+  // When a Cesium ion Server definition changes, refresh any objects that use
+  // it.
+  UCesiumIonServer* pServer = Cast<UCesiumIonServer>(asset.GetAsset());
+  if (!pServer)
+    return;
+
+  UWorld* pCurrentWorld = GEditor->GetEditorWorldContext().World();
+  if (!pCurrentWorld)
+    return;
+
+  for (TActorIterator<ACesium3DTileset> it(pCurrentWorld); it; ++it) {
+    if (it->GetCesiumIonServer() == pServer) {
+      it->RefreshTileset();
+    } else {
+      TArray<UCesiumIonRasterOverlay*> rasterOverlays;
+      it->GetComponents<UCesiumIonRasterOverlay>(rasterOverlays);
+
+      for (UCesiumIonRasterOverlay* pOverlay : rasterOverlays) {
+        if (pOverlay->CesiumIonServer == pServer)
+          pOverlay->Refresh();
+      }
+    }
+  }
+}

Source/CesiumEditor/Private/CesiumIonServerManager.h

@@ -33,6 +33,7 @@ class CESIUMEDITOR_API CesiumIonServerManager {
 private:
   void OnAssetAdded(const FAssetData& asset);
   void OnAssetRemoved(const FAssetData& asset);
+  void OnAssetUpdated(const FAssetData& asset);
 
   struct ServerSession {
     TWeakObjectPtr<UCesiumIonServer> Server;

Source/CesiumEditor/Private/CesiumIonSession.cpp

@@ -7,6 +7,7 @@
 #include "CesiumRuntimeSettings.h"
 #include "CesiumSourceControl.h"
 #include "CesiumUtility/Uri.h"
+#include "FileHelpers.h"
 #include "HAL/PlatformProcess.h"
 #include "Misc/App.h"
 
@@ -121,6 +122,9 @@ void CesiumIonSession::connect() {
         if (pServer->ApiUrl.IsEmpty()) {
           pServer->ApiUrl = UTF8_TO_TCHAR(ionApiUrl->c_str());
           pServer->Modify();
+          UEditorLoadingAndSavingUtils::SavePackages(
+              {pServer->GetPackage()},
+              true);
         }
 
         int64_t clientID = pServer->OAuth2ApplicationID;

Source/CesiumRuntime/Private/Cesium3DTileset.cpp

@@ -1152,19 +1152,25 @@ void ACesium3DTileset::LoadTileset() {
                         ? this->CesiumIonServer->DefaultIonAccessToken
                         : this->IonAccessToken;
 
+#if WITH_EDITOR
+    this->CesiumIonServer->ResolveApiUrl();
+#endif
+
     std::string ionAssetEndpointUrl =
         TCHAR_TO_UTF8(*this->CesiumIonServer->ApiUrl);
 
-    // Make sure the URL ends with a slash
-    if (!ionAssetEndpointUrl.empty() && *ionAssetEndpointUrl.rbegin() != '/')
-      ionAssetEndpointUrl += '/';
+    if (!ionAssetEndpointUrl.empty()) {
+      // Make sure the URL ends with a slash
+      if (!ionAssetEndpointUrl.empty() && *ionAssetEndpointUrl.rbegin() != '/')
+        ionAssetEndpointUrl += '/';
 
-    this->_pTileset = MakeUnique<Cesium3DTilesSelection::Tileset>(
-        externals,
-        static_cast<uint32_t>(this->IonAssetID),
-        TCHAR_TO_UTF8(*token),
-        options,
-        ionAssetEndpointUrl);
+      this->_pTileset = MakeUnique<Cesium3DTilesSelection::Tileset>(
+          externals,
+          static_cast<uint32_t>(this->IonAssetID),
+          TCHAR_TO_UTF8(*token),
+          options,
+          ionAssetEndpointUrl);
+    }
     break;
   }
 

Source/CesiumRuntime/Private/CesiumIonRasterOverlay.cpp

@@ -34,9 +34,16 @@ UCesiumIonRasterOverlay::CreateOverlay(
                       ? this->CesiumIonServer->DefaultIonAccessToken
                       : this->IonAccessToken;
 
+#if WITH_EDITOR
+  this->CesiumIonServer->ResolveApiUrl();
+#endif
+
   // Make sure the URL ends with a slash
   std::string apiUrl = TCHAR_TO_UTF8(*this->CesiumIonServer->ApiUrl);
-  if (!apiUrl.empty() && *apiUrl.rbegin() != '/')
+  if (apiUrl.empty())
+    return nullptr;
+
+  if (*apiUrl.rbegin() != '/')
     apiUrl += '/';
 
   return std::make_unique<CesiumRasterOverlays::IonRasterOverlay>(

Source/CesiumRuntime/Private/CesiumIonServer.cpp

@@ -1,12 +1,16 @@
 // Copyright 2020-2023 CesiumGS, Inc. and Contributors
 
 #include "CesiumIonServer.h"
+#include "CesiumAsync/AsyncSystem.h"
+#include "CesiumIonClient/Connection.h"
+#include "CesiumRuntime.h"
 #include "CesiumRuntimeSettings.h"
 #include "UObject/Package.h"
 #include "UObject/UObjectGlobals.h"
 
 #if WITH_EDITOR
 #include "AssetRegistry/AssetRegistryModule.h"
+#include "CesiumIonClient/Connection.h"
 #include "Factories/DataAssetFactory.h"
 #include "FileHelpers.h"
 #endif
@@ -142,4 +146,34 @@ UCesiumIonServer::GetBackwardCompatibleServer(const FString& apiUrl) {
 
   return Server;
 }
+
+CesiumAsync::Future<void> UCesiumIonServer::ResolveApiUrl() {
+  if (!this->ApiUrl.IsEmpty())
+    return getAsyncSystem().createResolvedFuture();
+
+  if (this->ServerUrl.IsEmpty()) {
+    // We don't even have a server URL, so use the SaaS defaults.
+    this->ServerUrl = TEXT("https://ion.cesium.com/");
+    this->ApiUrl = TEXT("https://api.cesium.com/");
+    this->Modify();
+    UEditorLoadingAndSavingUtils::SavePackages({this->GetPackage()}, true);
+    return getAsyncSystem().createResolvedFuture();
+  }
+
+  TObjectPtr<UCesiumIonServer> pServer = this;
+
+  return CesiumIonClient::Connection::getApiUrl(
+             getAsyncSystem(),
+             getAssetAccessor(),
+             TCHAR_TO_UTF8(*this->ServerUrl))
+      .thenInMainThread([pServer](std::optional<std::string>&& apiUrl) {
+        if (pServer && pServer->ApiUrl.IsEmpty()) {
+          pServer->ApiUrl = UTF8_TO_TCHAR(apiUrl->c_str());
+          pServer->Modify();
+          UEditorLoadingAndSavingUtils::SavePackages(
+              {pServer->GetPackage()},
+              true);
+        }
+      });
+}
 #endif

Source/CesiumRuntime/Public/CesiumIonServer.h

@@ -6,6 +6,10 @@
 #include "UObject/Object.h"
 #include "CesiumIonServer.generated.h"
 
+namespace CesiumAsync {
+template <typename T> class Future;
+}
+
 /**
  * Defines a Cesium ion Server. This may be the public (SaaS) Cesium ion server
  * at ion.cesium.com, or it may be a self-hosted instance.
@@ -65,6 +69,7 @@ class CESIUMRUNTIME_API UCesiumIonServer : public UDataAsset {
    */
   UPROPERTY(
       EditAnywhere,
+      AssetRegistrySearchable,
       Category = "Cesium",
       meta = (DisplayName = "Server URL"))
   FString ServerUrl = "https://ion.cesium.com";
@@ -74,7 +79,11 @@ class CESIUMRUNTIME_API UCesiumIonServer : public UDataAsset {
    * the default, public Cesium ion server, this is `https://api.cesium.com`. If
    * left blank, the API URL is automatically inferred from the Server URL.
    */
-  UPROPERTY(EditAnywhere, Category = "Cesium", meta = (DisplayName = "API URL"))
+  UPROPERTY(
+      EditAnywhere,
+      AssetRegistrySearchable,
+      Category = "Cesium",
+      meta = (DisplayName = "API URL"))
   FString ApiUrl = "https://api.cesium.com";
 
   /**
@@ -84,6 +93,7 @@ class CESIUMRUNTIME_API UCesiumIonServer : public UDataAsset {
    */
   UPROPERTY(
       EditAnywhere,
+      AssetRegistrySearchable,
       Category = "Cesium",
       meta = (DisplayName = "OAuth Application ID"))
   int64 OAuth2ApplicationID = 190;
@@ -106,10 +116,20 @@ class CESIUMRUNTIME_API UCesiumIonServer : public UDataAsset {
    */
   UPROPERTY(
       EditAnywhere,
+      AssetRegistrySearchable,
       Category = "Cesium",
       meta = (DisplayName = "Default Cesium ion Access Token"))
   FString DefaultIonAccessToken;
 
+#if WITH_EDITOR
+  /**
+   * If the `ApiUrl` property is blank, this method asynchronously resolves it
+   * by consulting with the `ServerUrl`. If the `ApiUrl` is not blank, this
+   * method returns an already-resolved future.
+   */
+  CesiumAsync::Future<void> ResolveApiUrl();
+#endif
+
 private:
   static UCesiumIonServer* _pDefaultForNewObjects;
 };