Version: 2018.4
言語: 日本語
C# から UXML を読み込む
UQuery

UXML 要素リファレンス

ここでは UnityEngine.Experimental.UIElementsUnityEditor.Experimental.UIElements 名前空間で使用可能な UXML 要素について説明します。

基本要素

VisualElement

すべてのビジュアル要素の基本クラス

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • class: スペースで区切られた名前のリスト
    • style: 要素をスタイリングするための USS ディレクティブ
    • name: この要素の一意の文字列識別子
    • focus-index: タブ移動時のフォーカス順を決定するために使用される整数。デフォルト値は -1 で、要素がフォーカス可能でないことを意味します。
    • picking-mode: Position または Ignore; デフォルト値は Position
    • tooltip: 要素をマウスオーバーすると表示される文字列
    • slot-name: この要素をスロットとして定義します。
    • slot: 要素が<Instance>内にあるとき、要素をこの属性が参照するスロットの内側に移動します。
    • 他の属性も受け入れます

BindableElement

SerializedProperty にバインドできる要素。プロパティの値と表示される値は同期されます。

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • VisualElement のすべての属性
    • binding-path: この要素がバインドされているプロパティのパス

ユーティリティー

Box

VisualElement に似ていますが、コンテンツの周囲にボックスを描画します。

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • VisualElement のすべての属性

TextElement

テキストを表示する要素

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性
    • text: 要素が表示するテキスト

Label

テキストラベル

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • TextElement のすべての属性

Image

画像を表示します。

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性

IMGUIContainer

IMGUI コンテンツを描画する要素

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性
      • focus-index のデフォルト値は 0 です。

Foldout

コンテンツの表示/非表示を切り替えるボタンを持つ要素

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • BindableElement のすべての属性

テンプレート

Template

Instance 要素を使ってインスタンス化できる別の UXML テンプレートへの参照

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • name: この要素の一意の文字列識別子
    • path: 読み込む UXML ファイルのパス

Instance

Template のインスタンス

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • template: インスタンス化する Templatename

コントロール

Button

標準のプッシュボタン

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • TextElement のすべての属性

RepeatButton

押下中にアクションを繰り返し実行するボタン

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • TextElement のすべての属性
    • delay: アクションが実行される前の最初の遅延時間 (ミリ秒)。 デフォルト値は 0
    • interval: 各アクションの繰り返しの間隔 (ミリ秒) デフォルト値は 0

Toggle

トグルボタン (チェックボックス)

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • label: トグルのテキストラベル
    • value: トグルがオンかオフかを示すブーリアン

Scroller

スクロールバー

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性
    • low-value: スクロールバーの最小値
    • high-value: スクロールバーの最大値
    • direction: HorizontalVertical です。デフォルトは Vertical
    • value: サムの位置

ScrollerButton

スクロールバーの端にあるボタン

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性
    • delay: アクションが実行される前の最初の遅延時間 (ミリ秒)。 デフォルト値は 0
    • interval: 各アクションの繰り返しの間隔 (ミリ秒) デフォルト値は 0

Slider

スライダー

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
    • low-value: スライダーの最小値
    • high-value: スライダーの最大値
    • direction: HorizontalVertical です。デフォルトは Vertical
    • page-size: スライダーのページサイズ
    • value: スライダーカーソルの位置

SliderInt

整数値のスライダー

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
    • low-value: スライダーの最小値
    • high-value: スライダーの最大値
    • direction: HorizontalVertical です。デフォルトは Vertical
    • page-size: スライダーのページサイズ
    • value: スライダーカーソルの位置

MinMaxSlider

ユーザーが最小値と最大値を指定できるスライダー

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
    • low-limit: スライダーの最小値
    • high-limit: スライダーの最大値
    • min-value: スライダーカーソルの最小値
    • max-value: スライダーカーソルの最大値

EnumField

フィールドは基本の Enum の string 値のみ入力可能です。

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • type: 必須。基本の Enum の C# 型を表す string。
    • value: フィールドの値を表す string

MaskField

ユーザーが一群の値を選択するためのポップアップメニュー

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • choices: ポップアップメニューに表示する最大 32 個の選択肢のカンマ区切りのリスト
    • value: フィールドの値を 32 ビットのマスクとして表す int

LayerField

ユーザーが レイヤー を選択するポップアップメニュー

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • value: フィールドの値を表す int (選択したレイヤー番号)

LayerMaskField

ユーザーが一群の レイヤー を選択するポップアップメニュー

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • MaskField のすべての属性

TagField

ユーザーが タグ を選択するポップアップメニュー

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • value: フィールド (選択されたタグ名) の値を表す string

テキスト入力

TextField

編集可能なテキストフィールド

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • text: フィールドのテキスト値
    • max-length: フィールドに含むことができる最大文字数。デフォルト値 -1 では、テキストの長さに制限がありません。
    • password: フィールドのコンテンツを表示するか、maskCharacter 文字を使用して表示するかを示すブーリアン (デフォルトは false)
    • mask-character: passwordtrue のときにフィールドの内容を表示するために使用される文字。デフォルトは文字 *
    • multiline: テキストフィールドがテキストを複数の行に表示するか (true)、1 行に表示するかを示すブーリアン値。テキストの改行は無視されます (デフォルトは false)。

IntegerField

int (32ビット) 値を設定するテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • value: フィールドの値
    • text: フィールドのテキスト値
    • max-length: フィールドに含むことができる最大文字数。デフォルト値 -1 では、テキストの長さに制限がありません。
    • password: フィールドのコンテンツを表示するか、maskCharacter 文字を使用して表示するかを示すブーリアン (デフォルトは false)
    • mask-character: passwordtrue のときにフィールドのコンテンツを表示するために使用する文字。デフォルトは文字 *

LongField

Long 型 (64ビット) の値を設定するテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • value: フィールドの値
    • text: フィールドのテキスト値
    • max-length: フィールドに含むことができる最大文字数。デフォルト値 -1 では、テキストの長さに制限がありません。
    • password: フィールドのコンテンツを表示するか、maskCharacter 文字を使用して表示するかを示すブーリアン (デフォルトは false)
    • mask-character: passwordtrue のときにフィールドのコンテンツを表示するために使用する文字。デフォルトは文字 *

FloatField

単精度浮動小数点値 float を設定するテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • value: フィールドの値
    • text: フィールドのテキスト値
    • max-length: フィールドに含むことができる最大文字数。デフォルト値 -1 では、テキストの長さに制限がありません。
    • password: フィールドのコンテンツを表示するか、maskCharacter 文字を使用して表示するかを示すブーリアン (デフォルトは false)
    • mask-character: passwordtrue のときにフィールドのコンテンツを表示するために使用する文字。デフォルトは文字 *

DoubleField

倍精度浮動小数点値 double を設定するテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • value: フィールドの値
    • text: フィールドのテキスト値
    • max-length: フィールドに含むことができる最大文字数。デフォルト値 -1 では、テキストの長さに制限がありません。
    • password: フィールドのコンテンツを表示するか、maskCharacter 文字を使用して表示するかを示すブーリアン (デフォルトは false)
    • mask-character: passwordtrue のときにフィールドのコンテンツを表示するために使用する文字。デフォルトは文字 *

Vector2Field

Vector2 の値を編集するための float 値を設定する 2 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • x: X 座標の値
    • y: Y 座標の値

Vector2IntField

Vector2Int の値を編集するための int 値を設定する 2 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • x: X 座標の値
    • y: Y 座標の値

Vector3Field

Vector3 の値を編集するための float 値を設定する 3 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • x: X 座標の値
    • y: Y 座標の値
    • z: Z 座標の値

Vector3IntField

Vector3Int の値を編集するための int 値を設定する 3 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • x: X 座標の値
    • y: Y 座標の値
    • z: Z 座標の値

Vector4Field

Vector4 の値を編集するための float 値を設定する 4 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • x: X 座標の値
    • y: Y 座標の値
    • z: Z 座標の値
    • w: W 座標の値

RectField

矩形の値を編集するための float 値を設定する 4 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • x: 左上の角の X 座標の値
    • y: 左上の角の Y 座標の値
    • w: 矩形の幅
    • h: 矩形の高さ

RectIntField

矩形の値を編集するための float 値を設定する 4 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • x: 左上の角の X 座標の値
    • y: 左上の角の Y 座標の値
    • w: 矩形の幅
    • h: 矩形の高さ

BoundsField

バウンディングボックスの値を編集するための float 値を設定する 6 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • cx: 中央の X 座標の値
    • cy: 中央の Y 座標の値
    • cz: 中央の Z 座標の値
    • ex: 範囲の X 座標の値
    • ey: 範囲の Y 座標の値
    • ez: 範囲の Z 座標の値

BoundsIntField

バウンディングボックスの値を編集するための int 値を設定する 6 つのテキストフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • px: 中央の X 座標の値
    • py: 中央の Y 座標の値
    • pz: 中央の Z 座標の値
    • sx: 範囲の X 座標の値
    • sy: 範囲の Y 座標の値
    • sz: 範囲の Z 座標の値

複雑なウィジェット

PropertyField

値を編集するラベルとフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • binding-path: この要素がバインドされているプロパティのパス
    • label: フィールドのラベル

ColorField

カラーピッカーフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • value: Color としての色の値
    • show-eye-dropper: スポイトを表示する (デフォルト true) か、しない (false) かを示すブーリアン
    • show-eye-dropper: コントロールを表示する (デフォルト true) か、しない (false) かを示すブーリアン
    • hdr: HDR カラーピッカーを使用する (デフォルト true) か、通常のカラーピッカーを使用する (false) かを示すブーリアン

CurveField

カーブエディターフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。

GradientField

グラデーションエディターフィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。

ObjectField

オブジェクト選択フィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • BindableElement のすべての属性
      • focus-index のデフォルト値は 0 です。
    • allow-scene-objects: シーンからのオブジェクトが選択可能か (デフォルト true)、不可能 (false) かを示すブーリアン

InspectorElement

インスペクターウィンドウでプロパティを表示する要素

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • BindableElement のすべての属性

ツールバー

Toolbar

ツールバーアイテムを保持するためのコンテナ

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: 任意の VisualElement
  • 属性
    • VisualElement のすべての属性

ToolbarButton

ツールバーのボタン

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • Button のすべての属性

ToolbarToggle

ツールバーのトグル

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • Toggle のすべての属性

ToolbarMenu

ツールバーのドロップダウンメニュー。メニューには下向きの矢印が 1 つあります。

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • TextElement のすべての属性

ToolbarPopup

ツールバーのポップアップメニュー。メニューには上向き下向きの矢印が 1 つずつあります。

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • TextElement のすべての属性

ToolbarSearchField

ツールバーの検索フィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性

ToolbarPopupSearchField

検索オプションのポップアップメニューが備わった検索フィールド

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • ToolbarSearchField のすべての属性

ToolbarSpacer

ツールバーのボタンの間に固定された量の空白を挿入する要素

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性

ToolbarFlexSpacer

ツールバーのボタンの間に変更可能な量の空白を挿入する要素

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性

ビューとウィンドウ

ListView

要素のリストを表示します。

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: なし
  • 属性
    • VisualElement のすべての属性
    • item-height: リスト内の各項目の高さ (ピクセル単位)

ScrollView

水平スクロールバーと垂直スクロールバーを持つスクロール可能なビュー

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • VisualElement のすべての属性
    • show-horizontal-scroller: 水平スクロールバーを表示するかを示すブーリアン (デフォルト false)
    • show-vertical-scroller: 垂直スクロールバーを表示するかを示すブーリアン (デフォルト false)
    • horizontal-page-size: 水平スクロールバーのページサイズの値
    • vertical-page-size: 垂直スクロールバーのページサイズの値
    • stretch-content-width:コンテンツがビューの幅に合わせて伸縮するかを示すブーリアン

PopupWindow

他のコンテンツの上に表示される UIElement のウィンドウ

  • UnityEngine.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • TextElement のすべての属性

VisualSplitter

ユーザーが分割バーをドラッグして子のサイズを変更できるコンテナ

  • UnityEditor.Experimental.UIElements にあります。
  • 許可された子要素: 任意の数の VisualElement
  • 属性
    • VisualElement のすべての属性

C# から UXML を読み込む
UQuery