Merge pull request CesiumGS#1309 from CesiumGS/multiple-cesium-ions

Add support for multiple Cesium ion servers

Author: j9liu

CHANGES.md

@@ -1,5 +1,15 @@
 # Change Log
 
+### ? - ?
+
+##### Breaking Changes :mega:
+
+- Deprecated `IonAssetEndpointUrl` on `Cesium3DTileset` and `CesiumIonRasterOverlay`. Use the new `CesiumIonServer` property instead.
+
+##### Additions :tada:
+
+ - Added support for multiple Cesium ion servers by creating `CesiumIonServer` data assets.
+
 ### v2.1.0 - 2023-12-01
 
 ##### Additions :tada:

Source/CesiumEditor/Private/CesiumEditor.cpp

@@ -10,6 +10,7 @@
 #include "CesiumGlobeAnchorCustomization.h"
 #include "CesiumIonPanel.h"
 #include "CesiumIonRasterOverlay.h"
+#include "CesiumIonServer.h"
 #include "CesiumIonTokenTroubleshooting.h"
 #include "CesiumPanel.h"
 #include "CesiumRuntime.h"
@@ -268,9 +269,7 @@ void FCesiumEditorModule::StartupModule() {
 
   registerDetailCustomization();
 
-  this->_pIonSession =
-      std::make_shared<CesiumIonSession>(getAsyncSystem(), getAssetAccessor());
-  this->_pIonSession->resume();
+  this->_serverManager.Initialize();
 
   // Only register style once
   if (!StyleSet.IsValid()) {

Source/CesiumEditor/Private/CesiumEditor.h

@@ -4,6 +4,7 @@
 
 #include "CesiumEditorReparentHandler.h"
 #include "CesiumEditorSubLevelMutex.h"
+#include "CesiumIonServerManager.h"
 #include "CesiumIonSession.h"
 #include "CoreMinimal.h"
 #include "Modules/ModuleManager.h"
@@ -17,6 +18,7 @@ class UCesiumRasterOverlay;
 class UCesiumIonRasterOverlay;
 struct FCesium3DTilesetLoadFailureDetails;
 struct FCesiumRasterOverlayLoadFailureDetails;
+class UCesiumIonServer;
 
 DECLARE_LOG_CATEGORY_EXTERN(LogCesiumEditor, Log, All);
 
@@ -34,9 +36,9 @@ class FCesiumEditorModule : public IModuleInterface {
 
   static FCesiumEditorModule* get() { return _pModule; }
 
-  static CesiumIonSession& ion() {
+  static CesiumIonServerManager& serverManager() {
     assert(_pModule);
-    return *_pModule->_pIonSession;
+    return get()->_serverManager;
   }
 
   static ACesium3DTileset* FindFirstTilesetSupportingOverlays();
@@ -109,7 +111,7 @@ class FCesiumEditorModule : public IModuleInterface {
   void OnTilesetIonTroubleshooting(ACesium3DTileset* pTileset);
   void OnRasterOverlayIonTroubleshooting(UCesiumRasterOverlay* pOverlay);
 
-  std::shared_ptr<CesiumIonSession> _pIonSession;
+  CesiumIonServerManager _serverManager;
   FDelegateHandle _tilesetLoadFailureSubscription;
   FDelegateHandle _rasterOverlayLoadFailureSubscription;
   FDelegateHandle _tilesetIonTroubleshootingSubscription;

Source/CesiumEditor/Private/CesiumEditorSettings.cpp

@@ -1,7 +1,15 @@
 // Copyright 2020-2021 CesiumGS, Inc. and Contributors
 
 #include "CesiumEditorSettings.h"
+#include "CesiumSourceControl.h"
 
 UCesiumEditorSettings::UCesiumEditorSettings(
     const FObjectInitializer& ObjectInitializer)
     : Super(ObjectInitializer) {}
+
+void UCesiumEditorSettings::Save() {
+  CesiumSourceControl::PromptToCheckoutConfigFile(
+      this->GetClass()->GetConfigName());
+  this->Modify();
+  this->SaveConfig();
+}

Source/CesiumEditor/Private/CesiumEditorSettings.h

@@ -2,6 +2,7 @@
 
 #pragma once
 
+#include "CesiumIonServer.h"
 #include "CoreMinimal.h"
 #include "Engine/DeveloperSettings.h"
 #include "CesiumEditorSettings.generated.h"
@@ -14,16 +15,29 @@ class UCesiumEditorSettings : public UDeveloperSettings {
   GENERATED_UCLASS_BODY()
 
 public:
+  UPROPERTY(
+      Config,
+      meta =
+          (DeprecatedProperty,
+           DeprecationMessage = "Set UserAccessTokenMap instead."))
+  FString UserAccessToken_DEPRECATED;
+
   /**
-   * The token representing the signed-in user to Cesium ion. If this is blank
-   * or invalid, the Cesium panel will prompt you to log in to Cesium ion with
-   * OAuth2. This is set automatically by logging in with the UI; it is not
-   * usually necessary to set it directly.
+   * The Cesium ion server that is currently selected in the user interface.
    */
   UPROPERTY(
       Config,
       EditAnywhere,
       Category = "Cesium ion",
-      meta = (DisplayName = "User Access Token"))
-  FString UserAccessToken;
+      meta = (DisplayName = "Current Cesium ion Server"))
+  TSoftObjectPtr<UCesiumIonServer> CurrentCesiumIonServer;
+
+  UPROPERTY(
+      Config,
+      EditAnywhere,
+      Category = "Cesium ion",
+      meta = (DisplayName = "Token Map"))
+  TMap<TSoftObjectPtr<UCesiumIonServer>, FString> UserAccessTokenMap;
+
+  void Save();
 };

Source/CesiumEditor/Private/CesiumIonPanel.cpp

@@ -7,6 +7,8 @@
 #include "CesiumCommands.h"
 #include "CesiumEditor.h"
 #include "CesiumIonRasterOverlay.h"
+#include "CesiumIonServerSelector.h"
+#include "CesiumRuntime.h"
 #include "Editor.h"
 #include "EditorModeManager.h"
 #include "EngineUtils.h"
@@ -30,31 +32,28 @@ static FName ColumnName_Type = "Type";
 static FName ColumnName_DateAdded = "DateAdded";
 
 CesiumIonPanel::CesiumIonPanel()
-    : _connectionUpdatedDelegateHandle(),
-      _assetsUpdatedDelegateHandle(),
-      _pListView(nullptr),
+    : _pListView(nullptr),
       _assets(),
-      _pSelection(nullptr) {
-  this->_connectionUpdatedDelegateHandle =
-      FCesiumEditorModule::ion().ConnectionUpdated.AddRaw(
+      _pSelection(nullptr),
+      _pLastServer(nullptr) {
+  this->_serverChangedDelegateHandle =
+      FCesiumEditorModule::serverManager().CurrentServerChanged.AddRaw(
           this,
-          &CesiumIonPanel::Refresh);
-  this->_assetsUpdatedDelegateHandle =
-      FCesiumEditorModule::ion().AssetsUpdated.AddRaw(
-          this,
-          &CesiumIonPanel::Refresh);
+          &CesiumIonPanel::OnServerChanged);
   this->_sortColumnName = ColumnName_DateAdded;
   this->_sortMode = EColumnSortMode::Type::Descending;
+  this->OnServerChanged();
 }
 
 CesiumIonPanel::~CesiumIonPanel() {
-  FCesiumEditorModule::ion().AssetsUpdated.Remove(
-      this->_assetsUpdatedDelegateHandle);
-  FCesiumEditorModule::ion().ConnectionUpdated.Remove(
-      this->_connectionUpdatedDelegateHandle);
+  this->Subscribe(nullptr);
+  FCesiumEditorModule::serverManager().CurrentServerChanged.Remove(
+      this->_serverChangedDelegateHandle);
 }
 
 void CesiumIonPanel::Construct(const FArguments& InArgs) {
+  this->Subscribe(FCesiumEditorModule::serverManager().GetCurrentServer());
+
   // A function that returns the lambda that is used for rendering
   // the sort mode indicator of the header column: If sorting is
   // currently done based on the given name, then this will
@@ -111,6 +110,7 @@ void CesiumIonPanel::Construct(const FArguments& InArgs) {
             SVerticalBox::Slot().AutoHeight()
             [
               SNew(SHorizontalBox) +
+                SHorizontalBox::Slot().Padding(5.0f)[SNew(CesiumIonServerSelector)] +
                 // Add the refresh button at the upper left
                 SHorizontalBox::Slot().HAlign(HAlign_Left).Padding(5.0f)
                 [
@@ -123,7 +123,7 @@ void CesiumIonPanel::Construct(const FArguments& InArgs) {
                     .Text(FText::FromString(TEXT("Refresh")))
                     .ToolTipText(FText::FromString(TEXT("Refresh the asset list")))
                     .OnClicked_Lambda([this]() {
-                      FCesiumEditorModule::ion().refreshAssets();
+                      FCesiumEditorModule::serverManager().GetCurrentSession()->refreshAssets();
                       Refresh();
                       return FReply::Handled();
                     })
@@ -156,7 +156,7 @@ void CesiumIonPanel::Construct(const FArguments& InArgs) {
         ];
   // clang-format on
 
-  FCesiumEditorModule::ion().refreshAssets();
+  FCesiumEditorModule::serverManager().GetCurrentSession()->refreshAssets();
 }
 
 void CesiumIonPanel::OnSortChange(
@@ -402,7 +402,11 @@ void CesiumIonPanel::ApplySorting() {
 }
 
 void CesiumIonPanel::Refresh() {
-  const Assets& assets = FCesiumEditorModule::ion().getAssets();
+  if (!this->_pListView)
+    return;
+
+  const Assets& assets =
+      FCesiumEditorModule::serverManager().GetCurrentSession()->getAssets();
 
   this->_assets.SetNum(assets.items.size());
 
@@ -418,7 +422,7 @@ void CesiumIonPanel::Tick(
     const FGeometry& AllottedGeometry,
     const double InCurrentTime,
     const float InDeltaTime) {
-  FCesiumEditorModule::ion().getAsyncSystem().dispatchMainThreadTasks();
+  getAsyncSystem().dispatchMainThreadTasks();
   SCompoundWidget::Tick(AllottedGeometry, InCurrentTime, InDeltaTime);
 }
 
@@ -428,6 +432,33 @@ void CesiumIonPanel::AssetSelected(
   this->_pSelection = item;
 }
 
+void CesiumIonPanel::Subscribe(UCesiumIonServer* pNewServer) {
+  if (this->_pLastServer) {
+    std::shared_ptr<CesiumIonSession> pLastSession =
+        FCesiumEditorModule::serverManager().GetSession(this->_pLastServer);
+    if (pLastSession) {
+      pLastSession->ConnectionUpdated.RemoveAll(this);
+      pLastSession->AssetsUpdated.RemoveAll(this);
+    }
+  }
+
+  this->_pLastServer = pNewServer;
+
+  if (pNewServer) {
+    std::shared_ptr<CesiumIonSession> pSession =
+        FCesiumEditorModule::serverManager().GetSession(pNewServer);
+    pSession->ConnectionUpdated.AddRaw(this, &CesiumIonPanel::Refresh);
+    pSession->AssetsUpdated.AddRaw(this, &CesiumIonPanel::Refresh);
+  }
+}
+
+void CesiumIonPanel::OnServerChanged() {
+  UCesiumIonServer* pNewServer =
+      FCesiumEditorModule::serverManager().GetCurrentServer();
+  this->Subscribe(pNewServer);
+  this->Refresh();
+}
+
 void CesiumIonPanel::AddAsset(TSharedPtr<CesiumIonClient::Asset> item) {
 
   if (isSupportedImagery(item)) {
@@ -445,7 +476,9 @@ void CesiumIonPanel::AddAsset(TSharedPtr<CesiumIonClient::Asset> item) {
 }
 
 void CesiumIonPanel::AddAssetToLevel(TSharedPtr<CesiumIonClient::Asset> item) {
-  SelectCesiumIonToken::SelectAndAuthorizeToken({item->id})
+  SelectCesiumIonToken::SelectAndAuthorizeToken(
+      FCesiumEditorModule::serverManager().GetCurrentServer(),
+      {item->id})
       .thenInMainThread([item](const std::optional<Token>& /*maybeToken*/) {
         // If token selection was canceled, or if an error occurred while
         // selecting the token, ignore it and create the tileset anyway. It's
@@ -462,7 +495,9 @@ void CesiumIonPanel::AddAssetToLevel(TSharedPtr<CesiumIonClient::Asset> item) {
 void CesiumIonPanel::AddOverlayToTerrain(
     TSharedPtr<CesiumIonClient::Asset> item,
     bool useAsBaseLayer) {
-  SelectCesiumIonToken::SelectAndAuthorizeToken({item->id})
+  SelectCesiumIonToken::SelectAndAuthorizeToken(
+      FCesiumEditorModule::serverManager().GetCurrentServer(),
+      {item->id})
       .thenInMainThread([useAsBaseLayer, item](const std::optional<Token>&) {
         UWorld* pCurrentWorld = GEditor->GetEditorWorldContext().World();
         ULevel* pCurrentLevel = pCurrentWorld->GetCurrentLevel();

Source/CesiumEditor/Private/CesiumIonPanel.h

@@ -11,6 +11,7 @@
 class FArguments;
 class ITableRow;
 class STableViewBase;
+class UCesiumIonServer;
 
 template <typename ItemType> class SListView;
 
@@ -43,6 +44,8 @@ class CesiumIonPanel : public SCompoundWidget {
   void AssetSelected(
       TSharedPtr<CesiumIonClient::Asset> item,
       ESelectInfo::Type selectionType);
+  void Subscribe(UCesiumIonServer* pNewServer);
+  void OnServerChanged();
 
   /**
    * Filter the current _assets array, based on the current _searchString.
@@ -73,11 +76,11 @@ class CesiumIonPanel : public SCompoundWidget {
    */
   void OnSearchTextChange(const FText& SearchText);
 
-  FDelegateHandle _connectionUpdatedDelegateHandle;
-  FDelegateHandle _assetsUpdatedDelegateHandle;
+  FDelegateHandle _serverChangedDelegateHandle;
   TSharedPtr<SListView<TSharedPtr<CesiumIonClient::Asset>>> _pListView;
   TArray<TSharedPtr<CesiumIonClient::Asset>> _assets;
   TSharedPtr<CesiumIonClient::Asset> _pSelection;
+  TObjectPtr<UCesiumIonServer> _pLastServer;
 
   /**
    * The column name based on which the main assets list view is currently

Source/CesiumEditor/Private/CesiumIonServerDisplay.cpp

@@ -0,0 +1,43 @@
+// Copyright 2020-2023 CesiumGS, Inc. and Contributors
+
+#include "CesiumIonServerDisplay.h"
+#include "CesiumEditor.h"
+#include "CesiumIonServer.h"
+#include "Editor.h"
+#include "PropertyCustomizationHelpers.h"
+#include "Widgets/Input/SEditableTextBox.h"
+
+void CesiumIonServerDisplay::Construct(const FArguments& InArgs) {
+  UCesiumIonServer* pServer = InArgs._Server;
+
+  ChildSlot
+      [SNew(SHorizontalBox) +
+       SHorizontalBox::Slot()
+           .AutoWidth()
+           .VAlign(EVerticalAlignment::VAlign_Center)
+           .Padding(5.0f)[SNew(STextBlock)
+                              .Text(FText::FromString("Cesium ion Server:"))] +
+       SHorizontalBox::Slot()
+           .AutoWidth()
+           .VAlign(EVerticalAlignment::VAlign_Center)
+           .Padding(5.0f)[SNew(SEditableTextBox)
+                              .IsEnabled(false)
+                              .Padding(5.0f)
+                              .Text(FText::FromString(pServer->DisplayName))] +
+       SHorizontalBox::Slot()
+           .AutoWidth()
+           .VAlign(EVerticalAlignment::VAlign_Center)
+           .Padding(5.0f)[PropertyCustomizationHelpers::MakeBrowseButton(
+               FSimpleDelegate::
+                   CreateSP(this, &CesiumIonServerDisplay::OnBrowseForServer),
+               FText::FromString(
+                   "Show this Cesium ion Server in the Content Browser."),
+               true,
+               false)]];
+}
+
+void CesiumIonServerDisplay::OnBrowseForServer() {
+  TArray<UObject*> Objects;
+  Objects.Add(FCesiumEditorModule::serverManager().GetCurrentServer());
+  GEditor->SyncBrowserToObjects(Objects);
+}

Source/CesiumEditor/Private/CesiumIonServerDisplay.h

@@ -0,0 +1,19 @@
+// Copyright 2020-2023 CesiumGS, Inc. and Contributors
+
+#pragma once
+
+#include "Widgets/SCompoundWidget.h"
+
+class FArguments;
+class UCesiumIonServer;
+
+class CesiumIonServerDisplay : public SCompoundWidget {
+  SLATE_BEGIN_ARGS(CesiumIonServerDisplay) {}
+  SLATE_ARGUMENT(UCesiumIonServer*, Server)
+  SLATE_END_ARGS()
+
+  void Construct(const FArguments& InArgs);
+
+private:
+  void OnBrowseForServer();
+};