包含此页的版本:
不含此页的版本:
切换包括图像和标签。就像其他标准 UI 工具包控件(如 Button)一样,Toggle 附加了一个 Clickable纵器,该纵器注册到MouseUpEvent和PointerUpEvent.当其中一个事件触发纵器时,切换的值会从true自false或从false自true.您可以读取或设置切换的当前值。您还可以将 Toggle 绑定到Boolean变量。
您可以根据其他条件(例如从下拉列表中选择的元素或启用的选项)显示或隐藏元素。条件 UI 的一个示例是 Unity相机在场景中创建特定视点图像的组件。输出要么绘制到屏幕上,要么作为纹理捕获。更多信息
请参阅术语表 检查器一个 Unity 窗口,显示有关当前选定游戏对象、资产或项目设置的信息,允许您检查和编辑值。更多信息
请参阅术语表.当您激活物理摄像机模式时,它会显示其他选项。
注意:要将元素与 Inspector 窗口中的其他字段对齐,只需将.unity-base-field__alignedUSS 级。有关更多信息,请参阅BaseField.
你可以使用 UI Builder、UXML 或 C# 创建 Toggle。
以下 C# 示例创建具有特定标签的 Toggle:
Toggle myToggle = new Toggle("Click me");
默认情况下,“切换”控件显示为复选框。您可以应用样式,使其看起来像典型的切换开关。
要设置切换复选框的样式,请使用.unity-toggle__input和.unity-toggle__checkmarkstyle 属性。例如,如果您应用了名为className到 Toggle。以下 USS 在选择或清除切换开关时更改复选框的背景图像:
/* Set the background image when the checkbox is selected. */
.className:checked > .unity-toggle__input > .unity-toggle__checkmark {
background-image: url("path/to/image-file");
}
/* Set the background image When the checkbox is not selected. */
.className > .unity-toggle__input > .unity-toggle__checkmark {
background-image: url("path/to/image-file");
}
以下UXML示例创建了一个切换:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
<Toggle label="UXML Field" name="the-uxml-field" />
</UXML>
以下 C# 示例演示了 Toggle 的一些可自定义功能:
/// <sample>
// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<Toggle>("the-uxml-field");
uxmlField.value = true;
// Create a new field, disable it, and give it a style class.
var csharpField = new Toggle("C# Field");
csharpField.value = false;
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<bool>>((evt) =>
{
csharpField.value = evt.newValue;
});
/// </sample>
若要在 Unity 中实时试用此示例,请转到 Window > UI 工具包>示例。
有关更多示例,请参阅以下内容:
C# 类:Toggle
命名空间:UnityEngine.UIElements
基类:BaseBoolField
此元素从其基类继承以下属性:
| 名字 | 类型 | 描述 |
|---|---|---|
binding-path |
string |
要绑定的目标属性的路径。 |
focusable |
boolean |
如果为 false,则不会聚焦元素。 只有当元素的 canGrabFocus 属性为 true 时,才能聚焦该元素。 |
label |
string |
表示将显示在字段旁边的标签的字符串。如果字符串为空,则标签元素将从层次结构中删除。如果字符串不为空,则标签元素将添加到层次结构中。 |
tabindex |
int |
用于对焦点环中的可聚焦元素进行排序的整数。必须大于或等于零。 设置 tabIndex值小于0(例如,−1) 从焦点环和选项卡导航中删除元素。 |
text |
string |
在 BaseBoolField 之后显示的可选文本。 Unity 会创建一个 Label如果不存在,则自动。 |
toggle-on-label-click |
boolean |
是否在用户单击标签时激活切换。 |
value |
boolean |
与字段关联的值。 |
此元素还继承了以下属性VisualElement:
| 名字 | 类型 | 描述 |
|---|---|---|
content-container |
string |
添加子元素的逻辑容器。如果将子项添加到此元素,则该子项将改为添加到此元素的内容容器中。 迭代 VisualElement.Children元素的,则使用元素的内容容器层次结构而不是元素本身。这可能会导致意外结果,例如,如果元素不直接位于内容容器的层次结构中,则导航事件会忽略元素。指IFocusRing了解更多信息。如果内容容器与元素本身相同,则子元素将直接添加到元素中。对于大多数元素来说都是如此,但可以被更复杂的类型覆盖。 这 ScrollView例如,具有与自身不同的内容容器。在这种情况下,添加到滚动视图的子元素将改为添加到其内容容器元素中。虽然物理父级 (VisualElement.Hierarchy.parent) 是滚动视图的内容容器元素,它们的逻辑父元素 (VisualElement.parent) 仍然引用滚动视图本身。由于滚动视图的一些可聚焦子项不是其逻辑层次结构的一部分,例如Scroller元素,在使用顺序导航时,默认情况下不考虑这些可聚焦的子项。如果默认导航规则与您的需求不符,请参阅如何更改接下来关注的元素,了解解决方法解决方案的示例。 |
data-source |
Object |
将数据源分配给此 VisualElement,该 VisualElement 将替代任何继承的数据源。此数据源由所有子级继承。 |
data-source-path |
string |
从数据源到值的路径。 |
data-source-type |
System.Type |
可分配给此 VisualElement 的可能数据源类型。 当设计时无法指定有效数据源时,UI 生成器仅将 此信息用作提示,以对数据源路径字段进行一些补全。 |
enabled |
boolean |
如果VisualElement在本地启用。如果 VisualElement 的父级之一隐式禁用,则 不会更改此标志。要验证这一点,请使用 enabledInHierarchy. |
language-direction |
UIElements.LanguageDirection |
指示元素文本的方向性。该值将传播到元素的子项。 设置 languageDirection自RTL只能获得文本反转等基本的 RTL 支持。要获得更全面的 RTL 支持,例如换行、自动换行或文本整形,您必须启用高级文本生成器。 |
name |
string |
此 VisualElement 的名称。 使用此属性可以编写面向特定元素的 USS 选择器。标准做法是为元素指定一个唯一的名称。 |
picking-mode |
UIElements.PickingMode |
确定此元素是可以作为指针事件的目标还是由IPanel.Pick查询。如果出现以下情况,则无法拾取元素: - 它们不可见- 它们的 style.display设置为DisplayStyle.None拾取模式为 PickingMode.Ignore永远不要接收悬停伪状态。 |
style |
string |
在VisualElement.返回 的样式数据是根据 USS 文件或在 C# 中写入此对象的内联样式计算得出的,不表示完全解析的样式,例如 VisualElement 的最终高度和宽度。要访问这些完全解析的样式,请使用 resolvedStyle.有关如何使用此属性和所有受支持的 USS 属性的信息,请参阅在 C# 脚本中应用样式和 USS 属性参考手册页。 |
tooltip |
string |
用户将鼠标悬停在元素上一小段时间后,要在信息框内显示的文本。这仅在编辑器UI中受支持。 |
usage-hints |
UIElements.UsageHints |
提示值的组合,用于指定VisualElement.只有当VisualElement还不是Panel.曾经是Panel,则此属性实际上变为只读,尝试更改它将引发异常。适当的规范UsageHints驱动系统根据预期的使用模式就如何处理或加速某些作做出更好的决策。请注意,这些提示不会影响行为或视觉结果,而只会影响面板和其中元素的整体性能。建议始终考虑指定适当的UsageHints,但请记住,某些UsageHints在某些情况下(例如,由于目标平台上的硬件限制),可能会在内部忽略。 |
view-data-key |
string |
用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。 此键用于从视图数据存储中保存和加载视图数据。如果未设置此键,则会禁用关联的持久性 VisualElement.有关更多信息,请参阅 Unity 手册中的查看数据持久性。 |
下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。
| C# 属性 | USS 选择器 | 描述 |
|---|---|---|
ussClassName |
.unity-toggle |
切换元素的 USS 类名称。 Unity 将此 USS 类添加到 Toggle 元素的每个实例中。应用于此类的任何样式都会影响位于可视化树中样式表旁边或下方的每个 Toggle。 |
labelUssClassName |
.unity-toggle__label |
切换元素中标签的 USS 类名称。 Unity 将此 USS 级添加到 Label子元素Toggle如果切换具有标签。 |
inputUssClassName |
.unity-toggle__input |
切换元素中输入元素的 USS 类名称。 Unity 将此 USS 类添加到 Toggle.输入子元素提供对纵器的响应。 |
noTextVariantUssClassName |
.unity-toggle--no-text |
没有文本的 Toggle 元素的 USS 类名称。 Unity 将此 USS 级添加到 Toggle如果切换没有标签。 |
checkmarkUssClassName |
.unity-toggle__checkmark |
切换元素中图像的 USS 类名称。 Unity 将此 USS 类添加到 Toggle包含复选标记图像。 |
textUssClassName |
.unity-toggle__text |
切换元素中文本元素的 USS 类名称。 Unity 将此 USS 类添加到 Toggle. |
mixedValuesUssClassName |
.unity-toggle__mixed-values |
USS 类名称 切换具有混合值 的元素 Unity 将此 USS 类添加到 Toggle当它具有混合值时。 |
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 级名称。 |
您还可以使用 Inspector 或 UI Toolkit Debugger 中的 Matching Selectors 部分来查看哪些 USS 选择器会影响VisualElement在其层次结构的各个层面。