map LOD mesh glTF export

Author: moritz-h

README.md

@@ -45,6 +45,7 @@ During CMake build, the following additional libraries will be fetched and inclu
   - [imgui_club](https://github.com/ocornut/imgui_club.git)
   - [ImPlot3D](https://github.com/brenocq/implot3d.git)
 - [FreeType](https://github.com/freetype/freetype.git)
+- [FP16](https://github.com/Maratyszcza/FP16.git)
 - [GLFW](https://github.com/glfw/glfw.git)
 - [GLM](https://github.com/g-truc/glm.git)
 - [glOwl](https://github.com/invor/glowl.git)

cmake/deps/fp16.cmake

@@ -0,0 +1,22 @@
+# fp16
+include_guard(GLOBAL)
+
+FetchContent_Declare(fp16
+  URL "https://github.com/Maratyszcza/FP16/archive/3d2de1816307bac63c16a297e8c4dc501b4076df.tar.gz"
+  URL_HASH SHA256=65ace2f05fd9434b0acb7a7d3cc6cd96842ea6236b680594af932b359bedbfc1
+  DOWNLOAD_NO_PROGRESS ON
+  EXCLUDE_FROM_ALL
+  SYSTEM)
+message(STATUS "Fetch fp16 ...")
+OPTION(FP16_BUILD_TESTS "" OFF)
+OPTION(FP16_BUILD_BENCHMARKS "" OFF)
+OPTION(FP16_INSTALL_LIBRARY "" OFF)
+FetchContent_MakeAvailable(fp16)
+mark_as_advanced(FORCE
+  FETCHCONTENT_SOURCE_DIR_FP16
+  FETCHCONTENT_UPDATES_DISCONNECTED_FP16
+  FP16_BUILD_BENCHMARKS
+  FP16_BUILD_COMPARATIVE_BENCHMARKS
+  FP16_BUILD_TESTS
+  FP16_INSTALL_LIBRARY)
+register_copyright(fp16 "FP16" "${fp16_SOURCE_DIR}/LICENSE")

cmake/deps/tinygltf.cmake

@@ -2,6 +2,7 @@
 include_guard(GLOBAL)
 
 find_package(nlohmann_json REQUIRED)
+find_package(zlib REQUIRED)
 
 FetchContent_Declare(tinygltf
   URL "https://github.com/syoyo/tinygltf/archive/v2.9.6.tar.gz"
@@ -12,12 +13,14 @@ FetchContent_Declare(tinygltf
   SYSTEM)
 message(STATUS "Fetch tinygltf ...")
 FetchContent_MakeAvailable(tinygltf)
-# Build a custom tinygltf version without using the internal json.hpp. Link our json target instead.
-# Further, the current tinygltf CMake does not work well with add_subdirectory and building as static library.
+# Build a custom tinygltf version:
+# - Replace internal json.hpp with our json target.
+# - Use zlib for stb_image_write png compression
+# - The current tinygltf CMake does not work well with add_subdirectory and building as static library.
 file(COPY ${tinygltf_SOURCE_DIR}/stb_image.h DESTINATION ${tinygltf_BINARY_DIR}/src/include)
 file(COPY ${tinygltf_SOURCE_DIR}/stb_image_write.h DESTINATION ${tinygltf_BINARY_DIR}/src/include)
 file(COPY ${tinygltf_SOURCE_DIR}/tiny_gltf.h DESTINATION ${tinygltf_BINARY_DIR}/src/include)
-file(COPY ${tinygltf_SOURCE_DIR}/tiny_gltf.cc DESTINATION ${tinygltf_BINARY_DIR}/src/src)
+file(COPY ${CMAKE_SOURCE_DIR}/cmake/deps/tinygltf/tiny_gltf.cc DESTINATION ${tinygltf_BINARY_DIR}/src/src)
 file(COPY ${CMAKE_SOURCE_DIR}/cmake/deps/tinygltf/CMakeLists.txt DESTINATION ${tinygltf_BINARY_DIR}/src)
 add_subdirectory(${tinygltf_BINARY_DIR}/src ${tinygltf_BINARY_DIR}/build EXCLUDE_FROM_ALL SYSTEM)
 set_target_properties(tinygltf PROPERTIES FOLDER libs)

cmake/deps/tinygltf/CMakeLists.txt

@@ -9,7 +9,7 @@ target_include_directories(tinygltf PUBLIC
 target_compile_definitions(tinygltf PRIVATE TINYGLTF_USE_CPP14)
 set_target_properties(tinygltf PROPERTIES
   MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
-target_link_libraries(tinygltf PRIVATE nlohmann_json)
+target_link_libraries(tinygltf PRIVATE nlohmann_json ZLIB::ZLIBSTATIC)
 
 # tinygltf includes just "json.hpp", but nlohmann_json CMake assumes "nlohmann/json.hpp" as include.
 # Modify include path to fix this.

cmake/deps/tinygltf/tiny_gltf.cc

@@ -0,0 +1,26 @@
+#include <cstdlib>
+
+#include <zlib.h>
+
+static unsigned char* custom_stbiw_zlib_compress(unsigned char* data, int data_len, int* out_len, int quality) {
+    uLong size = compressBound(static_cast<uLong>(data_len));
+    unsigned char* buffer = static_cast<unsigned char*>(::malloc(size));
+    if (buffer == nullptr) {
+        return nullptr;
+    }
+    int state = ::compress(reinterpret_cast<Bytef*>(buffer), &size, reinterpret_cast<const Bytef*>(data),
+        static_cast<uLong>(data_len));
+    if (state != Z_OK) {
+        ::free(buffer);
+        return nullptr;
+    }
+    *out_len = static_cast<int>(size);
+    return buffer;
+}
+
+#define STBIW_ZLIB_COMPRESS custom_stbiw_zlib_compress
+
+#define TINYGLTF_IMPLEMENTATION
+#define STB_IMAGE_IMPLEMENTATION
+#define STB_IMAGE_WRITE_IMPLEMENTATION
+#include "tiny_gltf.h"

map/CMakeLists.txt

@@ -10,6 +10,7 @@ find_package(freetype REQUIRED)
 find_package(imgui REQUIRED)
 find_package(imguiclub REQUIRED)
 find_package(implot3d REQUIRED)
+find_package(fp16 REQUIRED)
 find_package(nlohmann_json REQUIRED)
 find_package(TinyGLTF REQUIRED)
 find_package(glowl REQUIRED)
@@ -71,6 +72,7 @@ target_link_libraries(${PROJECT_NAME} PRIVATE
   imgui
   imguiclub
   implot3d
+  fp16
   nlohmann_json::nlohmann_json
   tinygltf::tinygltf
   glowl::glowl

map/resources/shaders/texture_copy.comp

@@ -0,0 +1,29 @@
+#version 450
+
+layout(local_size_x = 16, local_size_y = 16) in;
+
+layout(binding = 0) uniform sampler2D srcTex;
+layout(binding = 1, rgba8) uniform writeonly image2D dstImg;
+
+uniform int width;
+uniform int height;
+
+float sRGB(float val) {
+    if (val <= 0.0031308) {
+       return 12.92 * val;
+    } else {
+       return 1.055 * pow(val, 1.0 / 2.4) - 0.055;
+    }
+}
+
+void main() {
+    ivec2 coord = ivec2(gl_GlobalInvocationID.xy);
+    if (coord.x >= width || coord.y >= height) {
+        return;
+    }
+    vec4 color = texelFetch(srcTex, coord, 0);
+    color.r = sRGB(color.r);
+    color.g = sRGB(color.g);
+    color.b = sRGB(color.b);
+    imageStore(dstImg, coord, color);
+}

map/src/MapWindow/MapWindow.cpp

@@ -22,6 +22,7 @@
 #include "Utils/FileDialogUtil.h"
 #include "Utils/GLMUtil.h"
 #include "Utils/ResourceUtils.h"
+#include "World/MapLODglTFWriter.h"
 
 Satisfactory3DMap::MapWindow::MapWindow()
     : BaseWindow("Satisfactory3DMap"),
@@ -243,8 +244,15 @@ void Satisfactory3DMap::MapWindow::renderGui() {
     if (ImGui::BeginMenu("Tools")) {
         ImGui::MenuItem("Pak Explorer", nullptr, &pakExplorer_->show(), dataView_->pakManager() != nullptr);
         ImGui::Separator();
+        if (ImGui::MenuItem("Export Map LOD", nullptr, false, dataView_->pakManager() != nullptr)) {
+            const auto file = saveFile("Select file ...", "satisfactory-map.glb");
+            if (file.has_value()) {
+                MapLODglTFWriter writer(dataView_->pakManager());
+                writer.save(file.value());
+            }
+        }
         if (ImGui::MenuItem("Export Save Text")) {
-            auto file = saveFile("Select file ...", "savegame-export.txt");
+            const auto file = saveFile("Select file ...", "savegame-export.txt");
             if (file.has_value()) {
                 saveToTextFile(*dataView_->saveGame(), file.value());
             }

map/src/MapWindow/World/MapLODReader.cpp

@@ -41,7 +41,8 @@ Satisfactory3DMap::MapLODReader::MapLODReader(const std::shared_ptr<Satisfactory
                     throw std::runtime_error("InstanceComponents array missing!");
                 }
 
-                for (const auto& instCompRef : instCompArray->Values) {
+                for (std::size_t instCompIdx = 0; instCompIdx < instCompArray->Values.size(); instCompIdx++) {
+                    const auto& instCompRef = instCompArray->Values[instCompIdx];
                     if (instCompRef.pakValue() <= 0) {
                         continue;
                     }
@@ -58,6 +59,9 @@ Satisfactory3DMap::MapLODReader::MapLODReader(const std::shared_ptr<Satisfactory
                     }
 
                     MapLODMesh LOD_mesh;
+                    LOD_mesh.actorLabel = WPHLOD_obj->ActorLabel;
+                    LOD_mesh.instanceComponentId = instCompIdx;
+
                     LOD_mesh.staticMesh = meshObj;
 
                     const auto& matProp = meshObj->Properties.get<s::ArrayProperty>("StaticMaterials");
@@ -110,7 +114,7 @@ Satisfactory3DMap::MapLODReader::MapLODReader(const std::shared_ptr<Satisfactory
                 }
             }
         } catch (const std::exception& ex) {
-            spdlog::warn("Error loading Pak file: {}", ex.what());
+            spdlog::warn("Error reading Map LOD from Pak file: {}", ex.what());
         }
     }
 }

map/src/MapWindow/World/MapLODReader.h

@@ -15,6 +15,8 @@ namespace Satisfactory3DMap {
             std::shared_ptr<s::UStaticMesh> staticMesh;
             std::shared_ptr<s::UTexture2D> baseColorTexture;
             std::shared_ptr<s::UTexture2D> normalTexture;
+            std::string actorLabel;
+            std::size_t instanceComponentId;
         };
 
         explicit MapLODReader(const std::shared_ptr<SatisfactorySave::PakManager>& pakManager);