版本:Unity 6 (6000.0)
语言:English
UXML 元素 RadioButton
UXML 元素 RectField

UXML 元素 RadioButtonGroup

RadioButtonGroup 在一组逻辑上的单选按钮中提供单选功能。选择一个会取消其他选项。RadioButtonGroup 类似于 DropdownField,不同之处在于它在UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。更多信息
参见 术语表
中显示所有选项。

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

创建 RadioButtonGroup

您可以使用 UI Builder、UXML 或 C# 创建 RadioButtonGroup。

UI Builder

在 UI Builder 中,您可以通过在 RadioButtonGroup 的 Inspector 面板中位于“选项”字段中输入您想要的选项(用逗号分隔)来向 RadioButtonGroup 添加选项。

要设置默认值,请在 RadioButtonGroup 的 Inspector 中,在“值”中输入选项的编号序列,从 0 开始。

C#

以下 C# 示例创建了一个包含四个选项的新 RadioButtonGroup,并注册到其值更改回调

var radiogroup = new RadioButtonGroup("Options", new List<string> { "Option 1", "Option 2", "Option 3", "Option 4" });
radiogroup.RegisterValueChangedCallback(evt => Debug.Log(evt.newValue));
window.rootVisualElement.Add(radiogroup);

示例

以下 UXML 示例创建了一个 RadioButtonGroup

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <RadioButtonGroup label="UXML Field" name="the-uxml-field" />
</UXML>

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

/// <sample>
// You can provide the list of choices by code, or by comma separated values in UXML
// <DropdownField .... choices="Option 1,Option 2,Option 3" .... />
var choices = new List<string> { "Option 1", "Option 2", "Option 3" };

// Get a reference to the radio button group field from UXML and assign a value to it.
var uxmlField = container.Q<RadioButtonGroup>("the-uxml-field");
uxmlField.choices = choices;
uxmlField.value = 0;

// Create a new field, disable it, and give it a style class.
var csharpField = new RadioButtonGroup("C# Field", choices);
csharpField.value = 0;
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
csharpField.value = uxmlField.value;
container.Add(csharpField);

// Mirror the value of the UXML field into the C# field.
uxmlField.RegisterCallback<ChangeEvent<int>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

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

C# 类和命名空间

C# 类RadioButtonGroup
命名空间UnityEngine.UIElements
基类BaseField_1

成员 UXML 属性

此元素具有以下成员属性

名称 类型 描述
choices IList 组中可用选项的列表。

写入此属性会删除现有的 RadioButton 元素并重新创建它们以显示新列表。

继承的 UXML 属性

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

名称 类型 描述
binding-path string 要绑定的目标属性的路径。
focusable boolean 如果元素可以聚焦,则为真。
label string 表示将出现在字段旁边的标签的字符串。
tabindex int 用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
value 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 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-radio-button-group RadioButtonGroup 元素的 USS 类名称。

Unity 将此 USS 类添加到 RadioButtonGroup 元素的每个实例。应用于此类的任何样式都会影响视觉树中样式表旁边或下方的每个 RadioButtonGroup。
containerUssClassName .unity-radio-button-group__container 此类型的容器元素的 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 在 Inspector 元素中对齐的元素的 USS 类名称
disabledUssClassName .unity-disabled 本地禁用元素的 USS 类名称。

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

其他资源

UXML 元素 RadioButton
UXML 元素 RectField