UI を描画し、ゲームビューでユーザーからの入力に反応するには、UI Document コンポーネントを使用して UXML ドキュメントを Panel Settings (パネル設定) アセットに接続します。
すべての UI Document コンポーネントは、UI を定義する UXML ドキュメントと、それを描画するパネル設定を参照します。1 つの Panel Settings アセットに複数の UXML ドキュメントを接続できます。
Panel Settings アセットによって、シーン内のパネルが定義されます。パネルは、UI 階層がアタッチされるルートビジュアル要素を提供し、ランタイムにシーンに UI を描画します。Panel Settings アセットの設定方法によって、UI の描画方法が決まり、入力への UI の反応も決定します。例えば、視覚的に前面に表示されるパネルは、背面に表示されるパネルよりも先に、ユーザーからのクリックをインターセプトします。
Panel Settings (パネル設定) アセットの設定により、以下を行うことができます。
パネルの設定には以下を行います。
1 つのパネルで、複数の UXML Document コンポーネントから UI を表示できます。各 UI Document には、UXML ドキュメントのレンダリング順序を設定する Sort Order (ソート順) プロパティがあります。
複数の UXML ドキュメントをパネルに接続するには、以下のようにします。
UI をホストするゲームオブジェクトを選択または作成します。
Component > UI Toolkit > UI Document を選択して、UI Document コンポーネントを追加します。
UIDocument の Inspector ウィンドウで以下を行います。
各 UXML ドキュメントに対して、同じ手順を繰り返します。
ノート: 同じパネル設定に複数の UI Documentコンポーネントがアタッチされている場合、これらのドキュメントはすべて共通のフォーカスナビゲーションコンテキストを持ちます。ドキュメントにそれぞれ個別のパネル設定がある場合、隣り合わせに並べても、ナビゲーションが自動的に移動することはありません。ナビゲーションを 1 つのドキュメントからもう 1 つにジャンプさせるには、Panel Settings の focusController を、ジャンプ先の UI Document コンポーネントの FocusController に設定する必要があります。
UI Document コンポーネントのソースとなる UXML ドキュメントは、コンポーネントに OnEnable() メソッドを呼び出した時に読み込まれます。ビジュアルツリーが必ず正しく読み込まれるようにするために、OnEnable() メソッド内のコントロールと相互作用するロジックを追加します。つまり、UXML ドキュメントからビジュアル要素を安全に参照するには、スクリプトが OnEnable() と OnDisable() に応答する必要があります。
UI Document コンポーネントは、OnEnable() メソッドと OnDisable() メソッドに応答するときに、そのコンテンツを消去します。このアプローチでは、UI Document がすぐに再利用しない UI 要素を削除し、関連するリソースを効果的に消去します。また、UI Document コンポーネントが Panel Settings アセットで割り当てられていない場合は、そのコンテンツは自動的に消去されます。
すぐに再利用される可能性が高い UI 要素や、初期化ペナルティを回避するために迅速に表示する必要がある UI 要素を非表示にするには、UIDocument.rootVisualElement の display を none に設定します。また、これを使用して、大きな UI 階層の一部である UI 要素のコンポーネントを隠すこともできます。