Merge branch 'main' into debug-tile-states

CesiumGS · Dec 23, 2024 · 5f6e124 · 5f6e124
2 parents 6cd9c27 + ba15e90
commit 5f6e124
Show file tree

Hide file tree

Showing 91 changed files with 25,009 additions and 710 deletions.
diff --git a/.github/actions/install-unreal-macos/exclude-from-unzip.lst b/.github/actions/install-unreal-macos/exclude-from-unzip.lst
@@ -1,14 +1,3 @@
-UE_5.2/Engine/Binaries/Mac/LiveLinkHub-Mac-Shipping.app/*
-UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-DebugGame.app/*
-UE_5.2/Engine/Binaries/Mac/UnrealGame.app/*
-UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-Shipping.app/*
-UE_5.2/Engine/Binaries/Mac/Android/*
-UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-DebugGame
-UE_5.2/Engine/Binaries/Mac/UnrealGame
-UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-Shipping
-UE_5.2/Engine/Binaries/Mac/*.dSYM
-UE_5.2/Engine/Plugins/Experimental/NNERuntimeIREE/*
-UE_5.2/Engine/Plugins/Experimental/Avalanche/*
 UE_5.3/Engine/Binaries/Mac/LiveLinkHub-Mac-Shipping.app/*
 UE_5.3/Engine/Binaries/Mac/UnrealGame-Mac-DebugGame.app/*
 UE_5.3/Engine/Binaries/Mac/UnrealGame.app/*

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -16,138 +16,26 @@ jobs:
     steps:
       - name: Install Doxygen
         run: |
-          sudo apt install -y doxygen
+          cd ~
+          wget https://github.com/doxygen/doxygen/releases/download/Release_1_12_0/doxygen-1.12.0.linux.bin.tar.gz
+          tar xzf doxygen-1.12.0.linux.bin.tar.gz
+          export PATH=$PWD/doxygen-1.12.0/bin:$PATH
+          echo "PATH=$PATH" >> "$GITHUB_ENV"
+          doxygen --version
       - name: Check out repository code
         uses: actions/checkout@v4
         with:
           submodules: recursive
       - name: Generate Documentation
         run: |
-          doxygen ./Documentation/Doxyfile
+          npm install
+          npm run doxygen
       - name: Publish Documentation Artifact
         if: ${{ success() }}
         uses: actions/upload-artifact@v4
         with:
           name: ReferenceDocumentation
           path: Documentation/Reference
-  Windows52:
-    uses: ./.github/workflows/buildWindows.yml
-    secrets: inherit
-    with:
-      runner-label: windows-2022
-      unreal-engine-version: "5.2.0"
-      unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
-      unreal-program-name: "UE_5.2"
-      upload-package-base-name: "CesiumForUnreal-52-windows"
-      # These are specified in the Unreal Engine release notes under "IDE Version the Build farm compiles against"
-      # and using them ensures we're compiling our plugin in the exact same way that Unreal Engine itself is compiled.
-      cmake-generator: "Visual Studio 17 2022"
-      cmake-toolchain: "version=14.34"
-      cmake-platform: "x64,version=10.0.18362.0"
-      visual-studio-version: "2022"
-      visual-studio-components: "Microsoft.VisualStudio.Component.VC.14.34.17.4.x86.x64,Microsoft.VisualStudio.Component.Windows10SDK.18362"
-  TestWindows52:
-    needs: [Windows52]
-    uses: ./.github/workflows/testWindows.yml
-    secrets: inherit
-    with:
-      runner-label: windows-2022
-      unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
-      unreal-program-name: "UE_5.2"
-      test-package-base-name: "CesiumForUnreal-52-windows"
-  Android52:
-    uses: ./.github/workflows/buildAndroid.yml
-    secrets: inherit
-    with:
-      runner-label: windows-2022
-      unreal-engine-version: "5.2.0"
-      unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
-      unreal-program-name: "UE_5.2"
-      upload-package-base-name: "CesiumForUnreal-52-android"
-      android-ndk-version: "r25b"
-  Linux52:
-    uses: ./.github/workflows/buildLinux.yml
-    secrets: inherit
-    with:
-      runner-label: ubuntu-22.04
-      unreal-engine-version: "5.2.0"
-      unreal-engine-zip: "s3://cesium-unreal-engine/Linux_Unreal_Engine_5.2.0.zip"
-      unreal-program-name: "UE_5.2"
-      upload-package-base-name: "CesiumForUnreal-52-linux"
-      clang-version: "v21_clang-15.0.1-centos7"
-  Apple52:
-    uses: ./.github/workflows/buildApple.yml
-    secrets: inherit
-    with:
-      runner-label: macos-14
-      unreal-engine-version: "5.2.0"
-      unreal-engine-zip: "s3://cesium-unreal-engine/UE_52_macOS.zip"
-      unreal-program-name: "UE_5.2"
-      upload-package-base-name: "CesiumForUnreal-52-apple"
-      xcode-version: "15.4"
-  Combine52:
-    runs-on: ubuntu-latest
-    needs: [Windows52, Linux52, Android52, Apple52]
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
-      - name: Set environment variables
-        run: |
-          export CESIUM_UNREAL_VERSION=$GITHUB_REF_NAME
-          export BUILD_CESIUM_UNREAL_PACKAGE_NAME="CesiumForUnreal-52-${CESIUM_UNREAL_VERSION}"
-          export BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME="CesiumForUnreal-52-SourceOnly-${CESIUM_UNREAL_VERSION}"
-          # Make these available to subsequent steps
-          echo "CESIUM_UNREAL_VERSION=$CESIUM_UNREAL_VERSION" >> $GITHUB_ENV
-          echo "BUILD_CESIUM_UNREAL_PACKAGE_NAME=$BUILD_CESIUM_UNREAL_PACKAGE_NAME" >> $GITHUB_ENV
-          echo "BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME=$BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME" >> $GITHUB_ENV
-      - name: Download Apple build
-        uses: actions/download-artifact@v4
-        with:
-          name: CesiumForUnreal-52-apple-${{ env.CESIUM_UNREAL_VERSION}}
-          path: combine
-      - name: Download Android build
-        uses: actions/download-artifact@v4
-        with:
-          name: CesiumForUnreal-52-android-${{ env.CESIUM_UNREAL_VERSION}}
-          path: combine
-      - name: Download Linux build
-        uses: actions/download-artifact@v4
-        with:
-          name: CesiumForUnreal-52-linux-${{ env.CESIUM_UNREAL_VERSION}}
-          path: combine
-      - name: Download Windows build
-        uses: actions/download-artifact@v4
-        with:
-          name: CesiumForUnreal-52-windows-${{ env.CESIUM_UNREAL_VERSION}}
-          path: combine
-      - name: Publish combined package artifact
-        if: ${{ success() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ env.BUILD_CESIUM_UNREAL_PACKAGE_NAME}}
-          path: combine
-      - name: Publish combined package artifact for the Unreal Marketplace
-        if: ${{ success() }}
-        uses: actions/upload-artifact@v4
-        with:
-          name: ${{ env.BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME}}
-          path: |
-            combine
-            # These are built by Epic, and including them seems to confuse their process.
-            !combine/CesiumForUnreal/Binaries/**/*
-            !combine/CesiumForUnreal/Intermediate/**/*
-  TestPackage52:
-    needs: [Combine52]
-    uses: ./.github/workflows/testPackageOnWindows.yml
-    secrets: inherit
-    with:
-      runner-label: windows-2022
-      unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
-      unreal-program-name: "UE_5.2"
-      unreal-engine-association: "5.2"
-      test-package-base-name: "CesiumForUnreal-52"
-      visual-studio-version: "2022"
-      visual-studio-components: "Microsoft.VisualStudio.Component.VC.14.34.17.4.x86.x64,Microsoft.VisualStudio.Component.Windows10SDK.18362"
   Windows53:
     uses: ./.github/workflows/buildWindows.yml
     secrets: inherit

diff --git a/.github/workflows/buildAndroid.yml b/.github/workflows/buildAndroid.yml
@@ -77,7 +77,7 @@ jobs:
           rm -r -fo extern
       - name: Overwrite plugin engine version
         run: |
-          ((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.2.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
+          ((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.3.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
       - name: Customize BuildConfiguration.xml
         run: |
           mkdir -p "$env:USERPROFILE\AppData\Roaming\Unreal Engine\UnrealBuildTool"

diff --git a/.github/workflows/buildApple.yml b/.github/workflows/buildApple.yml
@@ -132,7 +132,7 @@ jobs:
           rm -rf extern
       - name: Build plugin for macOS and iOS
         run: |
-          sed -i '' 's/\"EngineVersion\": \"5.2.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
+          sed -i '' 's/\"EngineVersion\": \"5.3.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
           export UNREAL_ENGINE_DIR=$HOME/${{ inputs.unreal-program-name }}
           cd $UNREAL_ENGINE_DIR/Engine/Build/BatchFiles
           ./RunUAT.sh BuildPlugin -Plugin="$GITHUB_WORKSPACE/CesiumForUnreal.uplugin" -Package="$GITHUB_WORKSPACE/packages/CesiumForUnreal" -CreateSubFolder -TargetPlatforms=Mac+iOS -Architecture_Mac=arm64+x64

diff --git a/.github/workflows/buildLinux.yml b/.github/workflows/buildLinux.yml
@@ -97,7 +97,7 @@ jobs:
           printf '<?xml version="1.0" encoding="utf-8" ?>\n<Configuration xmlns="https://www.unrealengine.com/BuildConfiguration">\n    <BuildConfiguration>\n      <MaxParallelActions>2</MaxParallelActions>\n    </BuildConfiguration>\n    <SourceFileWorkingSet><Provider>None</Provider></SourceFileWorkingSet>\n</Configuration>\n' > ~/.config/Unreal\ Engine/UnrealBuildTool/BuildConfiguration.xml
       - name: Build plugin
         run: |
-          sed -i 's/\"EngineVersion\": \"5.2.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
+          sed -i 's/\"EngineVersion\": \"5.3.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
           cd $UNREAL_ENGINE_ROOT/Engine/Build/BatchFiles
           ./RunUAT.sh BuildPlugin -Plugin="$GITHUB_WORKSPACE/CesiumForUnreal.uplugin" -Package="$GITHUB_WORKSPACE/packages/CesiumForUnreal" -CreateSubFolder -TargetPlatforms=Linux
       - name: Fix RPATH

diff --git a/.github/workflows/buildWindows.yml b/.github/workflows/buildWindows.yml
@@ -112,7 +112,7 @@ jobs:
           rm -r -fo extern
       - name: Overwrite plugin engine version
         run: |
-          ((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.2.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
+          ((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.3.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
       - name: Customize BuildConfiguration.xml
         run: |
           mkdir -p "$env:USERPROFILE\AppData\Roaming\Unreal Engine\UnrealBuildTool"

diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,11 @@
 # Change Log
 
+### ? - ?
+
+##### Breaking Changes :mega:
+
+- Removed support for Unreal Engine 5.2. Unreal Engine 5.3 or later is now required.
+
 ### v2.11.0 - 2024-12-02
 
 This is the last release of Cesium for Unreal that will support Unreal Engine v5.2. Future versions will require Unreal Engine v5.3+.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,11 @@
+# Contribution Guide {#contributing-unreal}
+
 Thanks for contributing to Cesium for Unreal!
 
+<!--!
+[TOC]
+-->
+
 Here are the guidelines that we use for all contributions to this project:
 
 - [Submitting an issue](#submitting-an-issue),
@@ -8,7 +14,7 @@ Here are the guidelines that we use for all contributions to this project:
 
 To ensure an inclusive community, contributors and users in the Cesium community should follow the [code of conduct](./CODE_OF_CONDUCT.md).
 
-# Submitting an Issue
+# Submitting an Issue {#submitting-an-issue}
 
 If you have a question, do not submit an issue; instead, search the [Cesium community forum](https://community.cesium.com/). The forum is very active and there are years of informative archives for the Cesium platform, often with answers from the core Cesium team. If you do not find an answer to your question, start a new thread and you'll likely get a quick response.
 
@@ -27,7 +33,7 @@ If a related issue does not exist, submit a new one. Please be concise and inclu
 - A link to the thread if this was discussed on the [Cesium community forum](https://community.cesium.com/) or elsewhere.
 - Ideas for how to fix or workaround the issue. Also mention if you are willing to help fix it. If so, the Cesium team can often provide guidance and the issue may get fixed more quickly with your help.
 
-# Getting Started Contributing
+# Getting Started Contributing {#getting-started-contributing}
 
 Everyone is welcome to contribute to Cesium for Unreal!
 
@@ -48,7 +54,7 @@ See the [build guide](https://github.com/CesiumGS/cesium-unreal#computer-develop
 
 Always feel free to introduce yourself on the [Cesium community forum](https://community.cesium.com/) to brainstorm ideas and ask for guidance.
 
-# Opening a Pull Request
+# Opening a Pull Request {#opening-a-pull-request}
 
 We love pull requests. We strive to promptly review them, provide feedback, and merge. Interest in Cesium is at an all-time high so the core team is busy. Following the tips in this guide will help your pull request get merged quickly.
 
@@ -63,7 +69,7 @@ Before we can review a pull request, we require a signed Contributor License Agr
 
 This only needs to be completed once, and enables contributions to all of the projects under the [CesiumGS](https://github.com/CesiumGS) organization, including Cesium for Unreal. The CLA ensures you retain copyright to your contributions, and provides us the right to use, modify, and redistribute your contributions using the [Apache 2.0 License](LICENSE). If you have already signed a CLA for CesiumJS or other contributions to Cesium, you will not need to sign it again.
 
-If you have any questions, feel free to reach out to [[email protected]](mailto:hello@cesium)!
+If you have any questions, feel free to reach out to [email protected]!
 
 ## Pull Request Guidelines
 
@@ -76,7 +82,7 @@ Our code is our lifeblood so maintaining Cesium's high code quality is important
   - If your pull request needs additional work, include a [task list](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments).
   - Once you are done making new commits to address feedback, add a comment to the pull request such as `"this is ready"` since GitHub doesn't notify us about commits.
   - Follow the [Coding Guide](https://github.com/CesiumGS/cesium-native/blob/main/doc/style-guide.md).
-  - Verify your is formatted, as described in the Coding Guide. 
+  - Verify your is formatted, as described in the Coding Guide.
 
 ## Code of Conduct
 

diff --git a/CesiumForUnreal.uplugin b/CesiumForUnreal.uplugin
@@ -10,7 +10,7 @@
 	"DocsURL": "https://cesium.com/learn/unreal/",
 	"MarketplaceURL": "com.epicgames.launcher://ue/marketplace/content/87b0d05800a545d49bf858ef3458c4f7",
 	"SupportURL": "https://community.cesium.com",
-	"EngineVersion": "5.2.0",
+	"EngineVersion": "5.3.0",
 	"CanContainContent": true,
 	"IsBetaVersion": false,
 	"IsExperimentalVersion": false,