Unity - 脚本 API: ObjectField

描述

创建一个用于接收任何对象类型的字段。有关更多信息，请参阅 UXML 元素 ObjectField。

静态属性

inputUssClassName	此类型元素中输入元素的 USS 类名。
labelUssClassName	此类型元素中标签的 USS 类名。
objectUssClassName	此类型元素中对象元素的 USS 类名。
selectorUssClassName	此类型元素中选择器元素的 USS 类名。
ussClassName	此类型元素的 USS 类名。

属性

allowSceneObjects	允许将场景对象分配给该字段。
objectType	可以分配的对象类型。

构造函数

ObjectField

构造函数。

继承的成员

静态属性

alignedFieldUssClassName	在检查器元素中对齐的元素的 USS 类名
inputUssClassName	此类型元素中输入元素的 USS 类名。
labelDraggerVariantUssClassName	此类型元素中标签的 USS 类名，当它们附加有拖动器时。
labelUssClassName	此类型元素中标签的 USS 类名。
mixedValueLabelUssClassName	显示混合值的元素的 USS 类名
noLabelVariantUssClassName	此类型元素的 USS 类名，当没有标签时。
ussClassName	此类型元素的 USS 类名。
disabledUssClassName	本地禁用元素的 USS 类名。

属性

label	表示将出现在字段旁边的标签的字符串。
labelElement	这是出现在字段输入旁边的 Label 对象。
mixedValueLabel	用于提供编辑多个不同值的显示的只读标签。
rawValue	元素的值。
showMixedValue	设置为 true 时，将为该字段提供编辑多个不同值的显示。
value	与该字段关联的值。
binding	将要更新的绑定对象。
bindingPath	要绑定的目标属性的路径。
canGrabFocus	如果该元素可以获得焦点，则返回 true。
delegatesFocus	该元素是否应将其焦点委托给其子元素。
focusable	如果该元素可以获得焦点，则为 true。
focusController	返回该元素的焦点控制器。
tabIndex	用于在焦点环中对可获得焦点的元素进行排序的整数。必须大于或等于零。
childCount	此对象 contentContainer 中的子元素数量。
contentContainer	子元素将添加到其中，通常与元素本身相同。
contentRect	元素的内容区域的矩形，在元素的本地空间中。 (只读)
customStyle	VisualElement 的自定义样式属性访问器 (只读)。
dataSource	为该 VisualElement 分配数据源，该数据源将覆盖任何继承的数据源。所有子元素都将继承此数据源。
dataSourcePath	从数据源到值的路径。
dataSourceType	可以分配给该 VisualElement 的数据源的可能类型。此信息仅供 UI Builder 使用，作为提示，以便在设计时无法指定有效数据源时，为数据源路径字段提供一些完成。
disablePlayModeTint	默认情况下应用播放模式色调，除非将其设置为 true。它将按层次结构应用于该 VisualElement 及其在编辑器面板上存在的子元素。
enabledInHierarchy	如果 VisualElement 在其自己的层次结构中处于启用状态，则返回 true。
enabledSelf	如果 VisualElement 在本地处于启用状态，则返回 true。
experimental	返回 UIElements 实验接口。
generateVisualContent	生成视觉元素的视觉内容的委托函数。
hierarchy	访问该元素的物理层次结构
languageDirection	指示元素文本的方向。该值将传播到元素的子元素。
layout	VisualElement 相对于其父元素的位置和大小，由布局系统计算得出。 (只读)
localBound	返回一个矩形，表示应用变换后但应用布局平移之前，轴对齐包围盒 (AABB)。
name	该 VisualElement 的名称。
paddingRect	元素的填充区域的矩形，在元素的本地空间中。
panel	附加该 VisualElement 的面板。
parent	该 VisualElement 的父元素。
pickingMode	确定该元素是否可以在鼠标事件或 IPanel.Pick 查询期间被选取。
resolvedStyle	视觉元素的最终渲染样式值，如当前帧中渲染的样式值。 (只读)
scaledPixelsPerPoint	返回面板的缩放结果，该缩放结果考虑了屏幕 DPI 和可自定义的缩放系数，但不考虑元素及其祖先的变换比例。请参阅 Panel.scaledPixelsPerPoint。这仅应在属于面板一部分的元素上调用。
schedule	检索该 VisualElement 的 IVisualElementScheduler
style	在 VisualElement 上设置样式值。
styleSheets	返回一个 VisualElementStyleSheetSet，该集合用于操作附加到该元素的样式表。
this[int]	检索特定索引处的子元素。
tooltip	在用户将鼠标悬停在元素上一段时间后，在信息框中显示的文本。这仅在编辑器 UI 中受支持。
transform	返回该 VisualElement 的变换对象。ITransform
usageHints	指定 VisualElement 的高级预期使用模式的提示值组合。此属性只能在 VisualElement 尚未成为面板的一部分时设置。一旦成为面板的一部分，此属性实际上就变为只读，尝试更改它将引发异常。指定正确的 UsageHints 会驱动系统根据预期的使用模式，在如何处理或加速某些操作方面做出更好的决策。请注意，这些提示不会影响行为或视觉结果，而只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的 UsageHints，但请记住，某些 UsageHints 可能会在特定条件下被内部忽略（例如，由于目标平台上的硬件限制）。
userData	此属性可用于将应用程序特定的用户数据与该 VisualElement 关联。
viewDataKey	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。
visible	指示该元素是否应渲染。
visualTreeAssetSource	如果生成的元素是从 VisualTreeAsset 克隆的，则存储资产引用。
worldBound	返回一个矩形，表示应用世界变换后，轴对齐包围盒 (AABB)。
worldTransform	返回一个矩阵，该矩阵累积了以下操作（按顺序）：-本地缩放 -本地旋转 -本地平移 -布局平移 -父世界变换 (递归定义 - 如果没有父元素，则考虑单位矩阵)

公共方法

SetValueWithoutNotify	允许设置值，而无需在存在任何更改时收到通知。
HasBubbleUpHandlers	如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象，则返回 true。
HasTrickleDownHandlers	如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象，则返回 true。
RegisterCallback	将事件处理程序添加到实例中。如果事件处理程序已针对相同阶段（TrickleDown 或 BubbleUp）注册，则此方法将不起作用。
RegisterCallbackOnce	将事件处理程序添加到实例中。如果事件处理程序已针对相同阶段（TrickleDown 或 BubbleUp）注册，则此方法将不起作用。事件处理程序将在恰好调用一次后自动取消注册。
UnregisterCallback	从实例中删除回调。
Blur	告诉元素释放焦点。
Focus	尝试将焦点赋予该元素。
Add	将元素添加到该元素的 contentContainer 中
AddToClassList	将类添加到元素的类列表中，以便从 USS 分配样式。请注意，类名区分大小写。
BringToFront	将该元素移到其父元素的子元素列表的末尾。该元素将在视觉上位于任何重叠的同级元素的前面。
Children	返回其 contentContainer 中的元素。
ClassListContains	在该元素的类列表中搜索类。
Clear	从该元素的 contentContainer 中删除所有子元素
ClearBinding	从元素中删除绑定。
ClearBindings	从元素中删除所有绑定。
ClearClassList	从该元素的类列表中删除所有类。AddToClassList
Contains	检查该元素是否是指定子元素的祖先。
ContainsPoint	检查指定点是否与该 VisualElement 的布局相交。
ElementAt	检索特定索引处的子元素。
EnableInClassList	启用或禁用具有给定名称的类。
FindAncestorUserData	向上搜索该 VisualElement 的层次结构，并检索存储的 userData（如果找到）。
FindCommonAncestor	在 VisualTree 层次结构中找到两个 VisualElement 之间的最低共同祖先。
GetBinding	获取提供的目标属性的绑定实例。
GetBindingInfos	获取有关当前元素所有绑定的信息。
GetClasses	检索该元素的类。
GetDataSourceContext	查询绑定对象的 dataSource 和 dataSourcePath。
GetFirstAncestorOfType	从该元素的父元素开始，向上遍历层次结构，并返回该类型的第一个 VisualElement
GetFirstOfType	从该元素开始，向上遍历层次结构，并返回该类型的第一个 VisualElement
GetHierarchicalDataSourceContext	查询从层次结构继承的 dataSource 和 dataSourcePath。
HasBinding	允许了解目标属性是否与之关联绑定。
IndexOf	检索指定 VisualElement 的子索引。
Insert	将元素插入到该元素的 contentContainer 中
MarkDirtyRepaint	在下一帧触发 VisualElement 的重绘。当发生需要重绘的更改时，该方法将在内部调用，例如当 UIElements.BaseField_1.value 发生更改或 Label 中的文本发生更改时。如果您正在实现自定义控件，则可以在发生需要重绘的更改时调用此方法以触发重绘，例如，当使用 generateVisualContent 渲染网格且网格数据现已更改时。
PlaceBehind	将此元素放置在其父级子元素列表中同级元素的正前方。如果元素和同级元素的位置重叠，则该元素将在视觉上位于其同级元素的后面。
PlaceInFront	将此元素放置在其父级子元素列表中同级元素的正后方。如果元素和同级元素的位置重叠，则该元素将在视觉上位于其同级元素的前面。
Remove	从 contentContainer 层次结构中删除此子元素。
RemoveAt	从此元素的 contentContainer 中删除位于此位置的子元素。
RemoveFromClassList	从元素的类列表中删除一个类。
RemoveFromHierarchy	从其父级层次结构中删除此元素。
SendEvent	将事件发送到事件处理程序。
SendToBack	将此元素发送到其父级子元素列表的开头。该元素将在视觉上位于任何重叠的同级元素的后面。
SetBinding	在目标和源之间分配绑定。
SetEnabled	更改 VisualElement 的启用状态。禁用的 VisualElement 不会接收大多数事件。
Sort	重新排序此 VisualElement contentContainer 中的子元素。
ToggleInClassList	在将给定类名添加到类列表和从类列表中删除给定类名之间切换。
TryGetBinding	获取提供的目标属性的绑定实例。
TryGetDataSourceContext	查询绑定对象的 dataSource 和 dataSourcePath。
TryGetLastBindingToSourceResult	返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
TryGetLastBindingToUIResult	返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护方法

UpdateMixedValueContent	根据 showMixedValue 更新字段的视觉内容。
HandleEventBubbleUp	在 BubbleUp 阶段立即在该元素上执行逻辑，在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
HandleEventTrickleDown	在 TrickleDown 阶段立即在该元素上执行逻辑，在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
NotifyPropertyChanged	通知数据绑定系统控件的属性已更改。

脚本 API

ObjectField

成功！

提交失败

描述

静态属性

属性

构造函数

继承的成员

静态属性

属性

公共方法

受保护方法