Version: 2023.1
言語: 日本語
ランタイム UI について
Panel Settings プロパティのリファレンス

ゲームビューで UI をレンダリングする

UI をレンダリングし、ゲームビューでユーザーからの入力に反応するには、UI Document コンポーネントによって UXML ドキュメントを Panel Settings アセットに接続します。

すべての UI Document コンポーネントは、UI を定義する UXML Document と、それをレンダリングする Panel Settings を参照します。1 つの Panel Settings アセットに複数の UXML ドキュメントを接続することができます。

Configure

Panel Settings アセットは、シーン内のパネルを定義します。パネルは、UI 階層がアタッチされるルートビジュアル要素を提供し、ランタイムにシーンに UI を描画します。Panel Settings アセットをどのように設定するかによって、UI がどのようにレンダリングされるかが決まります。また、入力に対する UI の反応も決まります。例えば、視覚的に手前にあるパネルは、視覚的に奥にあるパネルよりも先にユーザーからのクリックをインターセプトします。

Panel Settings アセットを設定して、以下を行えます。

  • スケールと解像度を制御する
  • デフォルトのスタイルを適用する
  • レンダーテクスチャに UI を表示する
  • パネルのソート順を設定する

パネルを設定するには以下を行います。

  1. プロジェクトで、Assets > Create > UI Toolkit > Panel Settings を選択して、Panel Settings アセットを作成してください (まだ、ない場合)。
  2. Panel Settings アセットの Inspector ウィンドウで、Panel Settings プロパティを設定します。

UI をパネルに接続する

パネルは、複数の UXML Document コンポーネントの UI を表示することができます。各 UI Document には、UXML ドキュメントのレンダリング順序を設定する Sort Order プロパティがあります。

  • 子 UI Document コンポーネントは、親 UI Document コンポーネントの上に描画されます。
  • 同じ階層にある UI Documents コンポーネントは、Sort Order に基づいて順番にレンダリングされます。

複数の UXML Document をパネルに接続するには、以下を行います。

  1. UI をホストするゲームオブジェクトを選択または作成します。

  2. Component > UI Toolkit > UI Document を選択して、UI Documentコンポーネントを加えます。

  3. UIDocument の Inspector ウィンドウで、以下を行います。

    • Panel Settings を UI を表示するパネル設定にします。
    • 表示する UI を含む UXML ドキュメントを Source に設定します。
    • Sort Order UI Document コンポーネントを、小さい数字が最初にレンダリングされるように設定します。
  4. 各 UXML Document に対してこのプロセスを繰り返します。

ノート: 同じ Panel Settings に複数の UXML Document コンポーネントがアタッチされている場合、これらのドキュメントはすべて共通のフォーカスナビゲーションコンテキストを持ちます。別々の Panel Settings を持つ場合、それらを横に並べても、ナビゲーションは一方から他方へ自動的にジャンプしません。ナビゲーションを一方から他方にジャンプさせるには、Panel Settings のfocusController を、ジャンプ先の UI Document コンポーネントの FocusController に設定する必要があります。

UI Document コンポーネントのライフサイクル

Unity は、コンポーネントの OnEnable() メソッドを呼び出すと、UI Document コンポーネントのソース UXML ドキュメントをロードします。ビジュアルツリーが正しくロードされるようにするには、OnEnable() メソッドの内部でコントロールと対話するロジックを追加します。つまり、スクリプトがOnEnable()OnDisable() に応答して、UXML ドキュメントからビジュアル要素を安全に参照できるようにする必要があります。

UI Document コンポーネントは、OnEnable() メソッドと OnDisable() メソッドに応答すると、そのコンテンツを消去します。この方法は、UI Document がすぐに再利用しない UI 要素を削除し、関連リソースを効果的に消去します。さらに、UI Document コンポーネントに Panel Settings アセットが割り当てられていない場合、UI Document コンポーネントのコンテンツは自動的にクリアされます。

すぐに再利用される可能性が高い UI 要素や、初期化のペナルティを避けるために素早く表示する必要がある UI 要素を非表示にするには、UIDocument.rootVisualElementdisplaynone に設定 します。これを使用して、より大きな UI 階層の一部である UI 要素のコンポーネントを非表示にすることもできます。

その他の参考資料

ランタイム UI について
Panel Settings プロパティのリファレンス