版本: Unity 6 (6000.0)
语言英语
  • C#

Box

UnityEngine.UIElements 类

/

继承自:UIElements.VisualElement

/

实现于:UnityEngine.UIElementsModule

建议修改

成功!

感谢您帮助我们提高 Unity 文档的质量。虽然我们无法接受所有提交内容,但我们会阅读用户提出的每一个修改建议,并在适当的情况下进行更新。

关闭

提交失败

由于某种原因,您的修改建议无法提交。请 <a>稍后再试</a>。感谢您抽出时间帮助我们提高 Unity 文档的质量。

关闭

取消

描述

样式化的可视元素,与 IMGUI Box 样式匹配。有关更多信息,请参阅 UXML 元素 Box

静态属性

ussClassName此类型元素的 USS 类名称。

构造函数

Box初始化并返回 Box 的实例。

继承的成员

静态属性

disabledUssClassName本地禁用元素的 USS 类名称。

属性

canGrabFocus如果元素可以获得焦点,则返回 true。
delegatesFocus元素是否应将其焦点委托给其子元素。
focusable如果元素可以获得焦点,则为 true。
focusController返回此元素的焦点控制器。
tabIndex用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
childCount此对象 contentContainer 中的子元素数量。
contentContainer子元素将被添加到其中,通常与元素本身相同。
contentRect元素内容区域的矩形,在元素的本地空间中。(只读)
customStyleVisualElement 的自定义样式属性访问器。(只读)
dataSource为该 VisualElement 分配数据源,它将覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath从数据源到值的路径。
dataSourceType可分配给此 VisualElement 的数据源的可能类型。此信息仅供 UI Builder 使用,作为提示,以便在设计时无法指定有效数据源时,为数据源路径字段提供一些自动完成。
disablePlayModeTint除非将其设置为 true,否则默认情况下会应用播放模式色调。它会分层地应用于该 VisualElement 以及存在于编辑器面板上的所有子元素。
enabledInHierarchy如果 VisualElement 在其自身层次结构中启用,则返回 true。
enabledSelf如果 VisualElement 在本地启用,则返回 true。
experimental返回 UIElements 实验接口。
generateVisualContent委托函数,用于生成可视元素的可视内容。
hierarchy访问此元素的物理层次结构
languageDirection指示元素文本的方向性。该值将传播到元素的子元素。
layoutVisualElement 相对于其父元素的位置和大小,由布局系统计算。(只读)
localBound返回一个 Rect,表示应用变换后但应用布局平移之前的轴对齐包围盒 (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返回一个 Rect,表示应用世界变换后的轴对齐包围盒 (AABB)。
worldTransform返回一个矩阵,它累积了以下操作(按顺序):-本地缩放-本地旋转-本地平移-布局平移-父世界变换(递归定义 - 如果没有父元素,则考虑为恒等式)

公共方法

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 层次结构中找到两个 VisualElements 之间的最低共同祖先。
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。

受保护方法

HandleEventBubbleUp在 BubbleUp 阶段执行此元素的逻辑,紧接在该元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
HandleEventTrickleDown在 TrickleDown 阶段执行此元素的逻辑,紧接在该元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
NotifyPropertyChanged通知数据绑定系统控件的某个属性已更改。