初めての自作Unityエディタ拡張 #Unity

この記事はNTTコムウェア Advent Calendar 2022 20日目の記事です。

本記事ではエディタ拡張を自作してみたいけど難しそうという人向けに、例題に沿って簡単なUnity拡張の作り方を説明します。

UI Builderというものを使いますので比較的新しいUnityが必要です。
2021以降からコア機能となっていて、それ以前(2019.4～)はpackage installが必要だそうです。

本記事作成の環境はUnity Versionは2022.1.5f1.3268です。

例題

あるモデルのMesh RendererのMaterialを、他3つのモデルに一括コピーする事を目的とします。

手順

ウィンドウを作る
ウィンドウの中身を作る
処理を書く
動作確認する

ウィンドウを作る

ウィンドウを作ってみましょう。
Assets直下に適当なフォルダを作り、そのフォルダの中にEditorというフォルダを作ります。
Editorフォルダ内で新しいC# Scriptを作成します。頭を大文字にしてまた適当な名前をつけましょう。

C# Scriptファイルを作ったらダブルクリックして開きましょう。エディタ関連付けを済ませてない人はこちらなどを参考にして関連付けしましょう。

UnityのC#エディタをVsCodeにして使う設定【Windows編】2022年8月

開いたら以下のような感じでコードを書きます。

Tomato.cs

using UnityEngine;
using UnityEditor;

public partial class Tomato : EditorWindow {

    [MenuItem("TOMATO/まとめてコピー")] // ヘッダメニュー名/ヘッダ以下のメニュー名
    private static void ShowWindow() {
        var window = GetWindow<Tomato>("UIElements");
        window.titleContent = new GUIContent("tomato"); // エディタ拡張ウィンドウのタイトル
        window.Show();
    }
}

エディタからUnityに戻るとメニューが増えています。クリックしてみましょう。

空の画面が表示されます。第一歩です！

ウィンドウの中身を作る

UI Builderで部品をぺたぺた貼る感じで画面を作れます。

ヘッダメニューのWindow -> UI Toolkit -> UI Builderを開きます。

開いたらUI Builder画面内のLibrary右上メニューからEditor Extension Authoringにチェックを付けましょう。UI Builderはエディタ以外の画面を作るのがメインなのでエディタ用部品は最初非表示になっています。

あとは文字を表示するためのラベルとモデルを受け取るためのObject Fieldをドラッグ＆ドロップでぺたぺたしましょう。

LabelのText、Object FieldのLabelを編集しましょう。

多分出来たと思うので先程作ったEditor内に保存しましょう。UI Builder内のViewportのFileメニューからUxml(構造情報)を、StyleSheetsの＋マークメニューからUss(見た目情報)を保存します。名前は適当につけてください。

次はUxmlとUssを先程のウィンドウに関連付けしましょう。先程のc# Scriptを開いて追記しましょう。using UnityEngine.UIElements;が追加されているのに気をつけて下さい。

Tomato.cs

using UnityEngine;
using UnityEditor;
using UnityEngine.UIElements; // 追加

public partial class Tomato : EditorWindow {

    [MenuItem("TOMATO/まとめてコピー")]
    private static void ShowWindow() {
        var window = GetWindow<Tomato>("UIElements");
        window.titleContent = new GUIContent("tomato");
        window.Show();
    }

    // 以下追加
    [SerializeField] private VisualTreeAsset _rootVisualTreeAsset;
    [SerializeField] private StyleSheet _rootStyleSheet;

    private void CreateGUI() {
        _rootVisualTreeAsset.CloneTree(rootVisualElement);
        rootVisualElement.styleSheets.Add(_rootStyleSheet);
    }
}

Unityで先程のC# ScriptをクリックするとRoot Visual Tree AssetとRoot Style Sheetが設定できるようになっているのでUxmlとUssをドラッグ＆ドロップして設定しましょう。

もう一度メニューを選ぶと作った画面が開かれます。

処理を書く

次は処理を書きましょう。
各フィールドやボタンを指定するための識別子が欲しいのでまたUI Builderで設定します。（ついでにボタン忘れてたのでボタンも追加しましょう）
Uxmlファイルを選択してInspectorにあるOpenボタンをクリックしてUxmlをUI Builderで開きましょう。

それぞれの部品を選択してInspectorからNameを設定しましょう。

また、オブジェクトを設定できるように全てのObject FieldのTypeにGame Objectを設定します。

次はつけたNameを使って処理を書いていきます。using UnityEditor.UIElements;が追加されているのに気をつけて下さい。

Tomato.cs

using UnityEngine;
using UnityEditor;
using UnityEngine.UIElements;
using UnityEditor.UIElements; // 追加

public partial class Tomato : EditorWindow {

    [MenuItem("TOMATO/まとめてコピー")]
    private static void ShowWindow() {
        var window = GetWindow<Tomato>("UIElements");
        window.titleContent = new GUIContent("tomato");
        window.Show();
    }

    [SerializeField] private VisualTreeAsset _rootVisualTreeAsset;
    [SerializeField] private StyleSheet _rootStyleSheet;

    private void CreateGUI() {
        _rootVisualTreeAsset.CloneTree(rootVisualElement);
        rootVisualElement.styleSheets.Add(_rootStyleSheet);

        // 以下追加
        var copyButton = rootVisualElement.Q<Button>("copy_btn");
        copyButton.clicked += () => {
            var moto1 = (GameObject)rootVisualElement.Q<ObjectField>("moto1_obj").value;
            var saki1 = (GameObject)rootVisualElement.Q<ObjectField>("saki1_obj").value;
            var saki2 = (GameObject)rootVisualElement.Q<ObjectField>("saki2_obj").value;
            var saki3 = (GameObject)rootVisualElement.Q<ObjectField>("saki3_obj").value;
            saki1.GetComponent<Renderer>().sharedMaterial = moto1.GetComponent<Renderer>().sharedMaterial;
            saki2.GetComponent<Renderer>().sharedMaterial = moto1.GetComponent<Renderer>().sharedMaterial;
            saki3.GetComponent<Renderer>().sharedMaterial = moto1.GetComponent<Renderer>().sharedMaterial;
        };
    }
}