【Untiy】エディタ拡張でフォルダを階層表示してトグルで選択する

エディタ拡張でフォルダを折り畳んで階層表示するで、フォルダの横にトグルを表示して、トグルで選択したフォルダのパスだけを表示してみます。

エディタウィンドウを作る

フォルダのパスを検索して階層構造にして表示するのは、前の記事と同じですが、今回はトグルも表示するので、フォルダのパスを表すクラスに、トグルで選択されているかどうかのbool型のフィールドを作りました。

public class PathData
{
    // 子のパスデータのリスト
    public List<PathData> children { get; } = new List<PathData>();

    // 文字列のパス
    public string Value { get; private set; }

    // コンストラクタ
    public PathData(string value)
    {
        Value = value;
    }

    // 折りたたみが開いているかどうか
    public bool foldout;

    // トグルで選択されているかどうか
    public bool toggle;
}

このフィールドの値をGUILayout.Toggleメソッドの引数に渡して、同じ変数で戻り値を受け取ります。

                using (new EditorGUILayout.HorizontalScope())
                {
                    // トグルを表示
                    rootPath.toggle = GUILayout.Toggle(rootPath.toggle, "");

                    // Assetsフォルダのフォールドアウトを表示
                    rootPath.foldout = EditorGUILayout.Foldout(rootPath.foldout, rootPath.Value);

                    GUILayout.FlexibleSpace();

                }

Assetsフォルダだけでなく、それ以下のすべてのフォルダのパスを表示するための、ラベルや折りたたみの横にも表示します。GUILayoutOptionなどを使って表示位置を調節しています。

            // ラベルフィールドのスタイルを調整
            labelStyle = new GUIStyle(GUI.skin.label);
            labelStyle.padding.left = 15;
// ----------
            // さらに子がなければラベルで表示
            if (path.children[i].children.Count == 0)
            {
                using (new EditorGUILayout.HorizontalScope())
                {
                    // トグルを表示
                    path.children[i].toggle = GUILayout.Toggle(path.children[i].toggle, "", GUILayout.Width(15f));
                    
                    // ラベルを表示
                    EditorGUILayout.LabelField(path.children[i].Value, labelStyle);
                }

            }
            // さらに子があれば
            else
            {
                using (new EditorGUILayout.HorizontalScope())
                {
                    // トグルを表示
                    path.children[i].toggle = GUILayout.Toggle(path.children[i].toggle, "", GUILayout.Width(15f));
                    
                    // 折りたたみを表示
                    path.children[i].foldout = EditorGUILayout.Foldout(path.children[i].foldout, path.children[i].Value);
                }

                // ...
            }

トグルや折りたたみはスクロールビューの中に表示します。スクロールビューが終わるとその下に、「キャンセル」ボタンと「決定」ボタンを表示しています。キャンセルボタンを押すとこのエディターウィンドウを閉じます。

            using (new EditorGUILayout.HorizontalScope())
            {
                GUILayout.FlexibleSpace();

                // キャンセルボタンを押す
                if (GUILayout.Button("キャンセル", GUILayout.Width(100f)))
                {
                    // ウィンドウを閉じる
                    Close();
                }

決定ボタンを押すと、トグルがtrueになっているパスのみのリストを作って、その内容を別のエディタウィンドウに並べて表示します。

                if (GUILayout.Button("決定", GUILayout.Width(100f)))
                {
                    // パスのリスト
                    var pathsList = new List();

                    // Assetsフォルダのトグルがオンならパスをリストに入れる。 
                    if (rootPath.toggle) pathsList.Add(rootPath.Value);

                    // トグルがオンになっているパスを探してリストに入れる。
                    GetSelectedPathsList(rootPath, pathsList);

                    // トグルがオンのパスがあれば
                    if (pathsList.Count > 0)
                    {
                        // 別のウィンドウにパスを表示
                        TestDisplayPaths.Create(pathsList);
                    }
                }
            }

トグルがオンかどうかを確認するために、階層構造に連なっているインスタンスをすべて走査します。そのために再度、再帰処理をしています。

    void GetSelectedPathsList(PathData path, List<string> pathsList)
    {
        // 子がなければ終了
        if (path.children.Count == 0) return;

        // すべての子を処理
        for(int i = 0; i < path.children.Count; i++)
        {
            // トグルがオンならリストに追加
            if (path.children[i].toggle) pathsList.Add(path.children[i].Value);

            // さらに下の子を処理
            GetSelectedPathsList(path.children[i], pathsList);
        }
    }

このメソッドの引数にルートのパスインスタンスと、リストを渡します。引数のパスに子がなければ終了しますが、あればすべての子を一つ一つ見ていって、トグルがオンになっていればリストに追加します。そして、それらのパスをさらに同じメソッドの引数に渡しています。

リストに要素があれば、別のウィンドウを表示して、リスト内のパスを縦に並べて表示します。ウィンドウを表示するための静的メソッドを作って、その引数にリストを渡します。

using System.Collections.Generic;
using UnityEngine;
using UnityEditor;

public class TestDisplayPaths : EditorWindow
{
    List<string> pathsList;

    // ウィンドウを表示
    public static void Create(List<string> pathsList)
    {
        var w = EditorWindow.GetWindow<TestDisplayPaths>();

        w.pathsList = pathsList;
    }

    private void OnGUI()
    {
        if (pathsList == null || pathsList.Count <= 0) return;

        // リストの要素を一つ一つ処理
        for(int i = 0; i < pathsList.Count; i++)
        {
            // ラベルで表示
            GUILayout.Label(pathsList[i]);
        }
    }

}

選択したフォルダを表示

メインメニューからエディタウィンドウを表示できます。

「フォルダを検索」ボタンを押すと、Assetsフォルダとその中にあるフォルダが折りたたみで階層表示されます。フォルダの左にはトグルがついています。

トグルを適当に選択して「決定」ボタンをおしてみます。

すると、別ウィンドウが開き選択したパスの文字列が縦に並んで表示されます。

選択したものと表示されたものが同じであることがわかります。

さらに別のパスを選択して決定ボタンを押すと、表示ウィンドウに追加されています。

これで、フォルダを検索して階層表示し、選択したフォイルのパスだけのリストを作ることができました。

スクリプト

using System.Collections.Generic;
using UnityEngine;
using UnityEditor;

public class SelectFolders : EditorWindow
{
    // エディタウィンドウを表示する
    [MenuItem("Window/Test/SelectFolders")]
    public static void ShowDialog()
    {
        EditorWindow.GetWindow<SelectFolders>();
    }

    // パスを取得する
    void GetSubFoldersData(PathData parent)
    {
        if (parent.Value == "") return;

        // サブディレクトリのパスをすべて取得
        var childrenValues = AssetDatabase.GetSubFolders(parent.Value);

        // なければ終了
        if (childrenValues.Length == 0) return;

        // あれば一つずつ処理
        foreach(var v in childrenValues)
        {
            // サブディレクトリのパスのデータを作る
            var child = new PathData(v);

            // 現在のパスの子リストに追加
            parent.children.Add(child);

            // さらに下の階層のフォルダのパスを取得
            GetSubFoldersData(child);
        }
    }

    PathData rootPath;
    Vector2 scrollPosition;
    GUIStyle labelStyle;

    private void OnGUI()
    {
        // フォルダを検索ボタンを押す
        if (GUILayout.Button("フォルダを検索"))
        {
            // ルートのパスのデータを作る
            rootPath = new PathData("Assets");

            // 下の階層のフォルダのパスを取得
            GetSubFoldersData(rootPath);

            // ラベルフィールドのスタイルを調整
            labelStyle = new GUIStyle(GUI.skin.label);
            labelStyle.padding.left = 15;

        }

        // パスが取得済み
        if (rootPath != null)
        {
            // クリアボタンを表示
            if (GUILayout.Button("クリア"))
            {
                rootPath = null;
                return;
            }

            // スクロールビューを表示
            using (var scroll = new GUILayout.ScrollViewScope(scrollPosition, GUILayout.MinHeight(0f)))
            {
                scrollPosition = scroll.scrollPosition;

                // 横に並べる
                using (new EditorGUILayout.HorizontalScope())
                {
                    // トグルを表示
                    rootPath.toggle = GUILayout.Toggle(rootPath.toggle, "");

                    // Assetsフォルダのフォールドアウトを表示
                    rootPath.foldout = EditorGUILayout.Foldout(rootPath.foldout, rootPath.Value);

                    GUILayout.FlexibleSpace();

                }

                // 現在のインデントレベルを保存
                int currentIndentLevel = EditorGUI.indentLevel;

                // Assetsフォルダの折りたたみが開いているとき
                if (rootPath.foldout)
                {

                    // 下の階層のフォルダのパスを表示する
                    ShowPaths(rootPath);

                    // 最後にインデントレベルを戻す。
                    EditorGUI.indentLevel = currentIndentLevel;

                }
            }

            GUILayout.FlexibleSpace();

            // ボタンを横に並べる
            using (new EditorGUILayout.HorizontalScope())
            {
                GUILayout.FlexibleSpace();

                // キャンセルボタンを押す
                if (GUILayout.Button("キャンセル", GUILayout.Width(100f)))
                {
                    // ウィンドウを閉じる
                    Close();
                }
                // 決定ボタンを押す
                if (GUILayout.Button("決定", GUILayout.Width(100f)))
                {
                    // パスのリスト
                    var pathsList = new List();

                    // Assetsフォルダのトグルがオンならパスをリストに入れる。 
                    if (rootPath.toggle) pathsList.Add(rootPath.Value);

                    // トグルがオンになっているパスを探してリストに入れる。
                    GetSelectedPathsList(rootPath, pathsList);

                    // トグルがオンのパスがあれば
                    if (pathsList.Count > 0)
                    {
                        // 別のウィンドウにパスを表示
                        TestDisplayPaths.Create(pathsList);
                    }
                }
            }

        }
    }

    // トグルがオンになっているパスだけのリストを取得
    void GetSelectedPathsList(PathData path, List<string> pathsList)
    {
        // 子がなければ終了
        if (path.children.Count == 0) return;

        // すべての子を処理
        for(int i = 0; i < path.children.Count; i++)
        {
            // トグルがオンならリストに追加
            if (path.children[i].toggle) pathsList.Add(path.children[i].Value);

            // さらに下の子を処理
            GetSelectedPathsList(path.children[i], pathsList);
        }
    }


    // パスを表示
    void ShowPaths(PathData path)
    {
        // 現在のパスに子がないときは終了
        if (path.children.Count == 0) return;
        
        // インデントレベルを一つ上げる
        EditorGUI.indentLevel++;
        
        // 現在のインデントレベルを保存
        int currentIndentLevel = EditorGUI.indentLevel;
        
        // パスの子を一つずつ処理
        for (int i = 0; i < path.children.Count; i++)
        {
            // さらに子がなければラベルで表示
            if (path.children[i].children.Count == 0)
            {
                using (new EditorGUILayout.HorizontalScope())
                {
                    // トグルを表示
                    path.children[i].toggle = GUILayout.Toggle(path.children[i].toggle, "", GUILayout.Width(15f));
                    
                    // ラベルを表示
                    EditorGUILayout.LabelField(path.children[i].Value, labelStyle);
                }

            }
            // さらに子があれば
            else
            {
                using (new EditorGUILayout.HorizontalScope())
                {
                    // トグルを表示
                    path.children[i].toggle = GUILayout.Toggle(path.children[i].toggle, "", GUILayout.Width(15f));
                    
                    // 折りたたみを表示
                    path.children[i].foldout = EditorGUILayout.Foldout(path.children[i].foldout, path.children[i].Value);
                }

                // 開いているとき
                if (path.children[i].foldout)
                {
                    // さらに子のパスを表示
                    ShowPaths(path.children[i]);

                    // インデントレベルを戻す
                    EditorGUI.indentLevel = currentIndentLevel;
                }
            }
        }
    }
}