Unity - 脚本 API: Scope

描述

此类允许将节点分组到一个公共区域或范围中。此类包含自动调整范围大小并将其定位以包含节点组的方法。

属性

autoUpdateGeometry	启用或禁用范围的自动调整大小和定位。
containedElements	范围包含的 GraphElement 列表。
containedElementsRect	包含范围所包含的 GraphElement 的矩形。矩形以局部坐标表示。
headerContainer	返回范围的标题容器。使用此标题容器自定义范围的标题。

构造函数

范围	Scope 构造函数。

公共方法

AcceptsElement	GraphElement 是否可以添加到此范围。
AddElement	将 GraphElement 添加到范围。
AddElements	将 GraphElement 添加到范围。
ContainsElement	确定范围是否包含指定的 GraphElement。
GetPosition	返回范围的几何形状。
HitTest	确定指定点是否在范围的可选择区域内。
Overlaps	确定指定的矩形是否与范围重叠。
RemoveElement	从范围中移除元素。
RemoveElements	从范围中移除元素。
RemoveElementsWithoutNotification	从范围中移除元素，但不发送通知。
SetPosition	设置范围的几何形状。
UpdateGeometryFromContent	根据其内容更新范围的大小和位置。

受保护的方法

OnElementsAdded	当 GraphElement 添加到范围时调用。
OnElementsRemoved	当 GraphElement 从范围中移除时调用。
ScheduleUpdateGeometryFromContent	根据其内容计划更新范围的大小和位置。
SetScopePositionOnly	更改范围的位置，但不移动其元素。

继承的成员

静态属性

disabledUssClassName

本地禁用元素的 USS 类名。

属性

canGrabFocus	如果元素可以聚焦，则返回 true。
delegatesFocus	元素是否应将其焦点委托给其子元素。
focusable	如果元素可以聚焦，则为 true。
focusController	返回此元素的焦点控制器。
tabIndex	用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
capabilities	GraphElement 的功能。
elementTypeColor	MiniMap 视图中使用的颜色。
layer	GraphElement 在图形中的图层。
selected	如果 GraphElement 当前已选择，则为 true。
showInMiniMap	元素是否显示在小地图中。
title	GraphElement 的标题。
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) 的 Rect，在应用变换后但应用布局平移之前。
name	此 VisualElement 的名称。
paddingRect	元素填充区域的矩形，位于元素的本地空间中。
panel	此 VisualElement 附加到的面板。
parent	此 VisualElement 的父元素。
pickingMode	确定此元素是否可以在 mouseEvents 或 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) 的 Rect。
worldTransform	返回一个矩阵，该矩阵累积以下操作（按顺序）：-本地缩放-本地旋转-本地平移-布局平移-父世界变换（递归定义-在没有父元素时考虑单位矩阵）

公共方法

HasBubbleUpHandlers	如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象，则返回 true。
HasTrickleDownHandlers	如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象，则返回 true。
RegisterCallback	向实例添加事件处理程序。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。
RegisterCallbackOnce	向实例添加事件处理程序。如果事件处理程序已为同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。事件处理程序在恰好调用一次后会自动取消注册。
UnregisterCallback	从实例中移除回调。
Blur	告诉元素释放焦点。
Focus	尝试将焦点赋予此元素。
GetGlobalCenter	获取 GraphElement 的中心点。
IsAscendable	检查 GraphElement 是否在选择时自动置于最前面。
IsCopiable	检查 GraphElement 是否可复制。
IsDroppable	GraphElement 是可拖放的。
IsGroupable	检查 GraphElement 是否可分组。
IsMovable	GraphElement 是可移动的。
IsRenamable	GraphElement 是可重命名的。
IsResizable	GraphElement 是可调整大小的。
IsSelectable	GraphElement 是可选的。
IsSelected	GraphElement 当前在特定容器中是否已选择。
IsSnappable	检查 GraphElement 是否可捕捉。
IsStackable	检查 GraphElement 是否可堆叠。
OnSelected	当 GraphElement 被选中时调用。
OnUnselected	当 GraphElement 被取消选中时调用。
ResetLayer	将 GraphElement 重置到其原始图层。
Select	选择 GraphElement。
Unselect	取消选择 GraphElement。
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。

受保护的方法

HandleEventBubbleUp	在此元素的 BubbleUp 回调之前，立即在 BubbleUp 阶段对此元素执行逻辑。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。
HandleEventTrickleDown	在此元素的 TrickleDown 回调之后，立即在 TrickleDown 阶段对此元素执行逻辑。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。
NotifyPropertyChanged	通知数据绑定系统控件的属性已更改。
OnCustomStyleResolved	解析自定义样式属性时调用。

脚本 API

范围

成功！

提交失败

描述

属性

构造函数

公共方法

受保护的方法

继承的成员

静态属性

属性

公共方法

受保护的方法