Merge branch 'main' into debug-tile-states

CesiumGS · Dec 23, 2024 · 7fda7d9 · 7fda7d9
2 parents fd969f7 + cbf40f2
commit 7fda7d9
Show file tree

Hide file tree

Showing 59 changed files with 24,627 additions and 457 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -16,14 +16,20 @@ 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

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/Documentation/Doxyfile b/Documentation/Doxyfile
@@ -48,13 +48,13 @@ PROJECT_NAME           = "Cesium for Unreal"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         =
+PROJECT_NUMBER         = $(npm_package_version)
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Unlock the 3D geospatial ecosystem in Unreal Engine with real-world 3D content and a high accuracy full-scale WGS84 globe."
+PROJECT_BRIEF          = 
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -372,7 +372,7 @@ TOC_INCLUDE_HEADINGS   = 5
 # The default value is: DOXYGEN.
 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
 
-MARKDOWN_ID_STYLE      = DOXYGEN
+MARKDOWN_ID_STYLE      = GITHUB
 
 # When enabled doxygen tries to link words that correspond to documented
 # classes, or namespaces to their corresponding documentation. Such a link can
@@ -390,7 +390,7 @@ AUTOLINK_SUPPORT       = YES
 # diagrams that involve STL classes more complete and accurate.
 # The default value is: NO.
 
-BUILTIN_STL_SUPPORT    = NO
+BUILTIN_STL_SUPPORT    = YES
 
 # If you use Microsoft's C++/CLI language, you should set this option to YES to
 # enable parsing support.
@@ -943,7 +943,11 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./Source/CesiumRuntime/Public
+INPUT                  = ./README.md \
+                         ./ \
+                        ./Documentation \
+                        ./Documentation/Pages \
+                        ./Source/CesiumRuntime/Public 
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1093,7 +1097,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = ./Documentation/Images ./Content
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1154,7 +1158,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common
@@ -1176,7 +1180,7 @@ FORTRAN_COMMENT_AFTER  = 72
 # also VERBATIM_HEADERS is set to NO.
 # The default value is: NO.
 
-SOURCE_BROWSER         = NO
+SOURCE_BROWSER         = YES
 
 # Setting the INLINE_SOURCES tag to YES will include the body of functions,
 # classes and enums directly into the documentation.
@@ -1393,7 +1397,7 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  =
+HTML_EXTRA_STYLESHEET  = ./node_modules/doxygen-awesome-css/doxygen-awesome.css
 
 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
 # other source files which should be copied to the HTML output directory. Note
@@ -1416,7 +1420,7 @@ HTML_EXTRA_FILES       =
 # The default value is: AUTO_LIGHT.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE        = AUTO_LIGHT
+HTML_COLORSTYLE        = LIGHT
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to
@@ -1717,7 +1721,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
 # FULL_SIDEBAR option determines if the side bar is limited to only the treeview
@@ -2402,7 +2406,9 @@ PREDEFINED             = UFUNCTION()= \
                          GENERATED_BODY()= \
                          UCLASS()= \
                          CESIUMRUNTIME_API= \
-                         UE_DEPRECATED()=
+                         UE_DEPRECATED()= \
+                         "PURE_VIRTUAL(func,extra)=0" \
+                         "DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(name,t1,p1,t2,p2)=class name : public TBaseDynamicMulticastDelegate\<FWeakObjectPtr,void,t1,t2\> {};"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The
@@ -2440,7 +2446,7 @@ SKIP_FUNCTION_MACROS   = YES
 # the path). If a tag file is not located in the directory in which doxygen is
 # run, you must also specify the path to the tagfile here.
 
-TAGFILES               =
+TAGFILES               = ./Documentation/cesium-native.tag=https://cesium.com/learn/cesium-native/ref-doc/
 
 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
 # tag file that is based on the input files it reads. See section "Linking to
@@ -2460,14 +2466,14 @@ ALLEXTERNALS           = NO
 # listed.
 # The default value is: YES.
 
-EXTERNAL_GROUPS        = YES
+EXTERNAL_GROUPS        = NO
 
 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
 # the related pages index. If set to NO, only the current project's pages will
 # be listed.
 # The default value is: YES.
 
-EXTERNAL_PAGES         = YES
+EXTERNAL_PAGES         = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to diagram generator tools

diff --git a/Documentation/Images/developmentEditorTarget.png b/Documentation/Images/developmentEditorTarget.png
diff --git a/Documentation/Images/functionalTesting.png b/Documentation/Images/functionalTesting.png
diff --git a/Documentation/Images/profilingAutomationTestWindow.jpg b/Documentation/Images/profilingAutomationTestWindow.jpg
diff --git a/Documentation/Images/profilingBreakpoints.jpg b/Documentation/Images/profilingBreakpoints.jpg
diff --git a/Documentation/Images/profilingDisableCpuProfiling.png b/Documentation/Images/profilingDisableCpuProfiling.png
diff --git a/Documentation/Images/profilingFunctions.png b/Documentation/Images/profilingFunctions.png
diff --git a/Documentation/Images/profilingInterpretReport.png b/Documentation/Images/profilingInterpretReport.png
diff --git a/Documentation/Images/profilingOpenDetails.png b/Documentation/Images/profilingOpenDetails.png
diff --git a/Documentation/Images/profilingOpenTrace.png b/Documentation/Images/profilingOpenTrace.png
diff --git a/Documentation/Images/profilingRecordCpuProfile.png b/Documentation/Images/profilingRecordCpuProfile.png
diff --git a/Documentation/Images/profilingStartAtTimeline.png b/Documentation/Images/profilingStartAtTimeline.png
diff --git a/Documentation/Images/profilingStbirHorizontalDownsample.png b/Documentation/Images/profilingStbirHorizontalDownsample.png
diff --git a/Documentation/Images/profilingUnrealFragmentedUse.png b/Documentation/Images/profilingUnrealFragmentedUse.png
diff --git a/Documentation/Images/profilingUnrealInsightsSessionBrowser.png b/Documentation/Images/profilingUnrealInsightsSessionBrowser.png
diff --git a/Documentation/Images/profilingUnrealInterpretReport.png b/Documentation/Images/profilingUnrealInterpretReport.png
diff --git a/Documentation/Images/profilingUnrealLowUse.png b/Documentation/Images/profilingUnrealLowUse.png
diff --git a/Documentation/Images/profilingUnrealMark.png b/Documentation/Images/profilingUnrealMark.png
diff --git a/Documentation/Images/profilingUnrealTimers.png b/Documentation/Images/profilingUnrealTimers.png
diff --git a/Documentation/Images/profilingUnrealTracks.png b/Documentation/Images/profilingUnrealTracks.png
diff --git a/Documentation/Images/startupMap.png b/Documentation/Images/startupMap.png
diff --git a/Documentation/Pages/developer-resources.md b/Documentation/Pages/developer-resources.md
@@ -0,0 +1,10 @@
+# Developer Resources {#developer-resources-unreal}
+
+- \subpage developer-setup-unreal
+- \subpage reference-frames
+- \subpage developing-uobjects
+- \subpage v2-upgrade-guide
+- \subpage performance-profiling
+- \subpage release-process
+- \subpage packaging-guide
+- \subpage using-prerelease
diff --git a/Documentation/Pages/performance-profiling.md b/Documentation/Pages/performance-profiling.md
@@ -0,0 +1,5 @@
+# Performance Profiling {#performance-profiling}
+
+- \subpage performance-profiling-setup-test
+- \subpage performance-profiling-cpu-usage
+- \subpage performance-profiling-unreal-insights