Version: 2023.1
言語: 日本語
ランタイム UI のパフォーマンスに関する考慮点
テキストを扱う

UI Toolkit を使用した入力およびイベントシステムに関する FAQ

このページでは、UI Toolkit でイベントシステムや入力システムを使用する際によくある質問を掲載しています。

  1. ランタイムパネルからマウスがビジュアル要素上にあるかを知るにはどうすればよいですか
  2. 基本的な UI アクションを再マップするにはどうすればよいですか
  3. 方向ナビゲーションを使用しているときに、次にフォーカスされる要素を変更するにはどうすればよいですか
  4. 方向ナビゲーションの WASD 入力や送信アクションのスペースバーをなくすことは可能ですか
  5. マウスでどこもクリックせずにキーボード入力を始めるにはどうしたらいいですか

ランタイムパネルからマウスがビジュアル要素上にあるかを知るにはどうすればよいですか

これには 2 つの方法があります。

最初の方法

  1. Add an Event System component in your scene the same way as you create GameObject-based UI content from the com.unity.uGUI package.

  2. Use the EventSystem.current.IsPointerOverGameObject method, which returns true if the pointer is over UI content from either uGUI or from UI Toolkit.

  3. Use the EventSystem.current.RaycastAll method to see what visual element is under the mouse.

  4. 交差した UI Toolkit パネルは、ゲームオブジェクトを通して Event System の環境に表示されます。

    • ゲームオブジェクトの名前は、対応する PanelSettings と一致します。
    • ゲームオブジェクトの親は、現在の Event System コンポーネントを保持しているゲームオブジェクトです。
    • ゲームオブジェクトには 2 つのコンポーネント、PanelRaycasterPanelEventHandler があります。どちらのコンポーネントも、ターゲットとする IPanel を返す panel プロパティを持っています。

After you find the panel under the pointer, call the panel.Pick method to find what visual element lies at the pointer’s position.

RuntimePanelUtils.ScreenToPanel メソッドを使用して、ポインターのスクリーン座標をパネル座標に変換する必要があります。

uGUI のスクリーン座標系は左下の原点を使用しますが、UI Toolkit のスクリーン座標は左上から表現されます。2 つのシステム間で変換するには、yTopLeft = Screen.height - yBottomLeft で Y 座標をミラーリングするか、その逆を行う必要があります。

第 2 の方法

  1. 使用される個別の PanelSettings ごとに、1 つの UIDocument からUIDocument.rootVisualElementプロパティを使用して、ポインターの下にあるすべてのランタイムパネルのリストを取得します。
  2. Go through the panels manually in order of depth and call panel.Pick on each of them successively until you find one that returns a visual element.

基本的な UI アクションを再マップするにはどうすればよいですか

基本的な UI アクションを再マップするには、以下を行います。

  1. Add an Event System component in your scene the same way as you create GameObject-based UI content from the com.unity.uGUI package.
  2. Inspector ウィンドウで、Stand alone Input Module または Input System UI Input Module フィールドを設定して、どの入力を各アクションにマップするかを制御します。

ノート: Tab 入力と Shift+Tab 入力にマップされたアクションは、イベントシステムの入力モジュールを通して公開されていないため、再マップすることはできません。

方向ナビゲーションを使用しているときに、次にフォーカスされる要素を変更するにはどうすればよいですか

方向ナビゲーションは、デフォルトのターゲット以外にも設定できます。

次のコード例では、要素 A が上下左右に移動するときに、それぞれ要素 U、D、L、R に移動することが可能です。

A.RegisterCallback <NavigationMoveEvent>(e =>
{
    switch(e.direction)
    {
        case NavigationMoveEvent.Direction.Up: U.Focus(); break;
        case NavigationMoveEvent.Direction.Down: D.Focus(); break;
        case NavigationMoveEvent.Direction.Left: L.Focus(); break;
        case NavigationMoveEvent.Direction.Right: R.Focus(); break;
    }
    e.PreventDefault();
});

方向ナビゲーションの WASD 入力や送信アクションのスペースバーをなくすことは可能ですか

Yes. You can use the EventSystem’s StandaloneInputModule or InputSystemUIInputModule fields in the Inspector window to control what input maps to each action. However, since these actions are shared with uGUI input, this also changes the uGUI controls.

To remap UI Toolkit inputs without affecting uGUI controls, disable UI Toolkit’s runtime event handling and send all events manually to panels. To do so, call EventSystem.SetUITookitEventSystemOverride(null, true, false); before the start method of your current EventSystem kicks in, such as the Awake method of the component of your scene. For more information about this uGUI method, see SetUITookitEventSystemOverride.

マウスでどこもクリックせずにキーボード入力を始めるにはどうしたらいいですか

It’s possible that no element or panel is in focus at a given time, such as when loading your game scene for the first time. In this case, keyboard navigation doesn’t start from a predictable first element. This can be a problem for a game that plays entirely without a mouse.

最初から予測可能なナビゲーション動作ができるようにするには C# スクリプトを加えて、スクリプトを、最初のフォーカスを得るように選択した要素を処理する UIDocument と同じゲームオブジェクトにアタッチします。

Assume your script is named FirstFocus and your initial focused element is named as first-focused. In your script’s Start() method, add a line to focus that element as the following:

public class FirstFocus : MonoBehaviour
{
    void Start()
    {
        FocusFirstElement();
    }

    public void FocusFirstElement()
    {
        GetComponent<UIDocument>().rootVisualElement.
            Q<VisualElement>("first-focused").Focus();
    }
}

Note: If you disable the UIDocument’s GameObject, all its underlying hierarchy is recreated from scratch. Therefore, you must run your custom FocusFirstElement() method again after you re-enable the GameObject.

その他の参考資料

ランタイム UI のパフォーマンスに関する考慮点
テキストを扱う