Version: 2023.1
言語: 日本語
UXML要素 GradientField
UXML 要素 Hash128Field

UXML 要素 GroupBox

GroupBox は、複数のビジュアル要素の論理的グループのためのコンテナ要素です。同じパネルに複数のオプションのグループを表示する場合は、GroupBox と RadioButton を組み合わせて使用できます。

それぞれ 3 つのラジオボタンを持つ 2 つのグループボックス
それぞれ 3 つのラジオボタンを持つ 2 つのグループボックス

ラジオボタンのグループを 1 つのフィールドとして扱いたい場合は、RadioButtonGroupを を使用してください。GroupBox とRadioButton コンボを使用する場合、すべてのラジオボタンを登録する必要があるため、ほとんどの場合、RadioButtonGroup を使用する方がよいでしょう。ただし、グループ内にビジュアル要素を追加したい場合は、コンボを使用してください。

2 つのラジオボタン、1 つの入力テキストフィールド、1 つのボタンを持つグループボックス
2 つのラジオボタン、1 つの入力テキストフィールド、1 つのボタンを持つグループボックス

C#スクリプトで GroupBox を作成する

以下の C# コードスニペットは、GroupBox を作成し、3 つのラジオボタンをそれに加えて、それらを論理的にグループ化します。

var group = new GroupBox("Group Example");
// Must register change events on each radio button.
var choice1 = new RadioButton("First Choice");
choice1.RegisterValueChangedCallback(v => Debug.Log("Choice 1 is : " + v.newValue));
var choice2 = new RadioButton("Second Choice");
choice2.RegisterValueChangedCallback(v => Debug.Log("Choice 2 is : " + v.newValue));
var choice3 = new RadioButton("Third Choice");
choice3.RegisterValueChangedCallback(v => Debug.Log("Choice 3 is : " + v.newValue));
group.Add(choice1);
group.Add(choice2);
group.Add(choice3);
rootVisualElement.Add(group);

C# のクラスと名前空間

C#クラス: GroupBox
名前空間: UnityEngine.UIElements
基本クラス: BindableElement

メンバー UXML 属性

この要素は以下のメンバー属性を持ちます。

名前 説明
text string ボックスのタイトルテキストです。

継承された UXML 属性

この要素は基本クラスから以下の属性を継承します。

名前 説明
binding-path string バインドされるべきターゲットプロパティのパス。
focusable boolean 要素がフォーカス可能である場合は true。
tabindex int フォーカスリング内でフォーカス可能なものをソートするために使用される整数。0 以上であることが必要です。

この要素は、VisualElement から以下の属性も継承します。

名前 説明
content-container string 子要素はそれに追加されますが、通常は要素自体と同じです。
name string この VisualElement の名前。

このプロパティを使用して、特定の要素を対象とする USS セレクターを記述します。要素には一意の名前を付けるのが標準的です。
picking-mode UIElements.PickingMode mouseEvents または IPanel.Pick クエリの間にこの要素を選択 (ピック) できるかどうかを決定します。
style string この要素のスタイルオブジェクトへの参照。

C# でこのオブジェクトに書き込まれた USS ファイルまたはインラインスタイルから計算されたデータが含まれます。
toolbar string ユーザーが要素をマウスオーバーした後、わずかな時間、情報ボックス内に表示するテキスト。これはエディター UI でのみサポートされます。
usage-hints UIElements.UsageHints VisualElement の高レベルの使用パターンを指定するヒント値の組み合わせ。このプロパティは、VisualElement がまだ Panel の一部でない場合にのみ設定できます。Panel の一部になると、このプロパティは事実上読み取り専用となり、変更しようとすると例外がスローされます。適切な UsageHints を指定することで、予想される使用パターンに基づいて、特定の操作をどのように処理するか、または高速化するかについて、システムがより適切な判断を下すようになります。これらのヒントは動作や視覚的な結果には影響しませんが、パネルとその中の要素の全体的なパフォーマンスにのみ影響することに注意してください。常に適切なUsageHints を指定することを考慮することをお勧めしますが、特定の条件下 (例えば、ターゲットプラットフォームのハードウェア制限など) では、いくつかの UsageHints が内部的に無視される可能性があることに留意してください。
view-data-key string ビューデータの永続性 (ツリーの展開状態、スクロール位置、ズームレベルなど) に使用されます。

これは、ビューデータストアからビューデータを保存/ロードするために使用されるキーです。このキーを設定しないと、この VisualElement の永続性が無効になります。

USS クラス

以下の表は、すべての C# パブリックプロパティ名と、それに関連する USS セレクターのリストです。

C# プロパティ USS セレクター 説明
ussClassName .unity-group-box GroupBox 要素の USS クラス名。

Unity はこの USS クラスを GroupBox 要素のすべてのインスタンスに加えます。このクラスに適用されるスタイルは、ビジュアルツリーでスタイルシートの横または下にあるすべての GroupBox に影響します。
labelUssClassName .unity-group-box__label GroupBox 要素のラベルの USS クラス名。

Unity は、GroupBox に Label がある場合、この USS クラスを GroupBoxLabel サブ要素に加えます。
disabledUssClassName .unity-disabled ローカルで無効にされた要素の USS クラス名。

また、Inspector や UI Toolkit Debugger の Matching Selectors セクション を使用して、どの USS セレクターが VisualElementのコンポーネントに影響するかを、階層のすべてのレベルで確認することもできます。

その他の参考資料

UXML要素 GradientField
UXML 要素 Hash128Field