[go: up one dir, main page]
Skip to content

TomLeeLive/Synesthesias-libplateau

BranchesTags
 
 

Repository files navigation

Build and Test

libplateau

libplateauはPLATEAUの3D都市モデルを扱うためのC++ライブラリであり、以下の機能を提供しています。

  • CityGMLのパース
  • CityGMLのジオメトリのポリゴンメッシュへの変換
  • 緯度経度座標の直交座標系への変換
  • XYZタイル形式のベースマップへのアクセス
  • 3Dファイル形式へのエクスポート
  • REST APIを使用したPLATEAUのサーバーへのアクセス

libplateauはロジックの共通化によりPLATEAU SDK for UnityとPLATEAU SDK for Unrealの開発を加速させるために活用されています。

開発環境

  • CMake 3.8以降

Windows

  • Visual Studio 2022
    • cmakeを使うためVisual Studio InstallerからC++によるデスクトップ開発のインストールが必要です。

セットアップ

リポジトリクローン

git lfs install
git clone https://github.com/Synesthesias/libplateau
cd libplateau
git submodule update --init --recursive

ビルド

ビルドの方法について、全OSで共通の留意点を記したあと、OSごとのビルド方法を記載します。

共通

1. fbx_sdkを用意する

お手数をおかけして申し訳ございませんが、libplateau をビルドするには別途 fbx_sdk が必要です。 fbx_sdk は Autodesk社が公開するSDKです。これは自由に製品に組み込んで良いものの、オープンソースではなく、再配布は禁止となっております。
そのため、libplateau 自体はオープンソースですが、例外的に fbx_sdk のみ別途ご用意頂く形になっております。
ビルドするためには、Autodesk社が配布しているSDKを指定のディレクトリに配置する必要があります。

  • Autodesk社のWebサイト から、各OS向けのFBXSDKをダウンロードしてインストールします。
  • インストールして得られるファイルを、次のディレクトリ構成に合うように配置します。
    • 3rdparty/fbx_sdk/2020.3.1 以下に配置します。
    • 2020.3.1 以下のディレクトリ構成は、別添のテキストファイル file_tree_of_fbxsdk.txt を参照してください。

2. C++, C# のビルド手順

  • C++ は、CMake を使ってビルドします。CMake は、 Visaul Studio, CLion, コマンド のどれからでも利用できます。
  • Visual Studio のバージョンについては、 Unreal Engine向けのSDK が Visual Studio 2022 を想定しているので、2022を推奨します。
    • Visual Studioを利用する場合、 CMake でビルドするために 「C++によるデスクトップ開発ツール」がインストールされているか確認してください。
      • 確認方法は、Visual Studio Installer を起動 → Visual Studio Community の"変更"ボタン → "C++によるデスクトップ開発" にチェックが入っているか確認してください。
      • 入っていなければインストールしてください。

C# コードの用途

  • C# のコードは、次の2つの役割があります：
    • ユニットテストを回す
    • PLATEAU SDK for Unity で C#コードを利用する
  • Unity については C# コードを直接 Unity にコピーする運用をしているため、コードではない CSharpPLATEAU.dll は使いません。
    • C#の DLL はユニットテストでのみ利用します。
CMakeの設定
  • CMakeでのビルドについて、次の設定が必要です。Visual Studio または CLion で次の設定にしてください。
  • なお、Visual Studio ではビルドディレクトリの冒頭に ${projectDir}/ を付けてください。CLion では ${projectDir}/は不要です。

    • Unity向けRelease (Windows, Mac, Ubuntu共通)

      • ビルドタイプ(構成の種類,CMAKE_BUILD_TYPE) : RelWithDebInfo
      • ビルドディレクトリ(ビルドルート) : out/build/x64-Release-Unity
      • CMakeコマンド引数 : -DBUILD_LIB_TYPE=dynamic -DRUNTIME_LIB_TYPE=MT

    • Unity向けDebug (Windows, Mac, Ubuntu共通)

      • ビルドタイプ(構成の種類,CMAKE_BUILD_TYPE) : Debug
      • ビルドディレクトリ : out/build/x64-Debug-Unity
      • CMakeコマンド引数 : -DBUILD_LIB_TYPE=dynamic -DRUNTIME_LIB_TYPE=MD

    • Mac, Ubuntu : Unreal向けRelease

      • ビルドタイプ(構成の種類,CMAKE_BUILD_TYPE) : RelWithDebInfo
      • ビルドディレクトリ : out/build/x64-Release-Unreal
      • CMakeコマンド引数 : -DBUILD_LIB_TYPE=static -DRUNTIME_LIB_TYPE=MD

    • Windows : Unreal向けRelease

      • ビルドタイプ : RelWithDebInfo
      • ビルドディレクトリ : out/build/x64-Release-Unreal
      • CMakeコマンド引数(Visual Studio向け) : -DBUILD_LIB_TYPE=static -DRUNTIME_LIB_TYPE=MD
      • CMakeオプション(CLion向け) : -DBUILD_LIB_TYPE=static -DRUNTIME_LIB_TYPE=MD -G "Visual Studio 17 2022" -DCMAKE_INSTALL_PREFIX="C:/ninja" -DCMAKE_BUILD_TYPE=RelWithDebInfo

    • Mac, Ubuntu : Unreal向けDebug

      • 注意: Debug ライブラリは通常の Unreal Engine では動きません。通常はReleaseを利用してください。
      • ビルドタイプ(構成の種類,CMAKE_BUILD_TYPE) : Debug
      • ビルドディレクトリ : out/build/x64-Debug-Unreal
      • CMakeコマンド引数 : -DBUILD_LIB_TYPE=static -DRUNTIME_LIB_TYPE=MD

    • Windows : Unreal向けDebug

      • 注意: Debug ライブラリは通常の Unreal Engine では動きません。通常はReleaseを利用してください。
      • ビルドタイプ(構成の種類,CMAKE_BUILD_TYPE) : Debug
      • ビルドディレクトリ : out/build/x64-Debug-Unreal
      • CMakeコマンド引数(Visual Studio向け) : -DBUILD_LIB_TYPE=static -DRUNTIME_LIB_TYPE=MD
      • CMakeオプション(CLion向け) : -DBUILD_LIB_TYPE=static -DRUNTIME_LIB_TYPE=MD -G "Visual Studio 17 2022" -DCMAKE_INSTALL_PREFIX="C:/ninja" -DCMAKE_BUILD_TYPE=Debug

トラブルシューティング

  • CMakeの構成時に GTest に関するエラーが1件出ますが、無視で大丈夫です。
  • IDEは Jetbrains CLion を利用していて、CMake の find_program(MSVC_LIB_TOOL lib.exe) がうまくいかない場合、 CLionのインストール時の設定で Add “bin” folder to the PATH にチェックを入れてください。
  • C++ の libplateau をビルドすると、Unity向けの場合は DLL ができます。
    • 詳しくは下記の、各OS向けのビルド手順を参照してください。
  • その後 C# の LibPLATEAU.NET をビルドすると自動で上述のDLLがコピーされ、C#側で利用可能になります。
  • C++とC#のビルド設定を合わせる必要があります。(C++でRelease 設定でビルドしたなら C# も Release、Debug なら C# も Debug。これを間違うと古いDLLがコピーされます。）
  • ユニットテストの実行時、dllがないという旨のエラーが出る場合、C++ビルド結果の out/build/x64-Debug-Unity or x64-Release-Unity にある
    libplateau が C#のバイナリのディレクトリにコピーされているか確認してください。
    コピーコマンドは CSharpPLATEAU.Test.csproj に記載されており、C#のリビルド時に実行されるはずです。
    このコマンドが正しく動作するか確認してください。

3つのOS向けにまとめてビルド

  • Github Actions でUpload Dlls というワークフローを手動実行すると、
    CIの成果として3つのOS向けにビルドしたライブラリをまとめてダウンロードできます。

Windowsでの手動ビルド

C++のビルド

  • Python3のインストールが必要です。
  • Visual Studioのローカルフォルダーを開くからcloneしたリポジトリを開きます。
  • 一度cmakeこけるので再度cmakeします。(CMakeLists.txt開いてCtrl+S)
  • ビルド実行します。(Ctrl+Shift+B)
  • Unity向けの場合は dll ができます。
    • 場所は out/build/x64-Release(またはDebug)-Unity/bin/plateau.dll です。
  • Unreal向けの場合は lib ができます。
    • 場所は out/build/x64-Release-Unreal/src/plateau_combined.lib がです。
  • plateau_testを実行することでユニットテストを実行可能です

C#のビルド

  • wrappers/csharp/LibPLATEAU.NET.sln を開きます。
  • ビルドする。ただしC++側に変更があった場合、
    最新のDLLをC#側にコピーするため「ビルド」ではなく「リビルド」を選択します。
  • C#ユニットテストも合わせて実行可能です。

Linuxでの手動ビルド

利用する Linux は、Unityの対応OSに合わせて Ubuntu 20.04 とします。

C++のビルド

  • Ubuntu 20 はデフォルトでは git lfs がないので、sudo apt install git-lfs します。
  • OpenGL API が必要なので、なければ以下のコマンドでインストールします。
sudo apt-get install libgl1-mesa-dev libglu1-mesa-dev

  • glTF-sdk のビルドのために PowerShell が必要なので、このWebページを参考に Ubuntu向け PowerShell をインストールします。

  • CMake でビルドするために、Linux向けの CLion を利用することもできますが、代わりに次のコマンドからもビルドできます：
    Unity向けの場合:

cd (プロジェクトのルートディレクトリ)
cmake -S . -B ./out/build/x64-Release-Unity/ -G "Ninja" -D CMAKE_BUILD_TYPE:STRING="RelWithDebInfo" -D CMAKE_INSTALL_PROGRAM="ninja" -D CMAKE_CXX_FLAGS="-w" -D BUILD_LIB_TYPE=dynamic -D RUNTIME_LIB_TYPE=MT
cmake --build ./out/build/x64-Release-Unity/ --config RelWithDebInfo

ただし Debug ビルドの場合は RUNTIME_LIB_TYPE=MD

Unreal Engine向けの場合:

cmake -S . -B ./out/build/x64-Release-Unreal/ -G "Ninja" -D CMAKE_BUILD_TYPE:STRING="RelWithDebInfo" -D CMAKE_INSTALL_PROGRAM="ninja" -D CMAKE_CXX_FLAGS="-w" -D BUILD_LIB_TYPE=static -D RUNTIME_LIB_TYPE=MD
cmake --build ./out/build/x64-Release-Unreal/ --config RelWithDebInfo

C#のビルド

  • マシンに dotnet をインストールします。
  • 以下のコマンドを実行します。
cd (プロジェクトのルートディレクトリ）
cd ./wrappers/csharp/LibPLATEAU.NET
dotnet build -c Release
  • 合わせてユニットテストもする場合は以下を実行します。
dotnet test -c Release

MacOSでの手動ビルド

C++ビルドに必要なもの

  • PowerShell をMacにインストールする必要があります。 brew でインストールしてください。
  • cmakeのビルドディレクトリを上記のように設定してビルドします。
  • 成果物の場所：
    • Unityなら out/build/x64-Release(またはDebug)-Unity/src/libplateau.dylib
    • Unrealなら out/build/x64-Release(またはDebug)-Unreal/src/libplateu_combined.a

C#ビルドに必要なもの

  • dotnet Core 3.1 を利用します。
    • IDEにRiderを利用している場合、デフォルトで dotnet core 7 になっているので 3.1 をインストールしてそちらを利用するように設定を変えます。

デプロイ

Unity

PLATEAU SDK for Unityへの導入については、そちらのREADMEを参照してください。

ディレクトリ構成

  • 3rdparty
    • 外部ライブラリはすべてここにsubmoduleで追加します。(fbx_sdkは例外です。)
    • 利用ライブラリについては後述の「ライセンス管理」を参照してください。
  • data
    • テスト用のデータを配置します。ビルド時に出力先ディレクトリにコピーされます。
  • include
    • ヘッダファイル一式を配置します。
  • src
    • 内部実装のソースコードを配置します。
  • test
    • ユニットテストを配置します。
  • wrappers
    • 他言語向けのwrapper実装を配置します。
  • .github/workflows
    • Github Actionsのワークフロー設定を配置します。

テストデータ

テストデータの詳細については data/README.md を参照してください。

モックサーバー

モックサーバーについては PLATEAU-API-Mock-v3 を参照してください。

実装上の注意

文字コード

  • gmlのパース結果はC++の内部では UTF-8 で保持しています。
    • パーサー xerces-c は本家の挙動ではAnsiに変換して保持しますが、その挙動をUTF-8に変えました。Unityから日本語文字を扱う都合上の改変です。
  • デバッグTIPS
    • マルチバイト文字を扱う処理で、手元のマシンだと動くけどCIサーバーだと動かないという状況のときは、
      Windowsのロケール設定を日本語から英語に変えると手元のマシンで状況が再現することがあります。

CI (継続的インテグレーション)

Github Actions によるCIを導入しています。
Windows, Mac, Linux でのテストと成果物のダウンロードができます。

  • push時、自動でビルドおよびユニットテストが行われます。
  • git tagを付けた時、またはgithubサイトから手動で Upload DLLs を実行したときにビルドが走り、 成果物となるDLL等を3つのOS向けにダウンロードできます。 githubサイトから手動で実行するには、 Actions → Workflows から Upload DLLs を選択 → Run workflow からブランチを選んで実行します。 成果物を all-library という名前のzipでダウンロードできます。

コード規約

  • 変数名は snake_case , 関数名は lowerCamel
  • private static メソッドはヘッダファイルに書かず、.cppの無名名前空間に書く
  • 外に見せる必要の無いクラス (C#でいうinternalクラス) のヘッダーファイルの配置ディレクトリはincludeではなくsrc
  • [[nodiscard]] は書かない
  • ファイルの末尾は改行
  • 何かの個数を取得する関数名は get(単数形)Count
  • * & の位置は左寄せ (SomeType *foobar ではなく SomeType* foobar)
  • Unreal Engine で利用する都合上、ヘッダーファイルで std::filesystem は利用しない
    • .cppファイル内での利用は可
    • パスの受け渡しは string(中身はutf8形式) で行い、.cpp内でauto path = std::filesystem::u8path(path_str)でpathに直す
  • コンテナ要素へのアクセスは[i]ではなく.at(i)を用いる。
    • Unityから利用する際範囲外アクセスでクラッシュしてしまうため。後者は例外として捕捉できる。

トラブルシューティング

  • Q. 手元のマシンではユニットテストが通るのに、CIサーバーの自動テストが通りません。
  • A. 手元のマシンとCIサーバーでの設定の差によるバグを疑ってみましょう。例えば:
    • Windowsの設定で　言語の設定 → 管理用言語の設定 → システムロケールの変更 について、 CIサーバーでは英語（米国）ですが、 手元のマシンでは日本語になっているケースです。これはパスなどの文字コードに影響します。 パスの文字列をUTF8で扱えていれば、システムロケールが英語でも日本語でも日本語を含むパス文字列に対応します。 しかし、パス文字列をUTF8で扱えていなければ、システムロケールが英語のとき、日本語名を含むパス文字列は文字化けします。

ライセンス

ライセンス管理

サードパーティソフトの権利表記をThirdPartyNotices.mdに記載してください。

About

No description, website, or topics provided.

Resources

Readme

License

View license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

7 tags

Packages

No packages published

Languages

  • C++ 59.0%
  • C# 35.3%
  • HTML 3.2%
  • CMake 2.4%
  • Game Maker Language 0.1%
  • C 0.0%