バインディングパスなしでバインドする

バージョン: 2021.3 以降

バインディングパスを使う代わりに BindProperty() を呼び出して、要素を SerializedProperty オブジェクトに直接バインドすることができます。この例は BindProperty() を使ってバインドする方法を紹介します。

例の概要

この例ではカスタムエディターウィンドウを作成して、ゲームオブジェクトの名前を変更します。

この例で作成するすべてのファイルは、GitHub リポジトリ にあります。

要件

このガイドは、Unity エディター、UI Toolkit、および C# スクリプトに精通している開発者を対象としています。始める前に、以下をよく理解してください。

• BindProperty

BindProperty() を使ってバインドする

C# で、TextField を持つカスタムのエディターウィンドウを作成します。ゲームオブジェクトの name プロパティを検索し、BindProperty() メソッドを使用してプロパティに直接バインドします。

1. Project ウィンドウに、bind-without-binding-path という名前のフォルダーを作成し、ファイルを保存してください。

2. bind-without-binding-path フォルダー内に、Editor という名前のフォルダーを作成します。

3. Editor フォルダーに、SimpleBindingPropertyExample.cs という名の C# スクリプトを作成し、そのコンテンツを以下と置き換えます。

   using UnityEditor;
   using UnityEngine;
   using UnityEditor.UIElements;
   using UnityEngine.UIElements;
   
   namespace UIToolkitExamples
   {
       public class SimpleBindingPropertyExample : EditorWindow
       {
           TextField m_ObjectNameBinding;
   
           [MenuItem("Window/UIToolkitExamples/Simple Binding Property Example")]
           public static void ShowDefaultWindow()
           {
               var wnd = GetWindow<SimpleBindingPropertyExample>();
               wnd.titleContent = new GUIContent("Simple Binding Property");
           }
           
           public void CreateGUI()
           {
               m_ObjectNameBinding = new TextField("Object Name Binding");
               rootVisualElement.Add(m_ObjectNameBinding);
               OnSelectionChange();
           }
   
           public void OnSelectionChange()
           {
               GameObject selectedObject = Selection.activeObject as GameObject;
               if (selectedObject != null)
               {
                   // Create the SerializedObject from the current selection
                   SerializedObject so = new SerializedObject(selectedObject);
   
                   // Note: the "name" property of a GameObject is actually named "m_Name" in serialization.
                   SerializedProperty property = so.FindProperty("m_Name");
                   // Bind the property to the field directly
                   m_ObjectNameBinding.BindProperty(property);
               }
               else
               {
                   // Unbind any binding from the field
                   m_ObjectNameBinding.Unbind();
               }
           }
       }
   }
   

バインディングのテスト

1. Unity で Window > UIToolkitExamples > Simple Binding Property Example を選択します。カスタムエディターウィンドウが開き、テキストフィールドが表示されます。
2. シーン内のゲームオブジェクトを選択します。ゲームオブジェクトの名前は、エディターウィンドウのテキストフィールドに表示されます。テキストフィールドでゲームオブジェクトの名前を変更すると、ゲームオブジェクトの名前も変更されます。

その他の参考資料

• SerializedObject のデータバインディング
• バインド可能な要素
• バインディングデータ型変換
• 実装の詳細
• バインディングの例