ScrollView 在可滚动区域内显示其内容。将内容添加到__ ScrollView__ 时,内容将添加到 ScrollView 的内容容器 (#unity-content-container)。
您可以使用__ UI__(即用户界面,User Interface)让用户能够与您的应用程序进行交互。Unity 目前支持三种 UI 系统。更多信息
See in Glossary Builder、UXML 或 C# 创建 ScrollView。以下 C# 示例将创建具有水平和垂直滚动功能的 ScrollView,其中包含一个标题标签和多个 Toggle 元素:
var scrollView = new ScrollView(ScrollViewMode.VerticalAndHorizontal);
scrollView.style.width = 250;
scrollView.style.height = 400;
scrollView.Add(new Label("List of checkboxes:"));
for (int i = 0; i < 100; ++i)
{
var toggle = new UnityEngine.UIElements.Toggle()
{ text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." };
scrollView.Add(toggle);
}
您可以指定滚动条的移动方向,是否显示水平或垂直滚动条,并控制滚动条的速度。
要在 UI Builder 中设置滚动条移动的方向,请在滚动视图 (ScrollView) 的检视面板 (Inspector) 窗口中为模式 (Mode) 选择以下选项之一:
要在 UI Builder 中设置滚动条的可见性,请在滚动视图 (ScrollView) 的检视面板 (Inspector) 窗口中,选择以下选项之一来设置水平滚动条可见性 (Horizontal Scroller Visibility) 或垂直滚动条可见性 (Vertical Scroller Visibility):
要控制滚动速度,请在 UI Builder、UXML 或 C# 代码中调整以下属性的值。该值越大,滚动速度越快。
horizontal-page-size 控制使用键盘或屏幕上的滚动条按钮(箭头和控制柄)时的水平滚动速度。速度的计算方法是将页面大小乘以指定值。例如,值为 2 表示每次滚动移动的距离等于页面宽度的两倍。vertical-page-size 控制使用键盘或屏幕上的滚动条按钮(箭头和控制柄)时的垂直滚动速度。速度的计算方法是将页面大小乘以指定值。例如,值为 2 表示每次滚动移动的距离等于页面长度的两倍。mouse-wheel-scroll-size 控制使用鼠标滚轮时的滚动速度。速度的计算方法是将指定值除以 18,对应于默认的 18px 线高度。例如,如果将值设置为 36,则每次滚动移动的距离相当于两行内容。
注意:还可以通过覆盖 USS 内置变量 –unity-metrics-single_line-height 来控制使用鼠标滚轮时的滚动速度。mouse-wheel-scroll-size 属性优先于 –unity-metrics-single_line-height USS 变量。
您可以将视觉元素放入 ScrollView 中,这样元素会按行显示。如果一行已满,元素会继续显示在下一行。
要在 ScrollView 中让元素的文本内容自动换行,请将 ScrollView 的内容容器 flex-direction 设置为 row,并将 flex-wrap 设置为 wrap。
在 USS 中:
.unity-scroll-view__content-container {
flex-direction: row;
flex-wrap: wrap;
}
在 C# 中:
scrollview.contentContainer.style.flexDirection = FlexDirection.Row;
scrollview.contentContainer.style.flexWrap = Wrap.Wrap;
要在 ScrollView 中让元素的文本内容换行,例如 Label 元素的文本,请执行以下操作:
white-space: normal; 应用于 USS、UXML 或 C# 中的 Label 元素。
C# 类:ScrollView
命名空间:UnityEngine.UIElements
基类:VisualElement
此元素具有以下成员属性:
| 名称 | 类型 | 描述 |
|---|---|---|
elastic-animation-interval-ms |
long |
弹性弹簧动画执行过程之间的最短时间(单位:毫秒)。 |
elasticity |
float |
用户尝试滚动并超出滚动视图边界时使用的弹性量。 仅当 touchScrollBehavior 设置为 Elastic 时才使用 Elasticity。 |
horizontal-page-size |
float |
此属性根据页面大小来控制使用键盘或屏幕滚动条按钮(箭头和手柄)时的水平滚动速度。 滚动时,页面大小将应用于每一步滚动的偏移量,因此最终偏移量将是页面大小乘以步数。另请参阅:BaseSlider_1::ref::pageSize。 |
horizontal-scroller-visibility |
UIElements.ScrollerVisibility |
指定水平滚动条是否可见。 |
mode |
UIElements.ScrollViewMode |
控制 ScrollView 允许用户滚动内容的方式。ScrollViewMode 默认值为 ScrollViewMode.Vertical。写入此属性将根据指定的 ScrollViewMode 值修改 ScrollView 的类列表。当值更改时,将删除与旧值匹配的类列表,并添加与新值匹配的类列表。 |
mouse-wheel-scroll-size |
float |
仅当使用鼠标滚轮时,此属性可根据页面大小控制滚动速度。它优先于 –unity-metrics-single_line-height USS 变量。 |
nested-interaction-kind |
UIElements.ScrollView+NestedInteractionKind |
滚动达到嵌套 ScrollView 的限制时使用的行为。 |
scroll-deceleration-rate |
float |
控制用户使用触控交互进行滚动后滚动移动减慢的速度。 减速度是每秒的速度下降。此值为 0.5 时,每秒钟速度下降一半。值为 0 会立即停止滚动。 |
vertical-page-size |
float |
此属性根据页面大小来控制使用键盘或屏幕滚动条按钮(箭头和手柄)时的水平滚动速度。 速度的计算方法是将页面大小乘以指定值。例如,值为 2 表示每次滚动移动的距离等于页面宽度的两倍。 |
vertical-scroller-visibility |
UIElements.ScrollerVisibility |
指定垂直滚动条是否可见。 |
此元素从其基类继承以下属性:
| 名称 | 类型 | 描述 |
|---|---|---|
focusable |
boolean |
如果元素可以聚焦,则为 true。 |
tabindex |
int |
用于对焦点环中可获得焦点的元素排序的整数。必须大于或等于零。 |
此元素还从 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 字体功能支持。未来更新计划提供全面的 RTL 支持,这将涉及额外的 API 来处理语言、脚本和字体功能规范。 要增强此属性的 RTL 功能,用户可以在 Unity 资源商店中探索可用的第三方插件,并使用 ITextElementExperimentalFeatures.renderedText
|
name |
string |
此 VisualElement 的名称。 使用此属性可编写针对特定元素的 USS 选择器。标准做法是为元素指定唯一名称。 |
picking-mode |
UIElements.PickingMode |
确定是否可以在 mouseEvents 或 IPanel.Pick 查询期间选择此元素。 |
style |
string |
设置 VisualElement 样式值。 |
tooltip |
string |
用户将光标悬停在元素上一小段时间后信息框内显示的文本。仅在编辑器 UI 中受支持。 |
usage-hints |
UIElements.UsageHints |
用于指定 VisualElement 高级预期使用模式的提示值组合。仅当 VisualElement 尚未成为 Panel 的一部分时,才能设置此属性。一旦成为 Panel 的一部分,此属性实际上就变为只读,尝试更改此属性将显示异常。适当的 UsageHints 规范会促使系统根据预期的使用模式,做出更好的决策,以处理或加速某些操作。请注意,这些提示不会影响行为或视觉效果,只会影响面板及其元素的整体性能。建议始终考虑指定适当的 UsageHints,但请记住,在某些情况下(例如,由于目标平台上的硬件限制),某些 UsageHints 可能会在内部被忽略。 |
view-data-key |
string |
用于 View Data 持久性,例如树展开状态、滚动位置或缩放级别。 此键用于保存和加载 View Data 存储中的视图数据。如果未设置此键,则会对关联的 VisualElement 禁用持久性。有关更多信息,请参阅 View Data 持久性。 |
下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。
| C# 属性 | USS 选择器 | 描述 |
|---|---|---|
ussClassName |
.unity-scroll-view |
此类型元素的 USS 类名称。 |
viewportUssClassName |
.unity-scroll-view__content-viewport |
此类型元素中视口元素的 USS 类名称。 |
horizontalVariantViewportUssClassName |
.unity-scroll-view__content-viewport--horizontal |
当视口处于横向模式时添加的 USS 类名称。ScrollViewMode.Horizontal
|
verticalVariantViewportUssClassName |
.unity-scroll-view__content-viewport--vertical |
当视口处于纵向模式时添加的 USS 类名称。ScrollViewMode.Vertical
|
verticalHorizontalVariantViewportUssClassName |
.unity-scroll-view__content-viewport--vertical-horizontal |
当视口处于横向和纵向模式时添加的 USS 类名称。ScrollViewMode.VerticalAndHorizontal
|
contentAndVerticalScrollUssClassName |
.unity-scroll-view__content-and-vertical-scroll-container |
此类型元素中内容元素的 USS 类名称。 |
contentUssClassName |
.unity-scroll-view__content-container |
此类型元素中内容元素的 USS 类名称。 |
horizontalVariantContentUssClassName |
.unity-scroll-view__content-container--horizontal |
当 ContentContainer 处于横向模式时添加的 USS 类名称。ScrollViewMode.Horizontal
|
verticalVariantContentUssClassName |
.unity-scroll-view__content-container--vertical |
当 ContentContainer 处于纵向模式时添加的 USS 类名称。ScrollViewMode.Vertical
|
verticalHorizontalVariantContentUssClassName |
.unity-scroll-view__content-container--vertical-horizontal |
当 ContentContainer 处于横向和纵向模式时添加的 USS 类名称。ScrollViewMode.VerticalAndHorizontal
|
hScrollerUssClassName |
.unity-scroll-view__horizontal-scroller |
此类型元素中水平滚动条的 USS 类名称。 |
vScrollerUssClassName |
.unity-scroll-view__vertical-scroller |
此类型元素中垂直滚动条的 USS 类名称。 |
horizontalVariantUssClassName |
.unity-scroll-view--horizontal |
当滚动视图处于横向模式时添加的 USS 类名称。ScrollViewMode.Horizontal
|
verticalVariantUssClassName |
.unity-scroll-view--vertical |
当滚动视图处于纵向模式时添加的 USS 类名称。ScrollViewMode.Vertical
|
verticalHorizontalVariantUssClassName |
.unity-scroll-view--vertical-horizontal |
当滚动视图处于横向和纵向模式时添加的 USS 类名称。ScrollViewMode.VerticalAndHorizontal
|
scrollVariantUssClassName |
.unity-scroll-view--scroll |
|
disabledUssClassName |
.unity-disabled |
本地被禁用元素的 USS 类名称。 |
还可以使用检视器中的匹配选择器 (Matching Selectors) 部分或 UI 工具包调试器来查看哪些 USS 选择器在其层级视图的每个级别上影响 VisualElement 的组件。