版本:Unity 6 (6000.0)
语言:英语
UXML 元素 Button
UXML 元素 CurveField

UXML 元素 ColorField

ColorField 是一个 仅限编辑器 控件,允许用户从颜色选择器中选择颜色。它支持 alpha 通道和 HDR 颜色。alpha 通道是代表颜色的透明度级别的额外通道。 HDR高动态范围
参见 术语表
颜色是高动态范围颜色,可以代表比标准颜色更广泛的颜色范围。

A ColorField control example
ColorField 控件示例

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

创建 ColorField

您可以使用 UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。 更多信息
参见 术语表
构建器、UXML 或 C# 创建 ColorField。以下 C# 示例创建一个具有默认颜色的 ColorField,并启用 alpha 通道、吸管,并将颜色视为 HDR 值。

using UnityEditor.UIElements;
...
var colorField = new ColorField();
colorField.value = new Color(0.5f, 0.5f, 0.5f, 1.0f);
colorField.showAlpha = true;
colorField.showEyeDropper = true;
colorField.hdr = true;

示例

以下 UXML 示例创建一个 ColorField

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

以下 C# 示例说明了 ColorField 的一些可定制功能

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

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

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

C# 基类和命名空间

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

成员 UXML 属性

此元素具有以下成员属性

名称 类型 描述
hdr 布尔值 如果为真,则将颜色视为 HDR 值。如果为假,则将颜色视为标准 LDR 值。
show-alpha 布尔值 如果为真,则允许用户为颜色设置 alpha 值。如果为假,则隐藏 alpha 分量。
show-eye-dropper 布尔值 如果为真,则颜色选择器将显示吸管控件。如果为假,则颜色选择器不会显示吸管控件。

继承的 UXML 属性

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

名称 类型 描述
binding-path 字符串 要绑定的目标属性的路径。
focusable 布尔值 如果元素可以获得焦点,则为真。
label 字符串 代表将出现在字段旁边的标签的字符串。
tabindex 整数 用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
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 确定此元素是否可以在鼠标事件或 IPanel.Pick 查询期间被选中。
style 字符串 设置 VisualElement 样式值。
tooltip 字符串 在用户将鼠标悬停在元素上一段时间后,在信息框内显示的文本。这仅在编辑器 UI 中受支持。
usage-hints UIElements.UsageHints 提示值的组合,指定 VisualElement 的高级预期使用模式。此属性只能在 VisualElement 尚未成为 Panel 的一部分时设置。一旦成为 Panel 的一部分,此属性实际上就成为只读的,尝试更改它将引发异常。正确 UsageHints 的规范推动系统根据预期的使用模式做出更好的决策,以处理或加速某些操作。请注意,这些提示不会影响行为或视觉结果,只会影响面板和其中元素的整体性能。建议始终考虑指定正确的 UsageHints,但请记住,某些 UsageHints 在某些情况下可能会在内部被忽略(例如,由于目标平台上的硬件限制)。
view-data-key 字符串 用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。

此键用于从视图数据存储中保存和加载视图数据。如果未设置此键,则与关联的 VisualElement 相关的持久性将被禁用。有关更多信息,请参阅 视图数据持久性.

USS 类

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

C# 属性 USS 选择器 描述
ussClassName .unity-color-field 此类型元素的 USS 类名。
labelUssClassName .unity-color-field__label 此类型元素中标签的 USS 类名。
inputUssClassName .unity-color-field__input 此类型元素中输入元素的 USS 类名。
colorContainerUssClassName .unity-color-field__color-container 此类型元素中颜色容器元素的 USS 类名。
colorUssClassName .unity-color-field__color 此类型元素中颜色元素的 USS 类名。
mixedValueColorUssClassName .unity-color-field__color--mixed-value 显示混合值时,此类型元素中颜色元素的 USS 类名。
eyeDropperUssClassName .unity-color-field__eyedropper 此类型元素中吸管元素的 USS 类名。
hdrLabelUssClassName .unity-color-field__hdr 此类型元素中 hdr 标签元素的 USS 类名。
gradientContainerUssClassName .unity-color-field__gradient-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 在检查器元素中对齐的元素的 USS 类名
disabledUssClassName .unity-disabled 本地禁用元素的 USS 类名。

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

其他资源

UXML 元素 Button
UXML 元素 CurveField