UXML 元素 Toggle

Toggle 包含一个图像和一个标签。就像其他标准的UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。 更多信息
参见 术语表 工具包控件（如 Button）一样，Toggle 附带了一个 Clickable 操作器，该操作器注册到 MouseUpEvent 和 PointerUpEvent。当其中一个事件触发操作器时，Toggle 的值将从 true 更改为 false 或从 false 更改为 true。您可以读取或设置 Toggle 的当前值。您还可以将 Toggle 绑定到 Boolean 变量。

您可以根据其他条件（例如下拉列表中的选择或启用的选项）显示或隐藏元素。条件 UI 的一个示例是 Unity Camera一个组件，用于创建场景中特定视点的图像。输出要么绘制到屏幕上，要么作为纹理捕获。 更多信息
参见 术语表 Inspector一个 Unity 窗口，显示有关当前选定的 GameObject、资产或项目设置的信息，允许您检查和编辑值。 更多信息
参见 术语表。当您激活“物理相机”模式时，它会显示其他选项。

注意：要将元素与 Inspector 窗口中的其他字段对齐，只需将 .unity-base-field__aligned USS 类应用于它。有关更多信息，请参阅 BaseField。

创建 Toggle

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

以下 C# 示例创建了一个带有特定标签的 Toggle

Toggle myToggle = new Toggle("Click me");

设置 Toggle 的样式

默认情况下，Toggle 控件显示为复选框。您可以应用样式使其看起来像一个典型的切换开关。

要设置切换复选框的样式，请使用 .unity-toggle__input 和 .unity-toggle__checkmark 样式属性。例如，如果您已将名为 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 示例创建了一个 Toggle

<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 中实时尝试此示例，请转到 窗口 > UI 工具包 > 示例。

有关更多示例，请参阅以下内容

• 创建条件 UI.

C# 基类和命名空间

C# 类：Toggle
命名空间：UnityEngine.UIElements
基类：BaseBoolField

继承的 UXML 属性

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

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

USS 类

下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。

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

其他资源

• 折叠
• 伪类