Scroller を使用すると、ユーザーがユーザーインターフェースのコンテンツをスクロールできるようになります。
Scroller は、UI Builder、UXML、C# で作成できます。以下の C# の例では、デフォルト値、下限、上限を指定して Scroller を作成し、Scroller の向きを設定します。
var scroller = new Scroller();
scroller.value = 42;
scroller.lowValue = 0;
scroller.highValue = 100;
scroller.direction = SliderDirection.Vertical;
以下の UXML の例では、Scroller を作成します。
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
<Scroller
name="the-uxml-scroller"
direction="Horizontal"
low-value="0"
high-value="100" />
</UXML>
以下の C# の例は、Scroller のカスタマイズ可能な機能の一部を示しています。
/// <sample>
// Get a reference to the scroller from UXML and assign it its value.
var uxmlField = container.Q<Scroller>("the-uxml-scroller");
uxmlField.valueChanged += (v) => {};
uxmlField.value = 42;
// Create a new scroller, disable it, and give it a style class.
var csharpField = new Scroller(0, 100, (v) => {}, SliderDirection.Vertical);
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-scroller");
csharpField.value = uxmlField.value;
container.Add(csharpField);
// Mirror value of uxml scroller into the C# field.
uxmlField.RegisterCallback<ChangeEvent<float>>((evt) =>
{
csharpField.value = evt.newValue;
});
/// </sample>
この例を Unity でライブ体験するには、Window > UI Toolkit > Samples の順に移動します。
C# クラス: Scroller
名前空間: UnityEngine.UIElements
基本クラス: VisualElement
この要素は以下のメンバー属性を持ちます。
| 名前 | 型 | 説明 |
|---|---|---|
direction |
UIElements.SliderDirection |
このスクロールバーの向き。 |
high-value |
float |
最大値。 |
low-value |
float |
最小値。 |
value |
float |
スライダー位置を定義する値。これは、lowValue と highValue の間にあります。 |
この要素は基本クラスから以下の属性を継承します。
| 名前 | 型 | 説明 |
|---|---|---|
focusable |
boolean |
要素がフォーカス可能である場合は true。 |
tabindex |
int |
フォーカスリング内のフォーカス可能な要素をソートするために使用される整数。0 以上の値に設定する必要があります。 |
この要素は VisualElement から以下の属性も継承します。
| 名前 | 型 | 説明 |
|---|---|---|
content-container |
string |
子要素が追加されますが、通常は子要素は要素自体と同じです。 |
data-source |
Object |
継承されたデータソースをオーバーライドするこの VisualElement にデータソースを割り当てます。このデータソースはすべての子に継承されます。 |
data-source-path |
string |
データソースから値へのパス。 |
data-source-type |
System.Type |
この VisualElement に割り当て可能なデータソースの型。 この情報は、設計時に有効なデータソースを指定できない場合に、データソースパスフィールドを補完するヒントとして UI Builder でのみ使用されます。 |
language-direction |
UIElements.LanguageDirection |
要素のテキストの向きを示します。値は要素の子に伝播されます。 languageDirection を RTL に設定すると、テキストの反転と改行/折り返しの適切な処理による、右から左へ (RTL) の基本サポートが追加されます。ただし、包括的な RTL サポートは提供されません。これには、文字の並べ替えを含むテキストシェーピングと OpenType フォント機能のサポートが必要になるためです。将来のアップデートでは、言語、スクリプト、フォント機能の仕様に対応するための追加の API を含む、包括的な RTL サポートが予定されています。 このプロパティの RTL 機能を拡張するには、Unity Asset Store で入手可能なサードパーティ製のプラグインを探し、 ITextElementExperimentalFeatures.renderedText を利用してください。 |
name |
string |
この VisualElement の名前。 このプロパティを使用して、特定の要素を対象とする USS セレクターを記述します。要素には一意の名前を付けるのが標準的です。 |
picking-mode |
UIElements.PickingMode |
mouseEvent または IPanel.Pick クエリの間にこの要素を選択 (ピック) できるかどうかを決定します。 |
style |
string |
VisualElement スタイルの値を設定します。 |
tooltip |
string |
ユーザーが要素をマウスオーバーした後、わずかな時間、情報ボックス内に表示するテキスト。これはエディター UI でのみサポートされます。 |
usage-hints |
UIElements.UsageHints |
VisualElement の意図されている使用パターンの概要を指定するヒント値の組み合わせ。このプロパティは、VisualElement がまだ Panel の一部でない場合にのみ設定できます。Panel の一部になると、このプロパティは事実上読み取り専用となり、変更しようとすると例外がスローされます。適切な UsageHints を指定することで、システムは、予想される使用パターンに基づいて、特定の操作を処理または加速する方法をより適切に決定できるようになります。これらのヒントは動作や視覚的な結果には影響せず、パネルとその中の要素の全体的なパフォーマンスにのみ影響することに注意してください。常に適切な UsageHints を指定するように検討することをお勧めしますが、特定の条件下 (例: ターゲットプラットフォームのハードウェア制限) では、一部の UsageHints が内部的に無視される可能性があることに留意してください。 |
view-data-key |
string |
ビューデータの永続性 (ツリーの展開状態、スクロール位置、ズームレベルなど) に使用されます。 このキーは、ビューデータストアからビューデータを保存およびロードするために使用されます。このキーを設定しないと、関連する VisualElement の永続性が無効になります。詳細については、ビューデータの永続性を参照してください。 |
以下の表は、すべての C# パブリックプロパティ名と、それに関連する USS セレクターのリストです。
| C# プロパティ | USS セレクター | 説明 |
|---|---|---|
ussClassName |
.unity-scroller |
この型の要素の USS クラス名。 |
horizontalVariantUssClassName |
.unity-scroller--horizontal |
この型の要素の USS クラス名 (水平に表示されている場合)。 |
verticalVariantUssClassName |
.unity-scroller--vertical |
この型の要素の USS クラス名 (垂直に表示されている場合)。 |
sliderUssClassName |
.unity-scroller__slider |
この型の要素のスライダー要素の USS クラス名。 |
lowButtonUssClassName |
.unity-scroller__low-button |
この型の要素の低ボタンの USS クラス名。 |
highButtonUssClassName |
.unity-scroller__high-button |
この型の要素の高ボタンの USS クラス名。 |
disabledUssClassName |
.unity-disabled |
ローカルで無効にされた要素の USS クラス名。 |
Inspector または UI Toolkit Debugger の Matching Selectors セクション を使用して、階層のすべてのレベルで VisualElement のコンポーネントに影響する USS セレクターを確認することもできます。