当与组中的其他 RadioButton 结合使用时,RadioButton 允许用户选择单个选项。您可以使用GroupBox 对 RadioButton 进行分组。否则,面板 将充当默认组。
注意:要将元素与 检查器一个 Unity 窗口,显示有关当前选定游戏对象、资源或项目设置的信息,允许您检查和编辑值。更多信息
参见术语表 窗口中的其他字段对齐,只需将.unity-base-field__aligned
USS 类应用于它即可。有关更多信息,请参阅BaseField
。
您可以使用UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。更多信息
参见术语表 构建器、UXML 或 C# 创建 RadioButton。以下 C# 示例在同一个容器中创建两个新的单选按钮,并在面板中将它们逻辑地组合在一起。
var choice1 = new RadioButton() { text = "Choice 1" };
choice1.RegisterValueChangedCallback(v => Debug.Log("Choice 1 is : " + v.newValue));
var choice2 = new RadioButton() { text = "Choice 2" };
choice2.RegisterValueChangedCallback(v => Debug.Log("Choice 2 is : " + v.newValue));
container.Add(choice1);
container.Add(choice2);
以下 UXML 示例创建了一个 RadioButton
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
<GroupBox>
<RadioButton label="UXML Field 1" name="the-uxml-field1" />
<RadioButton label="UXML Field 2" name="the-uxml-field2" />
</GroupBox>
</UXML>
以下 C# 示例说明了 RadioButton 的一些可自定义功能
/// <sample>
// Note: See also RadioButtonGroup in the ChoiceField section of UI Toolkit Samples
// Get a reference to the first radio button from UXML and assign a value to it.
var uxmlField1 = container.Q<RadioButton>("the-uxml-field1");
var uxmlField2 = container.Q<RadioButton>("the-uxml-field2");
uxmlField1.value = true;
// Create two RadioButtons in a separate group, disable them, and give them a style class.
var groupBox = new GroupBox();
container.Add(groupBox);
var csharpField1 = new RadioButton("C# Field 1");
csharpField1.SetEnabled(false);
csharpField1.AddToClassList("some-styled-field");
groupBox.Add(csharpField1);
var csharpField2 = new RadioButton("C# Field 2");
csharpField2.SetEnabled(false);
csharpField2.AddToClassList("some-styled-field");
groupBox.Add(csharpField2);
csharpField1.value = uxmlField1.value;
// Mirror the value of the UXML field into the C# field.
uxmlField1.RegisterCallback<ChangeEvent<bool>>((evt) =>
{
csharpField1.value = evt.newValue;
});
uxmlField2.RegisterCallback<ChangeEvent<bool>>((evt) =>
{
csharpField2.value = evt.newValue;
});
/// </sample>
要在 Unity 中实时尝试此示例,请转到窗口 > UI 工具包 > 示例。
C# 类:RadioButton
命名空间:UnityEngine.UIElements
基类:BaseBoolField
此元素从其基类继承以下属性
名称 | 类型 | 描述 |
---|---|---|
binding-path |
字符串 |
要绑定的目标属性的路径。 |
focusable |
布尔值 |
如果元素可以聚焦,则为真。 |
label |
字符串 |
表示将在字段旁边显示的标签的字符串。 |
tabindex |
整数 |
用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。 |
text |
字符串 |
出现在 BaseBoolField 后面的可选文本。 如果不存在,Unity 会自动创建一个 Label 。 |
toggle-on-label-click |
布尔值 |
是否在用户单击标签时激活切换。 |
value |
布尔值 |
与字段关联的值。 |
此元素还从VisualElement
继承以下属性
名称 | 类型 | 描述 |
---|---|---|
content-container |
字符串 |
子元素被添加到其中,通常与元素本身相同。 |
data-source |
对象 |
为该 VisualElement 分配数据源,该数据源会覆盖任何继承的数据源。此数据源由所有子项继承。 |
data-source-path |
字符串 |
从数据源到值的路径。 |
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 |
字符串 |
此 VisualElement 的名称。 使用此属性编写针对特定元素的 USS 选择器。标准做法是为元素指定唯一名称。 |
picking-mode |
UIElements.PickingMode |
确定此元素是否可以在 mouseEvents 或IPanel.Pick 查询期间被选中。 |
style |
字符串 |
设置VisualElement 样式值。 |
tooltip |
字符串 |
在用户将鼠标悬停在元素上一段时间后,在信息框内显示的文本。这仅在编辑器 UI 中受支持。 |
usage-hints |
UIElements.UsageHints |
指定VisualElement 的高级预期使用模式的提示值组合。仅当VisualElement 尚未成为Panel 的一部分时,才能设置此属性。一旦成为Panel 的一部分,此属性实际上就成为只读的,尝试更改它将引发异常。正确UsageHints 的规范会驱动系统做出更好的决策,关于如何根据预期的使用模式处理或加速某些操作。请注意,这些提示不会影响行为或视觉结果,而只会影响面板和内部元素的整体性能。建议始终考虑指定正确的UsageHints ,但请记住,某些UsageHints 在某些条件下可能会被内部忽略(例如,由于目标平台上的硬件限制)。 |
view-data-key |
字符串 |
用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。 此键用于从视图数据存储中保存和加载视图数据。如果您不设置此键,则关联的 VisualElement 的持久性将被禁用。有关更多信息,请参阅视图数据持久性。 |
下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。
C# 属性 | USS 选择器 | 描述 |
---|---|---|
ussClassName |
.unity-radio-button |
RadioButton 元素的 USS 类名称。 Unity 将此 USS 类添加到 RadioButton 元素的每个实例。应用于此类的任何样式都会影响视觉树中样式表旁边或下方的每个 RadioButton。 |
labelUssClassName |
.unity-radio-button__label |
RadioButton 元素中标签的 USS 类名称。 如果 RadioButton 有标签,Unity 会将此 USS 类添加到 RadioButton 的Label 子元素。 |
inputUssClassName |
.unity-radio-button__input |
RadioButton 元素中输入元素的 USS 类名称。 Unity 将此 USS 类添加到 RadioButton 的输入子元素。输入子元素提供对操纵器的响应。 |
checkmarkBackgroundUssClassName |
.unity-radio-button__checkmark-background |
RadioButton 元素中复选标记背景的 USS 类名称。 Unity 将此 USS 类添加到 RadioButton 的复选标记背景子元素。 |
checkmarkUssClassName |
.unity-radio-button__checkmark |
RadioButton 元素中复选标记的 USS 类名称。 Unity 将此 USS 类添加到 RadioButton 的复选标记子元素。 |
textUssClassName |
.unity-radio-button__text |
RadioButton 元素中文本元素的 USS 类名称。 Unity 将此 USS 类添加到 RadioButton 的文本子元素。 |
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
的组件。