バインド可能なデータ型とフィールド

このページは PropertyField がサポートするデータ型変換とフィールドを説明します。

データ型変換

UI Toolkit のほとんどのビルトインコントロールは、特定のデータ型に対して INotifyValueChanged インターフェースを実装しています。例えば、DoubleField は INotifyValueChanged<Double> を実装しています。つまり、 DoubleField コントロールを double 型のプロパティにバインドできます。バインディングシステムを使えば、もっと多くのデータ型をバインドすることができます。例えば、int 型のプロパティを DoubleField にバインドすることができます。

以下の表は、バインドできるソースと対象となるデータ型の一覧です。

ノート: データ損失を防ぐために、PropertyField を使用するか、または以下の PropertyField がサポートするフィールドの表 に示す適切なデータ型を使用してください。

PropertyField がサポートするフィールド

Inspector ウィンドウに入力するときに、カスタムエディターがタイプに存在しない場合、バインディングシステムは InspectorElement.FillDefaultInspector() を呼び出します。これにより SerializedObject の各 SerializedProperty 用に PropertyField が作成されます。

各 PropertyField には一致するコントロールがあります。例えば、IntegerField は int を表し、Toggle は bool を表します。プロパティにサブプロパティがある場合は PropertyField にはFoldout コントロールがあります。その Foldout には、各サブプロパティの下に適切なデフォルトコントロールを持ちます。プロパティに対してカスタムの PropertyDrawer を作成した場合は、PropertyDrawer の CreatePropertyGUI() メソッドから返されるビジュアルツリーが代わりに使用されます。

ノート:

カスタム UI を作るときは、特定のコントロールが見つからない場合を除き PropertyField を使用しないでください。例えば、ビジュアルツリーにコントロールを作成し、それを Color にバインドするにはPropertyField ではなく、ColorField を使用します。これにより、ビジュアルツリーが軽量化され、操作がより早くなります。

PropertyField を使用すると、バインディング後に使用する具象フィールドを解決するため、余分なオーバーヘッドが発生します。この余分なステップはパフォーマンスに影響する可能性があります。ただし、PropertyField は、用途においては有益な場合があります。例えば、これはカスタムドロワーに対応しており、特定のプロパティの処理を個別化された方法で行うために使用できます。これにより、描画のためにフィールド型を推測する必要がなくなり、エラーを減らすことができます。

以下の表は、PropertyField がサポートするフィールドとそのデータ型の一覧です。

その他の参考資料

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