UI Toolkit は、オペレーティングシステムやスクリプトからのイベントをリッスンし、EventDispatcher でこれらのイベントをビジュアル要素にディスパッチします。イベントディスパッチャーは、送信する各イベントに適切なディスパッチ方法を決定します。方法がきまると、ディスパッチャーはそれを実行します。
ビジュアル要素は、いくつかのイベントに対してデフォルトの動作を実装します。追加のイベントを作成して実行する場合もあります。例えば、MouseMoveEvent
は追加の MouseEnterEvent
と MouseLeaveEvent
を作成することがあります。これらの追加イベントはキューに置かれ、現在のイベントが完了した後に処理されます。例えば、MouseMoveEvent
は MouseEnterEvent
と MouseLeaveEvent
イベントの前に完了します。
各イベントタイプには、それぞれのディスパッチ動作があります。各イベントタイプの動作は、3 つの段階に分かれます。
各イベントタイプのディスパッチ動作の一覧は、イベントのリファレンス ページ](UIE-Events-Reference.html) を参照してください。
イベントターゲットを選択すると、イベントディスパッチャーはイベントの伝搬 (propagation) パスを計算します。伝搬経路は、イベントを受け取るビジュアル要素が順序通りに並べられたリストです。伝搬経路は次の順序で発生します。
ほとんどのイベントタイプは、伝搬経路上のすべての要素に送られます。いくつかのイベントタイプはバブルアップの段階をスキップし、いくつかのイベントタイプはイベントターゲットのみに送信されます。
要素を隠したり無効にしたりするとその要素はイベントを受け取りません。隠したり無効にした要素の先祖や子孫にはイベントが伝わります。
あるイベントが伝搬経路をたどると、Event.currentTarget
はそのイベントを処理する要素に更新されます。イベントのコールバック関数の中には、ディスパッチの動作を記録する 2 つのプロパティがあります。
Event.currentTarget
は、コールバックが登録されたビジュアル要素です。Event.target
は、イベントが発生する要素で、例えばマウス直下の要素などです。イベントのターゲットは、イベントの種類によって異なります。マウスイベントの場合、ターゲットは通常、直接マウスの下にある選択される可能性が最も高い要素です。キーボードイベントの場合、ターゲットは現在フォーカスされている要素です。
UI Toolkit のイベントには target
プロパティがあり、これには、イベントが発生した要素への参照が含まれます。オペレーティングシステムから発生するほとんどのイベントでは、ディスパッチプロセスが自動的にイベントターゲットを見つけます。
ターゲット要素は EventBase.target
に格納されており、ディスパッチプロセス中は変更されません。プロパティ Event.currentTarget
は、現在イベントを処理しているビジュアル要素に更新されます。
ほとんどのマウスイベントは、選択 (picking) モードを使用してターゲットを決定します。VisualElement
クラスは以下の値をサポートする pickingMode
プロパティを持っています。
PickingMode.Position
(デフォルト): 位置の矩形に基づいて選択します。PickingMode.Ignore
: マウスイベントの結果によって選択することを防ぎます。VisualElement.ContainsPoint()
メソッドをオーバーライドすると、カスタムの交差ロジックを行えます。
MouseDownEvent
の後、一部の要素では、カーソルが要素の上に乗っていなくても、その後のすべてのマウスイベントを確実に受け取るために、ポインター位置を捉える必要があります。例えば、ボタンやスライダー、スクロールバーをクリックしたときなどです。
マウスをキャプチャするには、element.CaptureMouse()
か MouseCaptureController.CaptureMouse()
を呼び出します。
マウスをリリースするには MouseCaptureController.ReleaseMouse()
を呼び出します。CaptureMouse()
の呼び出し時に他の要素がすでにマウスをキャプチャしている場合、その要素は MouseCaptureOutEvent
を受け取り、キャプチャしなくなります。
どのような時でも、アプリケーションの 1 つの要素だけがキャプチャできます。要素はキャプチャできますが、マウスホイールイベントを除くすべての後続のマウスイベントのターゲットにもなります。これは、まだターゲットが設定されていないマウスイベントにのみ適用され、ターゲットの決定はディスパッチプロセスに依存します。
詳しくは、キャプチャーイベント を参照してください。
各 UI Toolkit パネルには、要素のフォーカス順序を定義するフォーカスリングがあります。デフォルトでは、要素のフォーカス順序は、ビジュアル要素ツリーで深さ優先探索 (DFS) によって決まります。例えば、下に描かれているツリーのフォーカス順序は、F、B、A、D、C、E、G、I、H です。
イベントによっては、どの要素にフォーカスがあるかを決定するためにフォーカス順序を使用するものがあります。例えば、キーボードイベントのターゲットは、フォーカスされている要素です。
focusable
プロパティを使用します。デフォルトで VisualElements
はフォーカス可能ではありませんが、TextField
などのサブクラスの中には、デフォルトでフォーカス可能なものがあります。フォーカスの順序を制御するには、以下のように tabIndex
プロパティを使用します (tabIndex
のデフォルト値は 0)。
tabIndex
が負の値の場合は、要素でタブを使うことはできません。focus-index
が 0 の場合、要素はフォーカスリングアルゴリズムによって決定されたデフォルトのフォーカス順序を維持します。tabIndex
が正の場合、その要素は tabIndex
が 0 (tabIndex = 0
) か、tabIndex
値がそれ自体より小さい他の要素の前に置かれます。Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.