Merge branch 'CesiumGS:main' into ue5-main

Author: stephLVCim

Diff for: CHANGES.md

@@ -1,5 +1,35 @@
 # Change Log
 
+### v2.2.0 - 2023-12-14
+
+##### 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.
+
+In addition to the above, this release updates [cesium-native](https://github.com/CesiumGS/cesium-native) from v0.30.0 to v0.31.0. See the [changelog](https://github.com/CesiumGS/cesium-native/blob/main/CHANGES.md) for a complete list of changes in cesium-native.
+
+### v2.1.0 - 2023-12-01
+
+##### Additions :tada:
+
+ - Added support for styling with property textures in `EXT_structural_metadata`.
+ - Significantly improved tile download performance by adding `HttpThreadActiveFrameTimeInSeconds=0.001` to `Engine.ini`. This results in a major performance improvement for all tilesets, particularly Google Photorealistic 3D Tiles.
+- Added `HttpMaxConnectionsPerServer=40` to `Engine.ini`. By default, only 16 connections are allowed, which limits the performance when downloading tiles.
+
+##### Fixes :wrench:
+
+- Fixed a bug in the "Select New Token" dialog that caused an error when trying to create a new token without being connected.
+- Fixed a bug where an `EditConditio`n was not parsed correctly and caused Output Log window errors.
+- Removed query parameters from filepaths if present, as they are no longer ignored by Unreal. This fixes a bug where the URL would not load correctly in some cases.
+- Fixed a Tile Excluder bug that computed incorrect tile bounds, making tiles invisible when moving the tileset in the sample scene.
+- Fixed a bug where viewports could appear wider than configured in the Dynamic Pawn's Camera Field of View. Noticed in Unreal Engine v5.3 when in Play-In-Editor mode, or a packaged game. In extreme cases, tiles would be missing near the edges of the view.
+
+In addition to the above, this release updates [cesium-native](https://github.com/CesiumGS/cesium-native) from v0.29.0 to v0.30.0. See the [changelog](https://github.com/CesiumGS/cesium-native/blob/main/CHANGES.md) for a complete list of changes in cesium-native.
+
 ### v2.0.0 - 2023-11-01
 
 This release no longer supports Unreal Engine v5.0. Unreal Engine v5.1, v5.2, or v5.3 is required.

Diff for: CesiumForUnreal.uplugin

@@ -1,7 +1,7 @@
 {
 	"FileVersion": 3,
-	"Version": 53,
-	"VersionName": "2.0.0",
+	"Version": 55,
+	"VersionName": "2.2.0",
 	"FriendlyName": "Cesium for Unreal",
 	"Description": "Unlock the 3D geospatial ecosystem in Unreal Engine with real-world 3D content and a high accuracy full-scale WGS84 globe.",
 	"Category": "Geospatial",

Diff for: Config/Engine.ini

@@ -5,6 +5,20 @@
 [HTTP.HttpThread]
 RunningThreadedRequestLimit=100
 
+# Set HttpThreadActiveFrameTimeInSeconds - Network download speed is very sensitive to this value
+# Maps to the sleep time (ms) between every loop of our libcurl processing thread
+# The value of 0.001 (or 1 ms) has the same performance as 0, yet still reserves some time for idle
+#
+# Set HttpMaxConnectionsPerServer - maps to libcurl's CURLMOPT_MAX_HOST_CONNECTIONS
+# Unreal defaults to 16, but this is lower than a typical value for MaximumSimultaneousTileLoads
+# Use a number just past the highest reasonable value we think a user should ever pick
+[HTTP]
+HttpThreadActiveFrameTimeInSeconds=0.001
+HttpMaxConnectionsPerServer=40
+
+[/Script/Engine.LocalPlayer]
+AspectRatioAxisConstraint=AspectRatio_MaintainXFOV
+
 [CoreRedirects]
 +FunctionRedirects=(OldName="CesiumMetadataFeatureTableBlueprintLibrary.GetPropertiesForFeatureID",NewName="GetMetadataValuesForFeatureID")
 

Diff for: Content/Materials/MaterialFunctions/CesiumGetFeatureIdsFromTexture.uasset

@@ -0,0 +1,37 @@
+// Copyright 2020-2023 CesiumGS, Inc. and Contributors
+
+#include "Cesium3DTilesetCustomization.h"
+#include "Cesium3DTileset.h"
+#include "CesiumCustomization.h"
+#include "DetailCategoryBuilder.h"
+#include "DetailLayoutBuilder.h"
+
+void FCesium3DTilesetCustomization::Register(
+    FPropertyEditorModule& PropertyEditorModule) {
+  PropertyEditorModule.RegisterCustomClassLayout(
+      ACesium3DTileset::StaticClass()->GetFName(),
+      FOnGetDetailCustomizationInstance::CreateStatic(
+          &FCesium3DTilesetCustomization::MakeInstance));
+}
+
+void FCesium3DTilesetCustomization::Unregister(
+    FPropertyEditorModule& PropertyEditorModule) {
+  PropertyEditorModule.UnregisterCustomClassLayout(
+      ACesium3DTileset::StaticClass()->GetFName());
+}
+
+TSharedRef<IDetailCustomization> FCesium3DTilesetCustomization::MakeInstance() {
+  return MakeShareable(new FCesium3DTilesetCustomization);
+}
+
+void FCesium3DTilesetCustomization::CustomizeDetails(
+    IDetailLayoutBuilder& DetailBuilder) {
+  DetailBuilder.SortCategories(&SortCustomDetailsCategories);
+}
+
+void FCesium3DTilesetCustomization::SortCustomDetailsCategories(
+    const TMap<FName, IDetailCategoryBuilder*>& AllCategoryMap) {
+  (*AllCategoryMap.Find(FName("TransformCommon")))->SetSortOrder(0);
+  (*AllCategoryMap.Find(FName("Cesium")))->SetSortOrder(1);
+  (*AllCategoryMap.Find(FName("Rendering")))->SetSortOrder(2);
+}

Diff for: Source/CesiumEditor/Private/Cesium3DTilesetCustomization.cpp

@@ -0,0 +1,25 @@
+// Copyright 2020-2023 CesiumGS, Inc. and Contributors
+
+#pragma once
+
+#include "IDetailCustomization.h"
+
+class IDetailCategoryBuilder;
+
+/**
+ * An implementation of the IDetailCustomization interface that customizes
+ * the Details View of a Cesium3DTileset. It is registered in
+ * FCesiumEditorModule::StartupModule.
+ */
+class FCesium3DTilesetCustomization : public IDetailCustomization {
+public:
+  virtual void CustomizeDetails(IDetailLayoutBuilder& DetailBuilder) override;
+
+  static void Register(FPropertyEditorModule& PropertyEditorModule);
+  static void Unregister(FPropertyEditorModule& PropertyEditorModule);
+
+  static TSharedRef<IDetailCustomization> MakeInstance();
+
+  static void SortCustomDetailsCategories(
+      const TMap<FName, IDetailCategoryBuilder*>& AllCategoryMap);
+};

Diff for: Source/CesiumEditor/Private/Cesium3DTilesetCustomization.h

@@ -3,12 +3,14 @@
 #include "CesiumEditor.h"
 #include "Cesium3DTilesSelection/Tileset.h"
 #include "Cesium3DTileset.h"
+#include "Cesium3DTilesetCustomization.h"
 #include "CesiumCartographicPolygon.h"
 #include "CesiumCommands.h"
 #include "CesiumGeoreferenceCustomization.h"
 #include "CesiumGlobeAnchorCustomization.h"
 #include "CesiumIonPanel.h"
 #include "CesiumIonRasterOverlay.h"
+#include "CesiumIonServer.h"
 #include "CesiumIonTokenTroubleshooting.h"
 #include "CesiumPanel.h"
 #include "CesiumRuntime.h"
@@ -111,6 +113,7 @@ void registerDetailCustomization() {
 
   FCesiumGeoreferenceCustomization::Register(PropertyEditorModule);
   FCesiumGlobeAnchorCustomization::Register(PropertyEditorModule);
+  FCesium3DTilesetCustomization::Register(PropertyEditorModule);
 
   PropertyEditorModule.NotifyCustomizationModuleChanged();
 }
@@ -126,6 +129,7 @@ void unregisterDetailCustomization() {
 
     FCesiumGeoreferenceCustomization::Unregister(PropertyEditorModule);
     FCesiumGlobeAnchorCustomization::Unregister(PropertyEditorModule);
+    FCesium3DTilesetCustomization::Unregister(PropertyEditorModule);
   }
 }
 
@@ -265,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()) {

Diff for: Source/CesiumEditor/Private/CesiumEditor.cpp

@@ -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;

Diff for: Source/CesiumEditor/Private/CesiumEditor.h

@@ -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();
+}

Diff for: Source/CesiumEditor/Private/CesiumEditorSettings.cpp

@@ -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();
 };