Merge branch 'ue5-main' into dont-limit-curl-requests

Author: csciguy8

CHANGES.md

@@ -1,5 +1,12 @@
 # Change Log
 
+### ? - ?
+
+##### 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.
+
 ### 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.

Config/Engine.ini

@@ -5,10 +5,15 @@
 [HTTP.HttpThread]
 RunningThreadedRequestLimit=100
 
-# Explicitly set the libCurl max connections to a single host (maps to CURLMOPT_MAX_HOST_CONNECTIONS)
+# 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
 
 [CoreRedirects]

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

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

Source/CesiumEditor/Private/Cesium3DTilesetCustomization.h

@@ -3,6 +3,7 @@
 #include "CesiumEditor.h"
 #include "Cesium3DTilesSelection/Tileset.h"
 #include "Cesium3DTileset.h"
+#include "Cesium3DTilesetCustomization.h"
 #include "CesiumCartographicPolygon.h"
 #include "CesiumCommands.h"
 #include "CesiumGeoreferenceCustomization.h"
@@ -111,6 +112,7 @@ void registerDetailCustomization() {
 
   FCesiumGeoreferenceCustomization::Register(PropertyEditorModule);
   FCesiumGlobeAnchorCustomization::Register(PropertyEditorModule);
+  FCesium3DTilesetCustomization::Register(PropertyEditorModule);
 
   PropertyEditorModule.NotifyCustomizationModuleChanged();
 }
@@ -126,6 +128,7 @@ void unregisterDetailCustomization() {
 
     FCesiumGeoreferenceCustomization::Unregister(PropertyEditorModule);
     FCesiumGlobeAnchorCustomization::Unregister(PropertyEditorModule);
+    FCesium3DTilesetCustomization::Unregister(PropertyEditorModule);
   }
 }
 

Source/CesiumEditor/Private/CesiumEditor.cpp

@@ -459,11 +459,7 @@ FReply SelectCesiumIonToken::UseOrCreate() {
               UTF8_TO_TCHAR(response.value->token.c_str());
           pSettings->Modify();
 
-#if ENGINE_MAJOR_VERSION >= 5
           pSettings->TryUpdateDefaultConfigFile();
-#else
-          pSettings->UpdateDefaultConfigFile();
-#endif
 
           // Refresh all tilesets and overlays that are using the project
           // default token.

Source/CesiumEditor/Private/SelectCesiumIonToken.cpp

@@ -1,4 +1,4 @@
-// Copyright 2020-2021 CesiumGS, Inc. and Contributors
+// Copyright 2020-2023 CesiumGS, Inc. and Contributors
 
 #include "Cesium3DTileset.h"
 #include "Async/Async.h"
@@ -954,18 +954,6 @@ void ACesium3DTileset::LoadTileset() {
         *this->Url);
   }
 
-#if ENGINE_MAJOR_VERSION == 5 && ENGINE_MINOR_VERSION == 0
-  if (pWorldSettings && !pWorldSettings->bEnableLargeWorlds) {
-    pWorldSettings->bEnableLargeWorlds = true;
-    UE_LOG(
-        LogCesium,
-        Warning,
-        TEXT(
-            "Cesium for Unreal has enabled the \"Enable Large Worlds\" option in this world's settings, as it is required in order to avoid serious culling problems with Cesium3DTilesets in Unreal Engine 5."),
-        *this->Url);
-  }
-#endif
-
   const TSharedRef<CesiumViewExtension, ESPMode::ThreadSafe>&
       cesiumViewExtension = getCesiumViewExtension();
   const std::shared_ptr<CesiumAsync::IAssetAccessor>& pAssetAccessor =
@@ -1000,7 +988,11 @@ void ACesium3DTileset::LoadTileset() {
     FCesiumFeaturesMetadataDescription& description =
         this->_featuresMetadataDescription.emplace();
     description.Features = {pFeaturesMetadataComponent->FeatureIdSets};
-    description.ModelMetadata = {pFeaturesMetadataComponent->PropertyTables};
+    description.PrimitiveMetadata = {
+        pFeaturesMetadataComponent->PropertyTextureNames};
+    description.ModelMetadata = {
+        pFeaturesMetadataComponent->PropertyTables,
+        pFeaturesMetadataComponent->PropertyTextures};
   } else if (pEncodedMetadataComponent) {
     UE_LOG(
         LogCesium,
@@ -1377,13 +1369,8 @@ std::vector<FCesiumCamera> ACesium3DTileset::GetPlayerCameras() const {
     }
 
     if (useStereoRendering) {
-#if ENGINE_MAJOR_VERSION >= 5
       const auto leftEye = EStereoscopicEye::eSSE_LEFT_EYE;
       const auto rightEye = EStereoscopicEye::eSSE_RIGHT_EYE;
-#else
-      const auto leftEye = EStereoscopicPass::eSSP_LEFT_EYE;
-      const auto rightEye = EStereoscopicPass::eSSP_RIGHT_EYE;
-#endif
 
       uint32 stereoLeftSizeX = static_cast<uint32>(sizeX);
       uint32 stereoLeftSizeY = static_cast<uint32>(sizeY);
@@ -1420,9 +1407,9 @@ std::vector<FCesiumCamera> ACesium3DTileset::GetPlayerCameras() const {
             pStereoRendering->GetStereoProjectionMatrix(leftEye);
 
         // TODO: consider assymetric frustums using 4 fovs
-        CesiumReal one_over_tan_half_hfov = projection.M[0][0];
+        double one_over_tan_half_hfov = projection.M[0][0];
 
-        CesiumReal hfov =
+        double hfov =
             glm::degrees(2.0 * glm::atan(1.0 / one_over_tan_half_hfov));
 
         cameras.emplace_back(
@@ -1444,9 +1431,9 @@ std::vector<FCesiumCamera> ACesium3DTileset::GetPlayerCameras() const {
         FMatrix projection =
             pStereoRendering->GetStereoProjectionMatrix(rightEye);
 
-        CesiumReal one_over_tan_half_hfov = projection.M[0][0];
+        double one_over_tan_half_hfov = projection.M[0][0];
 
-        CesiumReal hfov =
+        double hfov =
             glm::degrees(2.0f * glm::atan(1.0f / one_over_tan_half_hfov));
 
         cameras.emplace_back(

Source/CesiumRuntime/Private/Cesium3DTileset.cpp

@@ -315,15 +315,16 @@ FString getMaterialNameForPropertyTableProperty(
     const FString& propertyTableName,
     const FString& propertyName) {
   // Example: "PTABLE_houses_roofColor"
-  return MaterialPropertyTablePrefix + propertyTableName + "_" + propertyName;
+  return createHlslSafeName(
+      MaterialPropertyTablePrefix + propertyTableName + "_" + propertyName);
 }
 
 FString getMaterialNameForPropertyTextureProperty(
     const FString& propertyTextureName,
     const FString& propertyName) {
   // Example: "PTEXTURE_house_temperature"
-  return MaterialPropertyTexturePrefix + propertyTextureName + "_" +
-         propertyName;
+  return createHlslSafeName(
+      MaterialPropertyTexturePrefix + propertyTextureName + "_" + propertyName);
 }
 
 namespace {
@@ -691,7 +692,8 @@ EncodedPropertyTexture encodePropertyTextureAnyThreadPart(
     EncodedPropertyTextureProperty& encodedProperty =
         encodedPropertyTexture.properties.Emplace_GetRef();
     encodedProperty.name = createHlslSafeName(pDescription->Name);
-    encodedProperty.type = pDescription->PropertyDetails.Type;
+    encodedProperty.type =
+        CesiumMetadataTypeToEncodingType(pDescription->PropertyDetails.Type);
     encodedProperty.textureCoordinateSetIndex = property.getTexCoordSetIndex();
 
     if (UCesiumPropertyTexturePropertyBlueprintLibrary::
@@ -700,9 +702,7 @@ EncodedPropertyTexture encodePropertyTextureAnyThreadPart(
 
       const TArray<int64>& channels =
           UCesiumPropertyTexturePropertyBlueprintLibrary::GetChannels(property);
-      const int32 channelCount = FMath::Max(
-          channels.Num(),
-          static_cast<int32>(encodedProperty.channels.size()));
+      const int32 channelCount = channels.Num();
       for (int32 i = 0; i < channelCount; i++) {
         encodedProperty.channels[i] = channels[i];
       }
@@ -748,6 +748,7 @@ EncodedPropertyTexture encodePropertyTextureAnyThreadPart(
           encodedProperty.pTexture->addressY = TextureAddress::TA_Clamp;
         }
 
+        // TODO: account for texture filter
         encodedProperty.pTexture->filter = TextureFilter::TF_Nearest;
 
         if (!encodedProperty.pTexture->pTextureData) {
@@ -815,13 +816,16 @@ EncodedPrimitiveMetadata encodePrimitiveMetadataAnyThreadPart(
   result.propertyTextureIndices.Reserve(
       metadataDescription.PropertyTextureNames.Num());
 
-  for (const FCesiumPropertyTexture& propertyTexture : propertyTextures) {
+  for (int32 i = 0; i < propertyTextures.Num(); i++) {
+    const FCesiumPropertyTexture& propertyTexture = propertyTextures[i];
     FString propertyTextureName = getNameForPropertyTexture(propertyTexture);
-    int32 index =
+    const FString* pName =
         metadataDescription.PropertyTextureNames.Find(propertyTextureName);
-    // Confirm that the named property texture is actually present.
-    if (index != INDEX_NONE) {
-      result.propertyTextureIndices.Add(index);
+    // Confirm that the named property texture is actually present. This
+    // indicates that it is acceptable to pass the texture coordinate index to
+    // the material layer.
+    if (pName) {
+      result.propertyTextureIndices.Add(i);
     }
   }
 
@@ -887,6 +891,7 @@ EncodedModelMetadata encodeModelMetadataAnyThreadPart(
               *pExpectedPropertyTexture,
               propertyTexture,
               propertyTexturePropertyMap));
+      encodedPropertyTexture.name = propertyTextureName;
     }
   }