版本:Unity 6 (6000.0)
语言:English
UXML 元素 Scroller
UXML 元素 SliderInt

UXML 元素 Slider

滑块允许用户从一系列值中选择浮点值。您可以使用滑块来调整值,例如声音的音量或灯光的亮度。要设置值,您可以沿着轨道拖动滑块,或点击轨道本身。滑块还可以包含一个文本输入字段允许用户输入文本字符串的字段 更多信息
参见 术语表
,您可以在其中直接修改值。

注意:要将元素与 检查器一个 Unity 窗口,显示有关当前选定游戏对象、资源或项目设置的信息,允许您检查和编辑值。 更多信息
参见 术语表
窗口中的其他字段对齐,只需将 .unity-base-field__aligned USS 类应用于它即可。有关更多信息,请参阅 BaseField

创建滑块

您可以使用 UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。 更多信息
参见 术语表
构建器、UXML 或 C# 创建滑块。以下 C# 示例创建了一个具有默认值、低值和高值的滑块,并设置了滑块的方向

var slider = new Slider();
slider.value = 0.5f;
slider.lowValue = 0;
slider.highValue = 100;
slider.direction = SliderDirection.Horizontal;

设置页面大小

滑块控件具有一个页面大小属性,该属性控制单击滑块拇指两侧的轨道时拇指移动的距离以及值变化的幅度。

如果页面大小值为 0,则单击轨道会将拇指移动到光标或指针位置,并相应地更新值。

如果页面大小值大于 0,则单击轨道会将拇指向光标或指针位置移动特定距离。滑块控件将页面大小视为总范围的百分比。

例如,如果总范围是 200,页面大小是 20,则页面大小金额是 200 的 20%,即 40。每次单击轨道时,拇指都会移动,并且值增加或减少 40。

示例

以下 UXML 示例创建了一个滑块

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <Slider
        label="UXML Slider"
        name="the-uxml-slider"
        low-value="0"
        high-value="100"
        page-size="1"
        value="42.2" />
</UXML>

以下 C# 示例说明了滑块的一些可自定义功能

/// <sample>
// Get a reference to the slider from UXML and assign it its value.
var uxmlSlider = container.Q<Slider>("the-uxml-slider");
uxmlSlider.value = 42.2f;

// Create a new slider, disable it, and give it a style class.
var csharpSlider = new Slider("C# Slider", 0, 100);
csharpSlider.SetEnabled(false);
csharpSlider.AddToClassList("some-styled-slider");
csharpSlider.value = uxmlSlider.value;
container.Add(csharpSlider);

// Mirror value of uxml slider into the C# field.
uxmlSlider.RegisterCallback<ChangeEvent<float>>((evt) =>
{
    csharpSlider.value = evt.newValue;
});
/// </sample>

要在 Unity 中实时尝试此示例,请转到 窗口 > UI 工具包 > 示例

C# 基类和命名空间

C# 类Slider
命名空间UnityEngine.UIElements
基类BaseSlider_1

继承的 UXML 属性

此元素从其基类继承以下属性

名称 类型 描述
binding-path string 要绑定的目标属性的路径。
direction UIElements.SliderDirection 这是包含滑块方向的实际属性。
fill boolean 启用填充以设置滑块的颜色和形状。
focusable boolean 如果元素可以聚焦,则为 True。
high-value float 这是滑块编码的最大值。
inverted boolean 这指示此滑块是否已反转。对于反转的水平滑块,高值位于左侧,低值位于右侧。对于反转的垂直滑块,高值位于底部,低值位于顶部。
label string 表示将出现在字段旁边的标签的字符串。
low-value float 这是滑块编码的最小值。
page-size float 表示在滚动滑块时应应用于计算的滚动偏移量的值,例如在轨道内单击或单击滑块箭头时。
show-input-field boolean 滑块控件内可选字段的可见性。

将此属性设置为 true 以显示一个数值文本字段,该字段提供另一种编辑滑块值的方法。
tabindex int 用于在焦点环中对可聚焦项进行排序的整数。必须大于或等于零。
value float 滑块的实际值。

此元素还从 VisualElement 继承以下属性

名称 类型 描述
content-container string 子元素添加到其中,通常与元素本身相同。
data-source Object 为该 VisualElement 分配一个数据源,该数据源覆盖任何继承的数据源。此数据源由所有子项继承。
data-source-path string 从数据源到值的路径。
data-source-type System.Type 可分配给此 VisualElement 的数据源的可能类型。

此信息仅由 UI 构建器用作提示,以便在设计时无法指定有效数据源时为数据源路径字段提供一些自动完成。
language-direction UIElements.LanguageDirection 指示元素文本的方向性。该值将传播到元素的子项。

将 languageDirection 设置为 RTL 通过反转文本并适当地处理换行和自动换行来为从右到左 (RTL) 添加基本支持。但是,它不提供全面的 RTL 支持,因为这需要文本整形,包括字符的重新排序和 OpenType 字体功能支持。全面的 RTL 支持计划在未来的更新中提供,这将涉及其他 API 来处理语言、脚本和字体功能规范。

为了增强此属性的 RTL 功能,用户可以探索 Unity Asset Store 中可用的第三方插件并使用 ITextElementExperimentalFeatures.renderedText
name string 此 VisualElement 的名称。

使用此属性编写针对特定元素的 USS 选择器。标准做法是为元素提供唯一的名称。
picking-mode UIElements.PickingMode 确定在鼠标事件或 IPanel.Pick 查询期间是否可以选择此元素。
style string 设置 VisualElement 样式值。
tooltip 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-slider 此类型元素的 USS 类名称。
labelUssClassName .unity-slider__label 此类型元素中标签的 USS 类名称。
inputUssClassName .unity-slider__input 此类型元素中输入元素的 USS 类名称。
ussClassName .unity-base-slider 此类型元素的 USS 类名称。
labelUssClassName .unity-base-slider__label 此类型元素中标签的 USS 类名称。
inputUssClassName .unity-base-slider__input 此类型元素中输入元素的 USS 类名称。
horizontalVariantUssClassName .unity-base-slider--horizontal 当元素水平显示时,此类型元素的 USS 类名称。
verticalVariantUssClassName .unity-base-slider--vertical 当元素垂直显示时,此类型元素的 USS 类名称。
dragContainerUssClassName .unity-base-slider__drag-container 此类型元素中容器元素的 USS 类名称。
trackerUssClassName .unity-base-slider__tracker 此类型元素中跟踪器元素的 USS 类名称。
draggerUssClassName .unity-base-slider__dragger 此类型元素中拖动器元素的 USS 类名称。
draggerBorderUssClassName .unity-base-slider__dragger-border 此类型元素中拖动器边框元素的 USS 类名称。
fillUssClassName .unity-base-slider__fill 此类型元素中填充元素的 USS 类名称。
ussClassName .unity-base-field 此类型元素的 USS 类名称。
labelUssClassName .unity-base-field__label 此类型元素中标签的 USS 类名称。
inputUssClassName .unity-base-field__input 此类型元素中输入元素的 USS 类名称。
noLabelVariantUssClassName .unity-base-field--no-label 当没有标签时,此类型元素的 USS 类名称。
labelDraggerVariantUssClassName .unity-base-field__label--with-dragger 当附加拖动器时,此类型元素中标签的 USS 类名称。
mixedValueLabelUssClassName .unity-base-field__label--mixed-value 显示混合值的元素的 USS 类名称
alignedFieldUssClassName .unity-base-field__aligned 在检查器元素中对齐的元素的 USS 类名称
disabledUssClassName .unity-disabled 本地禁用元素的 USS 类名称。

您还可以使用 检查器或 UI 工具包调试器中的匹配选择器部分查看哪些 USS 选择器影响其层次结构中每个级别的 VisualElement 的组件。

其他资源

UXML 元素 Scroller
UXML 元素 SliderInt