版本: Unity 6 (6000.0)
语言 : 英语
UXML 元素 LayerField
UXML 元素 LongField

UXML 元素 LayerMaskField

LayerMaskField 允许用户从可用 图层Unity 中的图层可用于选择性地将游戏对象的组包含或排除在某些过程或计算中。 这包括相机渲染、灯光、物理碰撞或您自己代码中的自定义计算。 更多信息
查看 词汇表
中选择一个或多个图层。

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

创建 LayerMaskField

您可以使用 UI(用户界面) 允许用户与您的应用程序交互。 Unity 目前支持三种 UI 系统。 更多信息
查看 词汇表
生成器、UXML 和 C# 创建 LayerMaskField。 以下 C# 示例使用默认值创建 LayerMaskField

LayerMaskField myElement = new LayerMaskField("Label text");
// Sets the default value to 0.
myElement.value = 0;

示例

以下 UXML 示例创建一个 LayerMaskField

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

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

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

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

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

C# 基类和命名空间

C# 类: LayerMaskField
命名空间: UnityEditor.UIElements
基类: MaskField

继承的 UXML 属性

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

名称 类型 描述
binding-path 字符串 要绑定的目标属性的路径。
choices IList 要显示在弹出菜单中的选项列表。
focusable 布尔值 如果元素可以获得焦点,则为真。
label 字符串 表示将显示在字段旁边的标签的字符串。
tabindex 整数 用于在焦点环中对可聚焦元素进行排序的整数。 必须大于或等于零。
value LayerMask 与字段关联的值。

此元素还从 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-layer-mask-field 此类型元素的 USS 类名。
labelUssClassName .unity-layer-mask-field__label 此类型元素中标签的 USS 类名。
inputUssClassName .unity-layer-mask-field__input 此类型元素中输入元素的 USS 类名。
ussClassName .unity-mask-field 此类型元素的 USS 类名。
labelUssClassName .unity-mask-field__label 此类型元素中标签的 USS 类名。
inputUssClassName .unity-mask-field__input 此类型元素中输入元素的 USS 类名。
ussClassName .unity-base-popup-field 此类型元素的 USS 类名。
textUssClassName .unity-base-popup-field__text 此类型元素中文本元素的 USS 类名。
arrowUssClassName .unity-base-popup-field__arrow 此类型元素中箭头指示器的 USS 类名。
labelUssClassName .unity-base-popup-field__label 此类型元素中标签的 USS 类名。
inputUssClassName .unity-base-popup-field__input 此类型元素中输入元素的 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 元素 LayerField
UXML 元素 LongField