Unreal向けに静的ビルドをできるようにしました。 (Synesthesias#153)

* cmake : コンパイル MT,MD,MTd,MDd の場合分け

* fbxsdkを4通り、debug/mt, debug/md, release/mt, release/md で場合分け

* FBXSDKの名称をOSで場合分け

* ローカルでのユニットテストが落ちるのを修正

* github actions調整

* github actions修正

* Update readme

* github actions修正

* 同上

* 同上

* 同上

* linux build fix

* ubuntu 18 から 20.04 に移行

* linux fix

* 同上

* ライセンスをMITに変更

* 静的ビルドのリンクエラー修正中

* 同上

* github actions windows対応

* mac, linux向けの静的ビルド仮置き

* 同上

* 同上

* 同上

* fix linux build

* fix linux

* update libcitgygml

* fix for windows unreal

* 同上

* 同上

* 同上

* 同上

* fix mac libplateau name

* update readme

* turn off xerces-c network build

* fix how to build

* fix xerces-c trancoder issue of mac

* MTをMDに変更

* ユニットテストを本番サーバーに依存しないようにした

* ビルド方法ごとの違いに対応し、Unity向けでもUnreal向けでもユニットテストが通るようにした

* cmakeで書き方が変なところを修正

* テスト微修正

* #define LIBPLATEAU_BUILD_DYNAMIC　がCMakeから追加されないバグを修正

* CMake修正

* UnityのDebugビルドのときはMDに

* 微修正

* Meshのコンストラクタを高速化

* merge shapeを事前に頂点数を求めることで高速化

* demのLODを取得できていなかったバグを修正

* citygmlのgitignore変更をrevertt

Author: linoal

.github/actions/build/action.yml

@@ -45,21 +45,58 @@ runs:
       shell: ${{ inputs.shell_type }}
       # Ubuntu 18 だとデフォルトでは g++-7 になりますが、std::filesystem を使う都合上 g++-9 を指定します。
 
-    - name: Configure CMake
+    - name: Configure CMake for Unity
       run: >
         cmake
         -S ${{github.workspace}} 
-        -B ${{github.workspace}}/out/build/x64-Release 
+        -B ${{github.workspace}}/out/build/x64-Release-Unity 
         -G "Ninja" 
         -D CMAKE_BUILD_TYPE:STRING="${{env.BUILDTYPE}}" 
         -D CMAKE_CXX_FLAGS="-w"
+        -D BUILD_LIB_TYPE=dynamic
+        -D RUNTIME_LIB_TYPE=MT
         ${{ env.ADDITIONAL_CMAKE_OPTIONS }}
       shell: ${{ inputs.shell_type }}
     # 10万行超えの警告が出るので一時的な処置として警告を抑制しています。
 
 
-    - name: Build by CMake
-      run: cmake --build ${{github.workspace}}/out/build/x64-Release --config ${{env.BUILD_TYPE}}
+    - name: Build by CMake for Unity
+      run: cmake --build ${{github.workspace}}/out/build/x64-Release-Unity --config ${{env.BUILD_TYPE}}
+      shell: ${{ inputs.shell_type }}
+
+    - name: Configure CMake for Unreal for non-Windows
+      if: runner.os != 'Windows'
+      run: >
+        cmake
+        -S ${{github.workspace}}
+        -B ${{github.workspace}}/out/build/x64-Release-Unreal
+        -G "Ninja"
+        -D CMAKE_BUILD_TYPE:STRING="${{env.BUILDTYPE}}"
+        -D CMAKE_CXX_FLAGS="-w"
+        -D BUILD_LIB_TYPE=static
+        -D RUNTIME_LIB_TYPE=MD
+        ${{ env.ADDITIONAL_CMAKE_OPTIONS }}
+      shell: ${{ inputs.shell_type }}
+
+    # Unreal Engine側と Visual Studio のバージョンを合わせる必要があります。
+    - name: Configure CMake for Unreal for Windows
+      if: runner.os == 'Windows'
+      run: >
+        cmake
+        -S ${{github.workspace}}
+        -B ${{github.workspace}}/out/build/x64-Release-Unreal
+        -G "Visual Studio 16 2019"
+        -D CMAKE_INSTALL_PREFIX="C:/ninja"
+        -D CMAKE_BUILD_TYPE:STRING="${{env.BUILDTYPE}}"
+        -D CMAKE_CXX_FLAGS="-w"
+        -D BUILD_LIB_TYPE=static
+        -D RUNTIME_LIB_TYPE=MD
+        ${{ env.ADDITIONAL_CMAKE_OPTIONS }}
+      shell: ${{ inputs.shell_type }}
+
+    - name: Build by CMake for Unreal
+      run: |
+        cmake --build ${{github.workspace}}/out/build/x64-Release-Unreal --config ${{env.BUILD_TYPE}}
       shell: ${{ inputs.shell_type }}
 
 

.github/workflows/build-and-test.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-latest, macos-latest, ubuntu-18.04]
+        os: [windows-2019, macos-latest, ubuntu-20.04]
 
     steps:
 
@@ -40,7 +40,7 @@ jobs:
 
     - name: Run Test
       run: |
-        cd ${{github.workspace}}/out/build/x64-Release/bin
+        cd ${{github.workspace}}/out/build/x64-Release-Unity/bin
         ./plateau_test
 
     - name: Run Test of C# Wrapper

.github/workflows/upload-dlls.yml

@@ -22,7 +22,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [windows-latest, macos-latest, ubuntu-18.04]
+        os: [windows-2019, macos-latest, ubuntu-20.04]
 
     steps:
 
@@ -47,34 +47,34 @@ jobs:
         if: runner.os == 'Windows'
         run: |
           mkdir D:\a\output -Force
-          Copy-Item -Filter "*.dll" -Path ${{github.workspace}}\out\build\x64-Release\bin\* -Destination D:\a\output
+          Copy-Item -Filter "*.dll" -Path ${{github.workspace}}\out\build\x64-Release-Unity\bin\* -Destination D:\a\output
           Copy-Item -Path ${{github.workspace}}\wrappers\csharp\LibPLATEAU.NET\CSharpPLATEAU\bin\Release\netstandard2.0\CSharpPLATEAU.dll -Destination D:\a\output
 
       - name: Copy lib for Windows
         if: runner.os == 'Windows'
         run: |
-          Copy-Item -Path ${{ github.workspace }}\out\build\x64-Release\3rdparty\libcitygml\lib\citygml.lib -Destination D:\a\output
-          Copy-Item -Path ${{ github.workspace }}\out\build\x64-Release\src\plateau.lib -Destination D:\a\output
+          Copy-Item -Path ${{ github.workspace }}\out\build\x64-Release-Unreal\src\${{env.BUILD_TYPE}}\plateau_combined.lib -Destination D:\a\output
 
       - name: Upload DLL for Windows
         if: runner.os == 'Windows'
         uses: actions/upload-artifact@v2
         with:
-          name: libplateau-windows-dll
+          name: libplateau-windows
           path: D:\a\output
 
       - name: Copy Libraries for Ubuntu and MacOS
         if: runner.os != 'Windows'
         run: |
           mkdir $HOME/output/
-          find ${{github.workspace}}/out/build/x64-Release -name *.so -or -name *.dylib -or -name libcitygml.a | xargs -I {} cp -v {} $HOME/output
+          find ${{github.workspace}}/out/build/x64-Release-Unity -name *.so -or -name *.dylib | xargs -I {} cp -v {} $HOME/output
+          find ${{github.workspace}}/out/build/x64-Release-Unreal -name libplateau*.a | xargs -I {} cp -v {} $HOME/output
           echo "HOME=$(echo $HOME)" >> $GITHUB_ENV
 
       - name: Upload DLL(so, dylib) for Ubuntu and MacOS
         if: runner.os != 'Windows'
         uses: actions/upload-artifact@v2
         with:
-          name: libplateau-${{matrix.os}}-dll
+          name: libplateau-${{matrix.os}}
           path: ${{env.HOME}}/output/
 
   # 2つ目のジョブ。
@@ -206,10 +206,10 @@ jobs:
           mkdir -p ~/a/plateau-plugins/dynamic-libs/ManagedDLL
           mkdir -p ~/a/plateau-plugins/dynamic-libs/Android
           mkdir -p ~/a/plateau-plugins/dynamic-libs/iOS/plateau.framework
-          cp ~/a/libplateau-windows-dll/plateau.dll ~/a/plateau-plugins/dynamic-libs/Windows/x86_64
-          cp ~/a/libplateau-windows-dll/CSharpPLATEAU.dll ~/a/plateau-plugins/dynamic-libs/ManagedDLL
-          cp ~/a/libplateau-ubuntu-18.04-dll/*.so ~/a/plateau-plugins/dynamic-libs/Linux/x86_64
-          cp ~/a/libplateau-macos-latest-dll/*.dylib ~/a/plateau-plugins/dynamic-libs/MacOS/x86_64
+          cp ~/a/libplateau-windows/plateau.dll ~/a/plateau-plugins/dynamic-libs/Windows/x86_64
+          cp ~/a/libplateau-windows/CSharpPLATEAU.dll ~/a/plateau-plugins/dynamic-libs/ManagedDLL
+          cp ~/a/libplateau-ubuntu-20.04/*.so ~/a/plateau-plugins/dynamic-libs/Linux/x86_64
+          cp ~/a/libplateau-macos-latest/*.dylib ~/a/plateau-plugins/dynamic-libs/MacOS/x86_64
           cp ~/a/libplateau-android-dll/libplateau.so ~/a/plateau-plugins/dynamic-libs/Android
           cp ~/a/libplateau-ios-dll/* ~/a/plateau-plugins/dynamic-libs/iOS/plateau.framework
 
@@ -218,9 +218,9 @@ jobs:
           mkdir -p ~/a/plateau-plugins/static-libs/windows
           mkdir -p ~/a/plateau-plugins/static-libs/linux
           mkdir -p ~/a/plateau-plugins/static-libs/macos
-          cp ~/a/libplateau-windows-dll/*.lib ~/a/plateau-plugins/static-libs/windows
-          cp ~/a/libplateau-ubuntu-18.04-dll/*.a ~/a/plateau-plugins/static-libs/linux
-          cp ~/a/libplateau-macos-latest-dll/*.a ~/a/plateau-plugins/static-libs/macos
+          cp ~/a/libplateau-windows/*.lib ~/a/plateau-plugins/static-libs/windows
+          cp ~/a/libplateau-ubuntu-20.04/*.a ~/a/plateau-plugins/static-libs/linux
+          cp ~/a/libplateau-macos-latest/*.a ~/a/plateau-plugins/static-libs/macos
 
       - name: upload artifact
         uses: actions/upload-artifact@v3

3rdparty/libcitygml

@@ -8,10 +8,14 @@
 # README.md を参照するか、 .github/actions/build/action.yml の Configure CMake の箇所を参照してコマンド例とします。
 
 # 【ビルドの方針】
+# [Unity向けビルドの場合]
 # 最終的に libplateau.dll (または .so , .dylib ) が1つだけ出力されるようにします(example, libを除く)。
 # なぜなら soファイルが複数できてしまうと、Unityに取り込んだときに .so同士の依存関係が解決されず DllNotFoundExceptionになるためです。
 # ビルド時の依存関係を矢印で表すと次のようになります。
 # plateau.dll (c_wrapperを含む)  --> (3rdparty/libcitygml, 3rdparty/xerces_c)
+#
+# [Unreal Engine向けビルドの場合]
+# 静的ライブラリをビルドします。
 
 # 【トラブルシューティング】
 # Linux の Unity で DllNotFoundException になった場合
@@ -21,22 +25,49 @@
 # ldd ./libplateau.so | grep "not found”
 
 
-# github actions で cmakeのオプション -S -B を使いたいのでこれを最小バージョンとします。
-cmake_minimum_required(VERSION 3.13)
+cmake_minimum_required(VERSION 3.8)
+cmake_policy(SET CMP0076 NEW)
+
+# 引数チェック
+# cmakeの引数で、次の変数が指定される必要があります。
+# ・ -D BUILD_LIB_TYPE=static or dynamic        ビルドするのは静的ライブラリか動的ライブラリか
+# ・ -D RUNTIME_LIB_TYPE=MT or MD               (Windowsのみ) MT か MD か
+# デフォルト値は Unity向けに dynamic, MT です。ただし Debugビルドの時は Unity でも MD にしてください。
+SET(BUILD_LIB_TYPE "dynamic" CACHE STRING "static or dynamic")
+SET(RUNTIME_LIB_TYPE "MT" CACHE STRING "MT or MD")
+if(NOT ( BUILD_LIB_TYPE STREQUAL "static" OR BUILD_LIB_TYPE STREQUAL "dynamic"))
+  message(FATAL_ERROR "Variable not set. use -D BUILD_LIB_TYPE=static or dynamic")
+endif()
+if(NOT (RUNTIME_LIB_TYPE STREQUAL "MT" OR RUNTIME_LIB_TYPE STREQUAL "MD"))
+  message(FATAL_ERROR "Variable not set. use -D RUNTIME_LIB_TYPE=MT or MD")
+endif()
 
 # MSVC_RUNTIME_LIBRARYプロパティを有効化
 # 参考：https://cmake.org/cmake/help/latest/policy/CMP0091.html
 if(POLICY CMP0091)
   cmake_policy(SET CMP0091 NEW)
 endif()
 
-# MDd or MTでコンパイル
-set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:DebugDLL>")
+# (Windows向け) MT or MD or MTd or MDd のどれでコンパイルするか決めます。
+# CMAKE_MSVC_RUNTIME_LIBRARY の値は最終的に次の4択のどれかになります:
+# MultiThreaded, MultiThreadedDebug, MultiThreadedDll, MultiThreadedDebugDll
+set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded")
+if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+  string(APPEND CMAKE_MSVC_RUNTIME_LIBRARY "Debug" )
+endif()
+if(RUNTIME_LIB_TYPE STREQUAL "MD")
+  string(APPEND CMAKE_MSVC_RUNTIME_LIBRARY "DLL")
+endif()
+message("CMAKE_MSVC_RUNTIME_LIBRARY = ${CMAKE_MSVC_RUNTIME_LIBRARY}")
+
+
 
 enable_language(CXX)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_EXTENSIONS OFF)
+message(compiler_id = ${CMAKE_CXX_COMPILER_ID}, compiler_version = ${CMAKE_CXX_COMPILER_VERSION})
+
 
 
 # Xerces-C ライブラリの問題を修正するための措置です。
@@ -54,15 +85,18 @@ project("libplateau")
 
 set(LIBPLATEAU_BINARY_DIR ${libplateau_BINARY_DIR}/bin)
 
+
+
 # Linuxで shared library を作るときにはコンパイルオプション -fPIC が必要なので付加します。
 # ただし、Windowsの MSVC でコンパイルするときは -fPIC が不要で、付けると警告が出るので付加しません。
 include(CheckCXXCompilerFlag)
 check_cxx_compiler_flag(-fPIC COMPILER_SUPPORTS_PIC)
-if(COMPILER_SUPPORTS_PIC)
+if(COMPILER_SUPPORTS_PIC AND (BUILD_LIB_TYPE STREQUAL "dynamic"))
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fPIC")
 endif()
 
+
 # ソースファイルの文字コードはデフォルトでは、 Windows日本語版のMSVC だと Shift_JIS、それ以外だと UTF-8 です。
 # 今回は文字コードを統一したいので UTF-8 にします。
 add_compile_options("$<$<C_COMPILER_ID:MSVC>:/utf-8>")
@@ -76,6 +110,12 @@ if( NOT(IOS OR ANDROID) )
   ## Xerces-C をビルドします。
   ### libcitygmlのFindXercesを通すために全てキャッシュ化
   set(BUILD_SHARED_LIBS false CACHE BOOL "" FORCE)
+  ### Xerces-cのうちネットワーク機能はビルドしません
+  set(network false CACHE BOOL "" FORCE)
+  ### macOSの場合に Xerces-C が利用する transcodedr を指定します。
+  if(APPLE)
+    set(transcoder macosunicodeconverter CACHE BOOL "" FORCE)
+  endif()
   add_subdirectory("3rdparty/xerces-c")
   set(XERCESC_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/xerces-c/src" "${libplateau_BINARY_DIR}/3rdparty/xerces-c/src" CACHE STRING "" FORCE)
   set(XERCESC_LIBRARY xerces-c CACHE STRING "" FORCE)
@@ -88,7 +128,10 @@ set(LIBCITYGML_USE_GDAL OFF CACHE BOOL "" FORCE)
 set(XERCESC_WAS_STATIC ON CACHE BOOL "" FORCE)
 
 set(LIBCITYGML_DYNAMIC OFF CACHE BOOL "" FORCE)
+
+
 add_subdirectory("3rdparty/libcitygml")
+
 set(LIBCITYGML_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/libcitygml/sources/include")
 
 ## glTF-SDK
@@ -98,13 +141,16 @@ set(GLTFSDK_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/glTF-SDK/glTF-SDK/GLTF
 if( NOT(IOS OR ANDROID) )
   # FBX SDK 以下のディレクトリで debug と release のどちらを利用するか決めます。
   # debug なら debug/*-md.lib を使い、release なら release/*-mt.lib を使います。
-  if(${CMAKE_BUILD_TYPE} STREQUAL "Debug")
-    set(FBXSDK_LAST_DIR_NAME "debug")
+  if(RUNTIME_LIB_TYPE STREQUAL "MD")
     set(FBXSDK_MT_OR_MD "md")
   else()
-    set(FBXSDK_LAST_DIR_NAME "release")
     set(FBXSDK_MT_OR_MD "mt")
   endif()
+  if(CMAKE_BUILD_TYPE STREQUAL "Debug")
+    set(FBXSDK_LAST_DIR_NAME "debug")
+  else()
+    set(FBXSDK_LAST_DIR_NAME "release")
+  endif()
 
   ## zlib(FBX SDKの依存関係)
   include_directories("${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/zlib")
@@ -156,10 +202,16 @@ if( NOT(IOS OR ANDROID) )
   endif()
 
   set(FBXSDK_LIB_PATH_SUFFIXES "${FBXSDK_LIB_PATH_SUFFIXES}/${FBXSDK_LAST_DIR_NAME}")
+  set(FBXSDK_LIB_NAME "libfbxsdk")
+  if(WIN32)
+    string(APPEND FBXSDK_LIB_NAME "-${FBXSDK_MT_OR_MD}")
+  else()
+    string(APPEND FBXSDK_LIB_NAME ".a")
+  endif()
 
   find_library(FBXSDK_LIBRARIES
     NAMES
-      libfbxsdk-md libfbxsdk-mt libfbxsdk.a
+      ${FBXSDK_LIB_NAME}
     PATHS
       ${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/fbx_sdk/2020.3.1/lib
     PATH_SUFFIXES
@@ -170,16 +222,21 @@ if( NOT(IOS OR ANDROID) )
   message("${FBXSDK_LIB_PATH_SUFFIXES} , ${FBXSDK_LIBRARIES}")
 endif()
 
+## openssl
+add_subdirectory("3rdparty/openssl-cmake")
+
 # cpp-httplib
+set(HTTPLIB_COMPILE TRUE CACHE BOOL "" FORCE)
 add_subdirectory("3rdparty/cpp-httplib")
 set(CPPHTTPLIB_INCLUDE "${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/cpp-httplib")
 
-## openssl
-add_subdirectory("3rdparty/openssl-cmake")
+####################################
+# libplateau 本体の Cmake ファイルです。
 
-# libplateau をビルドします。
 add_subdirectory("src")
 
+####################################
+
 if( NOT(IOS OR ANDROID) )
   ## Examples
   add_subdirectory("examples/log_skipped_elements")