版本:Unity 6 (6000.0)
语言:English
UXML 元素 Foldout
UXML 元素 GroupBox

UXML 元素 GradientField

GradientField 是一个仅限编辑器控件,允许用户从渐变编辑器中设置颜色渐变

A GradientField control example
GradientField 控件示例

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

创建 GradientField

您可以使用 UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。 更多信息
参见 词汇表
构建器、UXML 或 C# 创建 GradientField。以下 C# 示例创建了一个具有默认值的 GradientField

var gradient = new GradientField();
gradient.value = new Gradient();
gradient.value.colorKeys = new GradientColorKey[]
{
    new GradientColorKey(Color.red, 0),
    new GradientColorKey(Color.blue, 10),
    new GradientColorKey(Color.green, 20)
};

示例

以下 UXML 示例创建了一个 GradientField

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

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

/// <sample>
var initialValue = new Gradient();
initialValue.colorKeys = new GradientColorKey[]
{
    new GradientColorKey(Color.red, 0),
    new GradientColorKey(Color.blue, 10),
    new GradientColorKey(Color.green, 20)
};

// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<GradientField>("the-uxml-field");
uxmlField.value = initialValue;

// Create a new field, disable it, and give it a style class.
var csharpField = new GradientField("C# Field");
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<Gradient>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

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

C# 基类和命名空间

C# 类GradientField
命名空间UnityEditor.UIElements
基类BaseField_1

成员 UXML 属性

此元素具有以下成员属性

名称 类型 描述
value Gradient 字段当前公开的 Gradient

注意:更改此项不会触发发送更改事件。

继承的 UXML 属性

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

名称 类型 描述
binding-path string 要绑定的目标属性的路径。
focusable boolean 如果元素可以获得焦点,则为 True。
label string 表示将显示在字段旁边的标签的字符串。
tabindex int 用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
value Gradient 与字段关联的值。

此元素还从 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 确定在 mouseEvents 或 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-gradient-field 此类型元素的 USS 类名称。
labelUssClassName .unity-gradient-field__label 此类型元素中标签的 USS 类名称。
inputUssClassName .unity-gradient-field__input 此类型元素中输入元素的 USS 类名称。
contentUssClassName .unity-gradient-field__content GradientField 元素中渐变视觉内容的 USS 类名称。
backgroundUssClassName .unity-gradient-field__background GradientField 元素中渐变视觉背景的 USS 类名称。
borderUssClassName .unity-gradient-field__border 此类型元素中边框元素的 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 元素 Foldout
UXML 元素 GroupBox