Version: 2020.3
言語: 日本語
イベントの統合
キャプチャイベント

イベントの参照

UI Toolkit は、ユーザーが UI Toolkit の要素と相互作用しそれらの要素の状態を変更すると、イベントを送信します。例えば、以下のアクションはすべてそれに関連しています。

  • ウィンドウのサイズ変更
  • パネルの選択
  • キーボードのキーの押下

イベントのデザインは、HTML 要素の Event インターフェース と似ています。

イベントファミリー

イベントタイプは、EventBase クラスに基づく階層に当てはまります。各イベントファミリーは、同じファミリーのすべてのイベントに共通の特性を定義するインターフェースを実装します。例えば、BlurEventFocusEvent は、FocusEventBase クラスを使用します。

イベント、親クラスに関する詳しい情報と、API スクリプトリファレンスは、下記のリストのリンクを参照してください。

イベントリファレンス表

以下の表は、各イベントタイプの簡単な概要です。イベントの詳細については、上記のページを参照してください。

イベントタイプ 説明 トリクルダウン (下降) 伝播 バブルアップ (上昇) 伝播 キャンセル可能
キャプチャイベント
MouseCaptureEvent 要素がマウスキャプチャを取得したときに送信されます。
MouseCaptureOutEvent 要素がマウスキャプチャを解除したり、失うときに送信されます。
PointerCaptureEvent 要素がポインターを捉えるときに送信されます。
PointerCaptureOutEvent 要素がポインターをリリースするときに送信されます。
Change イベント
ChangeEvent 要素の値が変化するときに送られる一般的なイベントです。
コマンドイベント
ValidateCommandEvent IMGUI は、コマンドがパネルの要素によって処理されるかどうかを判別する間に、このイベントを送信します。
ExecuteCommandEvent IMGUI は、パネルの要素がコマンドを実行する必要があるときにこのイベントを送信します。
ドラッグイベント
DragExitedEvent ドラッグアンドドロップ処理の終了時に送信されます。
DragUpdatedEvent ドラッグされた要素がドロップするターゲットの上に移動するときに送信されます。
DragPerformEvent ドラッグされた要素が受け入れ可能なターゲットにドロップされたときに送信されます。
DragEnterEvent ドラッグされた要素が新しい VisualElement に入りました。このイベントはドラッグ操作を開始するときに送信されます。
DragLeaveEvent ドラッグされた要素が現在のドロップターゲットの外に出ました。このイベントはドラッグ操作が終了するときに送信されます。
フォーカスイベント
FocusOutEvent 要素がフォーカスを失う前に送信されます。
FocusInEvent 要素がフォーカスを得る前に送信されます。
BlurEvent 要素がフォーカスを失った後に送信されます。
FocusEvent 要素がフォーカスを得た後に送信されます。
IMGUI イベント
IMGUIEvent IMGUI 特有のイベントをカプセル化するために送信されます。
Input イベント
InputEvent ビジュアル要素 (通常は、コントロール) にデータが入力されるときに送信されます。
キーボードイベント
KeyDownEvent ユーザーがキーボードのキーを押下するときに送信されます。
KeyUpEvent ユーザーがキーボードのキーをリリースするときに送信されるイベント
レイアウトイベント
GeometryChangedEvent 要素の位置または寸法のいずれかが変更されるときに送信されます。 
マウスイベント
MouseDownEvent ユーザーがマウスボタンを押すときに送信されます。
MouseUpEvent ユーザーがマウスボタンを離すときに送信されます。
MouseMoveEvent ユーザーがマウスを動かすと送信されます。
WheelEvent ユーザーがマウスホイールをアクティブにすると送信されます。
MouseEnterWindowEvent マウスがウィンドウに入るときに送信されます。 Yes
MouseLeaveWindowEvent マウスがウィンドウを離れるときに送信されます。 Yes
MouseEnterEvent マウスが要素またはその子孫に入るときに送信されます。
MouseLeaveEvent マウスが要素またはその子孫から離れるときに送信されます。
MouseOverEvent マウスが要素に入るときに送信されます。
MouseOutEvent マウスが要素から離れるときに送信されます。
ContextClickEvent (廃止予定) ユーザーが第 3 のマウスボタンを押して離すときに送信されます。IMGUI との後方互換性のために存在します。
ポインターイベント
PointerDownEvent ポインターを押すときに送信されます。
PointerUpEvent ポインターをリリースするときに送信されます。
PointerMoveEvent ポインターの状態が変化するときに送信されます。
PointerEnterEvent ポインターがビジュアル要素またはその子孫に入るときに送信されます。
PointerLeaveEvent ポインターがビジュアル要素とその子孫すべてから離れるときに送信されます。
PointerOverEvent ポインターがビジュアル要素に入るときに送信されます。
PointerOutEvent ポインターがビジュアル要素から離れるときに送信されます。
PointerStationaryEvent タッチペンや指などのポインタータイプが、OS で決められた一定時間変化しない場合に送信されます。
PointerCancelEvent ポインターの動作が OS によってキャンセルされるときに送信されます。
パネルイベント
AttachToPanelEvent 要素がパネルにアタッチされた直後に送信されます。
DetachFromPanelEvent 要素がパネルから外される直前に送信されます。
ツールチップイベント
TooltipEvent Tooltip が表示される直前に送信されます。

  • 2018–11–02 修正されたページ
イベントの統合
キャプチャイベント