UXML 要素 ProgressBar

ProgressBar 要素は、進行中のタスクやプロセスの進行状況を表示します。ファイルのダウンロードやゲームレベルのロードなど、完了までに時間がかかるタスクの進行状況についてユーザーに視覚的なフィードバックを提供する場合に使用します。

プログレスバーの作成

UI Builder、UXML、C# を使ってプログレスバーを作成できます。

C# で ProgressBar を作成するには、ProgressBar オブジェクトの新しいインスタンスを作成します。以下はその例です。

ProgressBar myElement = new ProgressBar("Label text");

バーのカスタマイズ

バーのスタイルを変更するには、.unity-progress-bar__progress USS セレクターを使用します。例えば、以下の USS はバーのサイズと色を変更します。

.unity-progress-bar__progress {
    width: 20px;
    height: 50px;
    background-color: yellow;
}

C# の基本クラスと名前空間

C#クラス: ProgressBar
名前空間: UnityEngine.UIElements
基本クラス: AbstractProgressBar

継承された UXML 属性

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

名前	型	説明
`binding-path`	`string`	バインドされるべきターゲットプロパティのパス。
`focusable`	`boolean`	要素がフォーカス可能である場合は true。
`high-value`	`float`	ProgressBar の最大値を設定します。
`low-value`	`float`	ProgressBar の最小値を設定します。
`tabindex`	`int`	フォーカスリング内でフォーカス可能なものをソートするために使用される整数。0 以上であることが必要です。
`title`	`string`	コントロールの中央に表示される ProgressBar のタイトルを設定します。
`value`	`float`	進捗値を設定します。値が変更された場合、float 型の `ChangeEvent_1` をディスパッチします。

この要素は、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-progress-bar`	`ProgressBar` のスタイルに使用される USS クラス名。
`containerUssClassName`	`.unity-progress-bar__container`	`ProgressBar` のコンテナのスタイルに使用される USS クラス名。
`titleUssClassName`	`.unity-progress-bar__title`	`ProgressBar` のタイトルのスタイルに使用される USS クラス名。
`titleContainerUssClassName`	`.unity-progress-bar__title-container`	`ProgressBar` のタイトルのコンテナのスタイルに使用される USS クラス名。
`progressUssClassName`	`.unity-progress-bar__progress`	`ProgressBar` の進捗バーのスタイルに使用される USS クラス名。
`backgroundUssClassName`	`.unity-progress-bar__background`	`ProgressBar` の背景のスタイルに使用される USS クラス名。
`disabledUssClassName`	`.unity-disabled`	ローカルで無効にされた要素の USS クラス名。

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

その他の参考資料

UXML 要素 PopupWindow

UXML 要素 PropertyField