Skip to content

Commit 8d5f7a4

Browse files
authored
Merge branch 'main' into rename-features-getter
2 parents 07a2363 + ba15e90 commit 8d5f7a4

File tree

83 files changed

+24676
-686
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+24676
-686
lines changed

.github/actions/install-unreal-macos/exclude-from-unzip.lst

-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
1-
UE_5.2/Engine/Binaries/Mac/LiveLinkHub-Mac-Shipping.app/*
2-
UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-DebugGame.app/*
3-
UE_5.2/Engine/Binaries/Mac/UnrealGame.app/*
4-
UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-Shipping.app/*
5-
UE_5.2/Engine/Binaries/Mac/Android/*
6-
UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-DebugGame
7-
UE_5.2/Engine/Binaries/Mac/UnrealGame
8-
UE_5.2/Engine/Binaries/Mac/UnrealGame-Mac-Shipping
9-
UE_5.2/Engine/Binaries/Mac/*.dSYM
10-
UE_5.2/Engine/Plugins/Experimental/NNERuntimeIREE/*
11-
UE_5.2/Engine/Plugins/Experimental/Avalanche/*
121
UE_5.3/Engine/Binaries/Mac/LiveLinkHub-Mac-Shipping.app/*
132
UE_5.3/Engine/Binaries/Mac/UnrealGame-Mac-DebugGame.app/*
143
UE_5.3/Engine/Binaries/Mac/UnrealGame.app/*

.github/workflows/build.yml

+8-120
Original file line numberDiff line numberDiff line change
@@ -16,138 +16,26 @@ jobs:
1616
steps:
1717
- name: Install Doxygen
1818
run: |
19-
sudo apt install -y doxygen
19+
cd ~
20+
wget https://github.com/doxygen/doxygen/releases/download/Release_1_12_0/doxygen-1.12.0.linux.bin.tar.gz
21+
tar xzf doxygen-1.12.0.linux.bin.tar.gz
22+
export PATH=$PWD/doxygen-1.12.0/bin:$PATH
23+
echo "PATH=$PATH" >> "$GITHUB_ENV"
24+
doxygen --version
2025
- name: Check out repository code
2126
uses: actions/checkout@v4
2227
with:
2328
submodules: recursive
2429
- name: Generate Documentation
2530
run: |
26-
doxygen ./Documentation/Doxyfile
31+
npm install
32+
npm run doxygen
2733
- name: Publish Documentation Artifact
2834
if: ${{ success() }}
2935
uses: actions/upload-artifact@v4
3036
with:
3137
name: ReferenceDocumentation
3238
path: Documentation/Reference
33-
Windows52:
34-
uses: ./.github/workflows/buildWindows.yml
35-
secrets: inherit
36-
with:
37-
runner-label: windows-2022
38-
unreal-engine-version: "5.2.0"
39-
unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
40-
unreal-program-name: "UE_5.2"
41-
upload-package-base-name: "CesiumForUnreal-52-windows"
42-
# These are specified in the Unreal Engine release notes under "IDE Version the Build farm compiles against"
43-
# and using them ensures we're compiling our plugin in the exact same way that Unreal Engine itself is compiled.
44-
cmake-generator: "Visual Studio 17 2022"
45-
cmake-toolchain: "version=14.34"
46-
cmake-platform: "x64,version=10.0.18362.0"
47-
visual-studio-version: "2022"
48-
visual-studio-components: "Microsoft.VisualStudio.Component.VC.14.34.17.4.x86.x64,Microsoft.VisualStudio.Component.Windows10SDK.18362"
49-
TestWindows52:
50-
needs: [Windows52]
51-
uses: ./.github/workflows/testWindows.yml
52-
secrets: inherit
53-
with:
54-
runner-label: windows-2022
55-
unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
56-
unreal-program-name: "UE_5.2"
57-
test-package-base-name: "CesiumForUnreal-52-windows"
58-
Android52:
59-
uses: ./.github/workflows/buildAndroid.yml
60-
secrets: inherit
61-
with:
62-
runner-label: windows-2022
63-
unreal-engine-version: "5.2.0"
64-
unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
65-
unreal-program-name: "UE_5.2"
66-
upload-package-base-name: "CesiumForUnreal-52-android"
67-
android-ndk-version: "r25b"
68-
Linux52:
69-
uses: ./.github/workflows/buildLinux.yml
70-
secrets: inherit
71-
with:
72-
runner-label: ubuntu-22.04
73-
unreal-engine-version: "5.2.0"
74-
unreal-engine-zip: "s3://cesium-unreal-engine/Linux_Unreal_Engine_5.2.0.zip"
75-
unreal-program-name: "UE_5.2"
76-
upload-package-base-name: "CesiumForUnreal-52-linux"
77-
clang-version: "v21_clang-15.0.1-centos7"
78-
Apple52:
79-
uses: ./.github/workflows/buildApple.yml
80-
secrets: inherit
81-
with:
82-
runner-label: macos-14
83-
unreal-engine-version: "5.2.0"
84-
unreal-engine-zip: "s3://cesium-unreal-engine/UE_52_macOS.zip"
85-
unreal-program-name: "UE_5.2"
86-
upload-package-base-name: "CesiumForUnreal-52-apple"
87-
xcode-version: "15.4"
88-
Combine52:
89-
runs-on: ubuntu-latest
90-
needs: [Windows52, Linux52, Android52, Apple52]
91-
steps:
92-
- name: Check out repository code
93-
uses: actions/checkout@v4
94-
- name: Set environment variables
95-
run: |
96-
export CESIUM_UNREAL_VERSION=$GITHUB_REF_NAME
97-
export BUILD_CESIUM_UNREAL_PACKAGE_NAME="CesiumForUnreal-52-${CESIUM_UNREAL_VERSION}"
98-
export BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME="CesiumForUnreal-52-SourceOnly-${CESIUM_UNREAL_VERSION}"
99-
# Make these available to subsequent steps
100-
echo "CESIUM_UNREAL_VERSION=$CESIUM_UNREAL_VERSION" >> $GITHUB_ENV
101-
echo "BUILD_CESIUM_UNREAL_PACKAGE_NAME=$BUILD_CESIUM_UNREAL_PACKAGE_NAME" >> $GITHUB_ENV
102-
echo "BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME=$BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME" >> $GITHUB_ENV
103-
- name: Download Apple build
104-
uses: actions/download-artifact@v4
105-
with:
106-
name: CesiumForUnreal-52-apple-${{ env.CESIUM_UNREAL_VERSION}}
107-
path: combine
108-
- name: Download Android build
109-
uses: actions/download-artifact@v4
110-
with:
111-
name: CesiumForUnreal-52-android-${{ env.CESIUM_UNREAL_VERSION}}
112-
path: combine
113-
- name: Download Linux build
114-
uses: actions/download-artifact@v4
115-
with:
116-
name: CesiumForUnreal-52-linux-${{ env.CESIUM_UNREAL_VERSION}}
117-
path: combine
118-
- name: Download Windows build
119-
uses: actions/download-artifact@v4
120-
with:
121-
name: CesiumForUnreal-52-windows-${{ env.CESIUM_UNREAL_VERSION}}
122-
path: combine
123-
- name: Publish combined package artifact
124-
if: ${{ success() }}
125-
uses: actions/upload-artifact@v4
126-
with:
127-
name: ${{ env.BUILD_CESIUM_UNREAL_PACKAGE_NAME}}
128-
path: combine
129-
- name: Publish combined package artifact for the Unreal Marketplace
130-
if: ${{ success() }}
131-
uses: actions/upload-artifact@v4
132-
with:
133-
name: ${{ env.BUILD_CESIUM_UNREAL_SOURCE_ONLY_PACKAGE_NAME}}
134-
path: |
135-
combine
136-
# These are built by Epic, and including them seems to confuse their process.
137-
!combine/CesiumForUnreal/Binaries/**/*
138-
!combine/CesiumForUnreal/Intermediate/**/*
139-
TestPackage52:
140-
needs: [Combine52]
141-
uses: ./.github/workflows/testPackageOnWindows.yml
142-
secrets: inherit
143-
with:
144-
runner-label: windows-2022
145-
unreal-engine-zip: "s3://cesium-unreal-engine/5.2.1/UE_5.2.1.zip"
146-
unreal-program-name: "UE_5.2"
147-
unreal-engine-association: "5.2"
148-
test-package-base-name: "CesiumForUnreal-52"
149-
visual-studio-version: "2022"
150-
visual-studio-components: "Microsoft.VisualStudio.Component.VC.14.34.17.4.x86.x64,Microsoft.VisualStudio.Component.Windows10SDK.18362"
15139
Windows53:
15240
uses: ./.github/workflows/buildWindows.yml
15341
secrets: inherit

.github/workflows/buildAndroid.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
rm -r -fo extern
7878
- name: Overwrite plugin engine version
7979
run: |
80-
((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.2.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
80+
((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.3.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
8181
- name: Customize BuildConfiguration.xml
8282
run: |
8383
mkdir -p "$env:USERPROFILE\AppData\Roaming\Unreal Engine\UnrealBuildTool"

.github/workflows/buildApple.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ jobs:
132132
rm -rf extern
133133
- name: Build plugin for macOS and iOS
134134
run: |
135-
sed -i '' 's/\"EngineVersion\": \"5.2.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
135+
sed -i '' 's/\"EngineVersion\": \"5.3.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
136136
export UNREAL_ENGINE_DIR=$HOME/${{ inputs.unreal-program-name }}
137137
cd $UNREAL_ENGINE_DIR/Engine/Build/BatchFiles
138138
./RunUAT.sh BuildPlugin -Plugin="$GITHUB_WORKSPACE/CesiumForUnreal.uplugin" -Package="$GITHUB_WORKSPACE/packages/CesiumForUnreal" -CreateSubFolder -TargetPlatforms=Mac+iOS -Architecture_Mac=arm64+x64

.github/workflows/buildLinux.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ jobs:
9797
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
9898
- name: Build plugin
9999
run: |
100-
sed -i 's/\"EngineVersion\": \"5.2.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
100+
sed -i 's/\"EngineVersion\": \"5.3.0\"/\"EngineVersion\": \"${{ inputs.unreal-engine-version }}\"/g' CesiumForUnreal.uplugin
101101
cd $UNREAL_ENGINE_ROOT/Engine/Build/BatchFiles
102102
./RunUAT.sh BuildPlugin -Plugin="$GITHUB_WORKSPACE/CesiumForUnreal.uplugin" -Package="$GITHUB_WORKSPACE/packages/CesiumForUnreal" -CreateSubFolder -TargetPlatforms=Linux
103103
- name: Fix RPATH

.github/workflows/buildWindows.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ jobs:
112112
rm -r -fo extern
113113
- name: Overwrite plugin engine version
114114
run: |
115-
((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.2.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
115+
((Get-Content -path CesiumForUnreal.uplugin -Raw) -replace '"EngineVersion": "5.3.0"','"EngineVersion": "${{ inputs.unreal-engine-version }}"') | Set-Content -Path CesiumForUnreal.uplugin
116116
- name: Customize BuildConfiguration.xml
117117
run: |
118118
mkdir -p "$env:USERPROFILE\AppData\Roaming\Unreal Engine\UnrealBuildTool"

CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
##### Breaking Changes :mega:
66

7+
- Removed support for Unreal Engine 5.2. Unreal Engine 5.3 or later is now required.
78
- Renamed `FCesiumFeatureIdAttribute::GetFeatureIDForVertex` to `FCesiumFeatureIdAttribute::GetFeatureID`.
89
- Renamed `FCesiumFeatureIdAttribute::GetVertexCount` to `FCesiumFeatureIdAttribute::GetFeatureIDCount`.
910

CONTRIBUTING.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
# Contribution Guide {#contributing-unreal}
2+
13
Thanks for contributing to Cesium for Unreal!
24

5+
<!--!
6+
[TOC]
7+
-->
8+
39
Here are the guidelines that we use for all contributions to this project:
410

511
- [Submitting an issue](#submitting-an-issue),
@@ -8,7 +14,7 @@ Here are the guidelines that we use for all contributions to this project:
814

915
To ensure an inclusive community, contributors and users in the Cesium community should follow the [code of conduct](./CODE_OF_CONDUCT.md).
1016

11-
# Submitting an Issue
17+
# Submitting an Issue {#submitting-an-issue}
1218

1319
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.
1420

@@ -27,7 +33,7 @@ If a related issue does not exist, submit a new one. Please be concise and inclu
2733
- A link to the thread if this was discussed on the [Cesium community forum](https://community.cesium.com/) or elsewhere.
2834
- 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.
2935

30-
# Getting Started Contributing
36+
# Getting Started Contributing {#getting-started-contributing}
3137

3238
Everyone is welcome to contribute to Cesium for Unreal!
3339

@@ -48,7 +54,7 @@ See the [build guide](https://github.com/CesiumGS/cesium-unreal#computer-develop
4854

4955
Always feel free to introduce yourself on the [Cesium community forum](https://community.cesium.com/) to brainstorm ideas and ask for guidance.
5056

51-
# Opening a Pull Request
57+
# Opening a Pull Request {#opening-a-pull-request}
5258

5359
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.
5460

@@ -63,7 +69,7 @@ Before we can review a pull request, we require a signed Contributor License Agr
6369

6470
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.
6571

66-
If you have any questions, feel free to reach out to [[email protected]](mailto:hello@cesium)!
72+
If you have any questions, feel free to reach out to [email protected]!
6773

6874
## Pull Request Guidelines
6975

@@ -76,7 +82,7 @@ Our code is our lifeblood so maintaining Cesium's high code quality is important
7682
- If your pull request needs additional work, include a [task list](https://github.com/blog/1375%0A-task-lists-in-gfm-issues-pulls-comments).
7783
- 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.
7884
- Follow the [Coding Guide](https://github.com/CesiumGS/cesium-native/blob/main/doc/style-guide.md).
79-
- Verify your is formatted, as described in the Coding Guide.
85+
- Verify your is formatted, as described in the Coding Guide.
8086

8187
## Code of Conduct
8288

CesiumForUnreal.uplugin

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"DocsURL": "https://cesium.com/learn/unreal/",
1111
"MarketplaceURL": "com.epicgames.launcher://ue/marketplace/content/87b0d05800a545d49bf858ef3458c4f7",
1212
"SupportURL": "https://community.cesium.com",
13-
"EngineVersion": "5.2.0",
13+
"EngineVersion": "5.3.0",
1414
"CanContainContent": true,
1515
"IsBetaVersion": false,
1616
"IsExperimentalVersion": false,

0 commit comments

Comments
 (0)