Merge CesiumGS/cesium-unreal ue4-main branch

.travis.yml

@@ -17,6 +17,7 @@ jobs:
     install:
     - choco install 7zip.portable
     - choco install python --version 3.9.2
+    - choco install nasm
     - python -m pip install --upgrade pip
     - pip3 install --upgrade pip
     - pip3 install awscli
@@ -53,6 +54,7 @@ jobs:
     - choco install python --version 3.9.2
     - choco install wget
     - choco install ninja
+    - choco install nasm
     - python -m pip install --upgrade pip
     - pip3 install --upgrade pip
     - pip3 install awscli
@@ -90,6 +92,9 @@ jobs:
     - pip3 install --upgrade pip
     - pip3 install awscli
     - pip3 install httpie
+    - wget https://www.nasm.us/pub/nasm/releasebuilds/2.14.02/nasm-2.14.02.tar.xz
+    - tar -xzvf nasm-2.14.02.tar.xz
+    - pushd nasm-2.14.02 && ./configure --prefix=/usr/local && make && sudo make install && popd
     - chmod +x "./travis/travis-get-ue-427.sh"
     - "./travis/travis-get-ue-427.sh &"
     before_script:
@@ -119,6 +124,9 @@ jobs:
     - pip3 install --upgrade pip
     - pip3 install awscli
     - pip3 install httpie
+    - wget https://www.nasm.us/pub/nasm/releasebuilds/2.14.02/nasm-2.14.02.tar.xz
+    - tar -xzvf nasm-2.14.02.tar.xz
+    - pushd nasm-2.14.02 && ./configure --prefix=/usr/local && make && sudo make install && popd
     - chmod +x "./travis/travis-get-ue-427.sh"
     - "./travis/travis-get-ue-427.sh &"
     before_script:
@@ -153,6 +161,7 @@ jobs:
     - choco install python --version 3.9.2
     - choco install wget
     - choco install ninja
+    - choco install nasm
     - python -m pip install --upgrade pip
     - pip3 install --upgrade pip
     - pip3 install awscli

CHANGES.md

@@ -1,8 +1,34 @@
 # Change Log
 
+### v1.24.0 - 2023-04-03
+
+This will be the _last_ release that supports Unreal Engine v4.27. Future versions will require Unreal Engine v5.0+.
+
+##### Additions :tada:
+
+- The `FlyToAltitudeProfileCurve`, `FlyToProgressCurve`, `FlyToMaximumAltitudeCurve`, `FlyToDuration`, and `FlyToGranularityDegrees` properties of `GlobeAwareDefaultPawn`  / `DynamicPawn` may now be read and written from Blueprints.
+- Added an option on `Cesium3DTileset` to ignore the `KHR_materials_unlit` extension entirely and use normal lighting and shadows.
+- Added `CreateNavCollision` property to `Cesium3DTileset`. When enabled, `CreateNavCollision` is called on the static meshes created for tiles.
+
+##### Fixes :wrench:
+
+- Fixed unexpected reflection on tilesets with `KHR_materials_unlit` extension when the sun is close to the horizon.
+
+In addition to the above, this release updates [cesium-native](https://github.com/CesiumGS/cesium-native) from v0.22.0 to v0.23.0. See the [changelog](https://github.com/CesiumGS/cesium-native/blob/main/CHANGES.md) for a complete list of changes in cesium-native.
+
 ### v1.23.0 - 2023-03-01
 
-- Added support for rendering point clouds (`pnts`).
+##### Additions :tada:
+
+- Added support for rendering 3D Tiles point clouds (`pnts`).
+
+##### Fixes :wrench:
+
+- Fixed bug that caused a crash when changing the project default token with tilesets active in the level.
+- Vertex buffers created for 3D Tiles are now set to use full-precision UV coordinates, avoiding problems in particular with feature IDs.
+- Added some missing headers, to avoid compiler errors in non-unity builds.
+
+In addition to the above, this release updates [cesium-native](https://github.com/CesiumGS/cesium-native) from v0.21.3 to v0.22.1. See the [changelog](https://github.com/CesiumGS/cesium-native/blob/main/CHANGES.md) for a complete list of changes in cesium-native.
 
 ### v1.22.0 - 2023-02-01
 

CesiumForUnreal.uplugin

@@ -1,7 +1,7 @@
 {
 	"FileVersion": 3,
-	"Version": 38,
-	"VersionName": "1.22.0",
+	"Version": 40,
+	"VersionName": "1.24.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",

Documentation/developer-setup-linux.md

@@ -3,6 +3,7 @@ Detailed instructions for setting up a Cesium for Unreal development environment
 # Prerequisities
 
 - Install CMake (version 3.15 or newer) from https://cmake.org/install/
+- For best JPEG-decoding performance, you must have [nasm](https://www.nasm.us/) installed so that CMake can find it. Everything will work fine without it, just slower.
 - Build Unreal Engine for Linux by following the [Linux Quickstart](https://docs.unrealengine.com/en-US/SharingAndReleasing/Linux/BeginnerLinuxDeveloper/SettingUpAnUnrealWorkflow/index.html)
 
 After compiling Unreal Engine, set the following environment variables in your `.bashrc`.

Documentation/developer-setup-osx.md

@@ -4,6 +4,7 @@ Detailed instructions for setting up a Cesium for Unreal development environment
 
 - Install CMake (version 3.15 or newer) from https://cmake.org/install/
 - Install Xcode 11.3 from https://developer.apple.com/xcode/resources/
+- For best JPEG-decoding performance, you must have [nasm](https://www.nasm.us/) installed so that CMake can find it. Everything will work fine without it, just slower.
 - Install the Unreal Engine (version 4.26 or newer) from https://www.unrealengine.com/en-US/download
 
 # Cloning the git repos

Documentation/developer-setup-windows.md

@@ -4,6 +4,7 @@ Detailed instructions for setting up a Cesium for Unreal development environment
 
 - Install CMake (version 3.15 or newer) from https://cmake.org/install/
 - Install Visual Studio 2017 v15.6+ or Visual Studio 2019 v16.5+.
+- For best JPEG-decoding performance, you must have [nasm](https://www.nasm.us/) installed so that CMake can find it. Everything will work fine without it, just slower.
 - Install the Unreal Engine (version 4.26 or newer) from https://www.unrealengine.com/en-US/download
 
 ## For Cross Compiling Android on Windows

Source/CesiumEditor/Private/SelectCesiumIonToken.cpp

@@ -392,7 +392,7 @@ void SelectCesiumIonToken::createRadioButton(
 }
 
 FReply SelectCesiumIonToken::UseOrCreate() {
-  if (!this->_promise) {
+  if (!this->_promise || !this->_future) {
     return FReply::Handled();
   }
 
@@ -497,6 +497,11 @@ FReply SelectCesiumIonToken::UseOrCreate() {
         pPanel->RequestDestroyWindow();
       });
 
+  while (!this->_future->isReady()) {
+    FCesiumEditorModule::ion().getAssetAccessor()->tick();
+    FCesiumEditorModule::ion().getAsyncSystem().dispatchMainThreadTasks();
+  }
+
   return FReply::Handled();
 }
 

Source/CesiumRuntime/CesiumRuntime.Build.cs

@@ -91,6 +91,7 @@ public CesiumRuntime(ReadOnlyTargetRules Target) : base(Target)
             "spdlog",
             "sqlite3",
             "tinyxml2",
+            "turbojpeg",
             "uriparser",
             "webpdecoder",
             "ktx_read",

Source/CesiumRuntime/Private/Cesium3DTileset.cpp

@@ -20,7 +20,6 @@
 #include "CesiumCustomVersion.h"
 #include "CesiumGeospatial/Cartographic.h"
 #include "CesiumGeospatial/Ellipsoid.h"
-#include "CesiumGeospatial/Transforms.h"
 #include "CesiumGltf/ImageCesium.h"
 #include "CesiumGltf/Ktx2TranscodeTargets.h"
 #include "CesiumGltfComponent.h"
@@ -77,9 +76,8 @@ ACesium3DTileset::ACesium3DTileset()
       _pTileset(nullptr),
 
       _lastTilesRendered(0),
-      _lastTilesLoadingLowPriority(0),
-      _lastTilesLoadingMediumPriority(0),
-      _lastTilesLoadingHighPriority(0),
+      _lastWorkerThreadTileLoadQueueLength(0),
+      _lastMainThreadTileLoadQueueLength(0),
 
       _lastTilesVisited(0),
       _lastTilesCulled(0),
@@ -319,6 +317,13 @@ void ACesium3DTileset::SetCreatePhysicsMeshes(bool bCreatePhysicsMeshes) {
   }
 }
 
+void ACesium3DTileset::SetCreateNavCollision(bool bCreateNavCollision) {
+  if (this->CreateNavCollision != bCreateNavCollision) {
+    this->CreateNavCollision = bCreateNavCollision;
+    this->DestroyTileset();
+  }
+}
+
 void ACesium3DTileset::SetAlwaysIncludeTangents(bool bAlwaysIncludeTangents) {
   if (this->AlwaysIncludeTangents != bAlwaysIncludeTangents) {
     this->AlwaysIncludeTangents = bAlwaysIncludeTangents;
@@ -340,6 +345,14 @@ void ACesium3DTileset::SetEnableWaterMask(bool bEnableMask) {
   }
 }
 
+void ACesium3DTileset::SetIgnoreKhrMaterialsUnlit(
+    bool bIgnoreKhrMaterialsUnlit) {
+  if (this->IgnoreKhrMaterialsUnlit != bIgnoreKhrMaterialsUnlit) {
+    this->IgnoreKhrMaterialsUnlit = bIgnoreKhrMaterialsUnlit;
+    this->DestroyTileset();
+  }
+}
+
 void ACesium3DTileset::SetMaterial(UMaterialInterface* InMaterial) {
   if (this->Material != InMaterial) {
     this->Material = InMaterial;
@@ -649,6 +662,9 @@ class UnrealResourcePreparer
     options.pPhysXCookingModule = this->_pPhysXCookingModule;
 #endif
 
+    options.ignoreKhrMaterialsUnlit =
+        this->_pActor->GetIgnoreKhrMaterialsUnlit();
+
     options.pEncodedMetadataDescription =
         &this->_pActor->_encodedMetadataDescription;
 
@@ -679,7 +695,8 @@ class UnrealResourcePreparer
           this->_pActor->GetTranslucentMaterial(),
           this->_pActor->GetWaterMaterial(),
           this->_pActor->GetCustomDepthParameters(),
-          tile.getContentBoundingVolume().value_or(tile.getBoundingVolume()));
+          tile.getContentBoundingVolume().value_or(tile.getBoundingVolume()),
+          this->_pActor->GetCreateNavCollision());
     }
     // UE_LOG(LogCesium, VeryVerbose, TEXT("No content for tile"));
     return nullptr;
@@ -1732,10 +1749,10 @@ void ACesium3DTileset::updateLastViewUpdateResultState(
   }
 
   if (result.tilesToRenderThisFrame.size() != this->_lastTilesRendered ||
-      result.tilesLoadingLowPriority != this->_lastTilesLoadingLowPriority ||
-      result.tilesLoadingMediumPriority !=
-          this->_lastTilesLoadingMediumPriority ||
-      result.tilesLoadingHighPriority != this->_lastTilesLoadingHighPriority ||
+      result.workerThreadTileLoadQueueLength !=
+          this->_lastWorkerThreadTileLoadQueueLength ||
+      result.mainThreadTileLoadQueueLength !=
+          this->_lastMainThreadTileLoadQueueLength ||
       result.tilesVisited != this->_lastTilesVisited ||
       result.culledTilesVisited != this->_lastCulledTilesVisited ||
       result.tilesCulled != this->_lastTilesCulled ||
@@ -1745,9 +1762,10 @@ void ACesium3DTileset::updateLastViewUpdateResultState(
       result.maxDepthVisited != this->_lastMaxDepthVisited) {
 
     this->_lastTilesRendered = result.tilesToRenderThisFrame.size();
-    this->_lastTilesLoadingLowPriority = result.tilesLoadingLowPriority;
-    this->_lastTilesLoadingMediumPriority = result.tilesLoadingMediumPriority;
-    this->_lastTilesLoadingHighPriority = result.tilesLoadingHighPriority;
+    this->_lastWorkerThreadTileLoadQueueLength =
+        result.workerThreadTileLoadQueueLength;
+    this->_lastMainThreadTileLoadQueueLength =
+        result.mainThreadTileLoadQueueLength;
 
     this->_lastTilesVisited = result.tilesVisited;
     this->_lastCulledTilesVisited = result.culledTilesVisited;
@@ -1761,7 +1779,7 @@ void ACesium3DTileset::updateLastViewUpdateResultState(
         LogCesium,
         Display,
         TEXT(
-            "%s: %d ms, Visited %d, Culled Visited %d, Rendered %d, Culled %d, Occluded %d, Waiting For Occlusion Results %d, Max Depth Visited: %d, Loading-Low %d, Loading-Medium %d, Loading-High %d, Loaded tiles %g%%"),
+            "%s: %d ms, Visited %d, Culled Visited %d, Rendered %d, Culled %d, Occluded %d, Waiting For Occlusion Results %d, Max Depth Visited: %d, Loading-Worker %d, Loading-Main %d, Loaded tiles %g%%"),
         *this->GetName(),
         (std::chrono::high_resolution_clock::now() - this->_startTime).count() /
             1000000,
@@ -1772,9 +1790,8 @@ void ACesium3DTileset::updateLastViewUpdateResultState(
         result.tilesOccluded,
         result.tilesWaitingForOcclusionResults,
         result.maxDepthVisited,
-        result.tilesLoadingLowPriority,
-        result.tilesLoadingMediumPriority,
-        result.tilesLoadingHighPriority,
+        result.workerThreadTileLoadQueueLength,
+        result.mainThreadTileLoadQueueLength,
         this->LoadProgress);
   }
 }
@@ -2029,11 +2046,15 @@ void ACesium3DTileset::PostEditChangeProperty(
           GET_MEMBER_NAME_CHECKED(ACesium3DTileset, IonAssetEndpointUrl) ||
       PropName ==
           GET_MEMBER_NAME_CHECKED(ACesium3DTileset, CreatePhysicsMeshes) ||
+      PropName ==
+          GET_MEMBER_NAME_CHECKED(ACesium3DTileset, CreateNavCollision) ||
       PropName ==
           GET_MEMBER_NAME_CHECKED(ACesium3DTileset, AlwaysIncludeTangents) ||
       PropName ==
           GET_MEMBER_NAME_CHECKED(ACesium3DTileset, GenerateSmoothNormals) ||
       PropName == GET_MEMBER_NAME_CHECKED(ACesium3DTileset, EnableWaterMask) ||
+      PropName ==
+          GET_MEMBER_NAME_CHECKED(ACesium3DTileset, IgnoreKhrMaterialsUnlit) ||
       PropName == GET_MEMBER_NAME_CHECKED(ACesium3DTileset, Material) ||
       PropName ==
           GET_MEMBER_NAME_CHECKED(ACesium3DTileset, TranslucentMaterial) ||

Source/CesiumRuntime/Private/CesiumGeoreference.cpp

@@ -4,7 +4,6 @@
 #include "Camera/PlayerCameraManager.h"
 #include "CesiumActors.h"
 #include "CesiumCommon.h"
-#include "CesiumGeospatial/Transforms.h"
 #include "CesiumRuntime.h"
 #include "CesiumTransforms.h"
 #include "CesiumUtility/Math.h"