Unityのラインタイム中に表現に利用する3Dモデルを動的に差し替える

はじめに

Unityを使うと様々な用途で使えるアプリが簡単に作成できます。
DCC、CAD、BIMなど様々な3Dモデルをコンテンツの一部として表現に利用することができますが、それらの3Dモデルを変更する度にアプリを更新するのでは手間がかかります。
実現方法はいろいろとあると思いますが、ここではglTFastを使います。
https://github.com/atteneder/glTFast

なぜUnity glTFastか？

CADやBIMといった産業用データをUnityに取り込む場合、Pixyz製品を利用することが一般的です。
データ変換処理を自動化するPixyz Scenario Processorではデータ処理ワークフローの解説として以下の例を挙げており、その中でUnity glTFastが登場しています。

サポートファイルフォーマットにサポート拡張子や用途が記述されています。

環境構成

• Unity 2022.1.23f1
• glTFast 5.0.0
• GitHub (ここでは表示したいglb/gltfを公開するWebサーバーの代替として利用)

ここではコンテンツの配信にGitHubを利用しましたg、本格的に使う際には別のWebサーバーに置き換わります。
この確認ではPublicのGitHubを使うので認証がなくデータにアクセスできていますが、その点は求めるセキュリティレベルに応じた検討が必要です

Unity glTFastのUrlは以下の様にhttpsとfileの２通りの指定が可能（手順内ではhttpsについて記述）
　1. https://○○.gltf
　2. file://○○.gltf

上記の環境で動かすとシーン内に表示する3Dモデル(Adamの顔、トカゲ、アヒル)をUnityのProject内にAssetとして持たせていなくても、ランタイム実行中にWebサーバーから3Dモデルを取得して表示させることができます。

手順

1. 前述glTFastのGitHubリポジトリよりUnity Installer Packageをダウンロードする
2. Assets > Import Package > Custom PackageからglTFをインポートする
   
3. glTFがインポートできるとGameObjectに追加できるComponentでGltf AssetとGltf Bounds Assetが利用できるようになる

この先はgltf AssetをUIからComponentとして追加して利用するか、Scriptから利用するかで異なりますので、
利用する方法に応じた以下のセクションをご確認ください。

InspectorでComponentを追加する場合

4. Hierarchyで空のGameObjectを追加する(右クリック > Create Empty)
5. そのGameObjectのInspectorでGltf Assetをコンポーネントとして追加する
6. 追加したGltf AssetコンポーネントのUrlに取得したい3Dモデルのアドレスをセットする
   
   Urlに指定したアドレス

https://github.com/takaakikawasaki/dataStorage/raw/main/glb/AdamHead.glb

7. この状態でUnity EditorでPlay Modeに入るとUrlのアドレスに対してWebRequestが発行され、3Dモデルのシーン内へのロードが実行される

Scriptの場合

4. Hierarchyで空のGameObjectを追加する(右クリック > Create Empty)
5. そのGameObjectのIspectorでNew Scriptを追加する

using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
using GLTFast;

public class ChangeGlb : MonoBehaviour
{
    //glb,gltfを取得するURLは外部サービスから取得し、UIのDropdownと連動させれば動的に変えることができる。
    static string option1 = "https://github.com/takaakikawasaki/dataStorage/raw/main/glb/AdamHead.glb";
    static string option2 = "https://github.com/takaakikawasaki/dataStorage/raw/main/glb/15f772d7febd45a48d3cecf1cef6fe10.glb";
    static string option3 = "https://raw.githubusercontent.com/KhronosGroup/glTF-Sample-Models/master/2.0/Duck/glTF/Duck.gltf";
    private GLTFast.GltfAsset gltf;

    private void Start()
    {
        gltf = gameObject.AddComponent<GLTFast.GltfAsset>();
        gltf.Url = option1;
    }

    public void OnValueChanged(int value)
    {
        switch (value)
        {
            case 0:
                gltf.Dispose();
                gltf = gameObject.AddComponent<GLTFast.GltfAsset>();
                gltf.Url = option1;
                break;
            case 1:
                gltf.Dispose();
                gltf = gameObject.AddComponent<GLTFast.GltfAsset>();
                gltf.Url = option2;
                break;
            default:
                gltf.Dispose();
                gltf = gameObject.AddComponent<GLTFast.GltfAsset>();
                gltf.Url = option3;
                break;
        }
    }
}

6. この状態でUnity EditorでPlay Modeに入るとUrlのアドレスに対してWebRequestが発行され、3Dモデルのシーン内へのロードが実行される

GitHubにUnity PJのRuntimeGltfSwitchも置きました。
このPJをロードし、OutdoorSceneでPlayするとglTFastで外部サーバーからデータを取得する動作が確認できます。
ここではoptions.jsonというDropdownに表示するオプションリストと取得するUrlの組み合わせのファイルをAwake()で取得していますので、例えば公開したい3Dデータ(glb/gltf)が増えた場合でもこのoptions.jsonを編集することで対応を増やすことができる、みたいな感じになってます。
初回起動時にLibraryなどの構築が行われるのでエラーが出たりロードが遅かったりするかもしれませんが、２回目以降は正常に動くと思います。

さいごに

Unity glTFastにはEditorでデザイン時のデータのImport、データのExportといった機能もありますが、ここではランタイム時のデータのロードについて記述しました。