Experimental: this API is experimental and might be changed or removed in the future.

StackNode

class in UnityEditor.Experimental.UIElements.GraphView

/

继承自:Experimental.UIElements.GraphView.Node


实现接口:IDropTarget, IEventHandler, ISelectable, IStyle, ITransform, IUIElementDataWatch, IVisualElementScheduler

切换到手册

描述

使用此类可自定义 StackNodes 以及管理将 GraphElements 拖动到 StackNodes 上的操作。

变量

contentContainer此 StackNode 的内容容器。
dragEntered指示当前是否正在拖动此堆栈中的项。
dropPreviewTemplate使用此属性可自定义在将 GraphElements 拖动到 StackNode 上时显示的预览。
hasMultipleSelectionSupport如果 StackNode 支持多重选择,则返回 true。
headerContainer使用此属性可自定义此 StackNode 的标头。

构造函数

StackNodeStackNode 构造函数。

公共函数

AddElement将指定的 GraphElement 添加到 StackNode。
CanAcceptDrop指示此 StackNode 是否接受当前的放置事件。
DragEnter当发生拖动离开事件时,将自动调用此方法。
DragExited当发生拖动退出事件时,将自动调用此方法。
DragLeave当发生拖动离开事件时,将自动调用此方法。
DragPerform当发生放置事件时,将自动调用此方法。
DragUpdated当发生拖动更新事件时,将自动调用此方法。
GetInsertionIndex如果将某一项放置在指定的世界位置,则在 StackNode 中检索插入索引。
InsertElement将指定的 GraphElement 插入到此 StackNode 中的指定索引处。
OnStartDragging当堆栈的一个元素即将被拖出时,将自动调用此方法。
RemoveElement从此 StackNode 中删除指定的 GraphElement。

受保护的函数

AcceptsElement检查是否可以将指定的 GraphElement 添加到此 StackNode。
OnSeparatorContextualMenuEvent当上下文菜单即将出现在 StackNode 分隔条上时,将自动调用此方法。
OnStyleResolved当更新样式时,将自动调用此方法。

继承的成员

静态变量

defaultFocusIndex新创建的元素的默认焦点索引。

变量

canGrabFocus如果元素可以获得焦点,则返回 true。
focusController返回此元素的焦点控制器。
focusIndex用于对焦点环中可获得焦点的元素排序的整数。负值表示元素不能获得焦点。
capabilities图形元素的功能。
elementTypeColor用于小地图视图的颜色。
layer图中的元素层。
selected如果当前已选择该元素,则为 true。
title元素的标题。
expanded节点是否已扩展。
extensionContainer用于显示自定义元素的空容器。添加元素后,调用 RefreshExpandedState 以切换该容器的可见性。
inputContainer用于输入端口的输入容器。
mainContainer包含所有其他容器的主容器。
outputContainer用于输出端口的输出容器。
title节点的标题元素。
titleButtonContainer标题栏按钮容器。包含右上角按钮。
titleContainer标题栏容器。
topContainer包含输入和输出容器的整个顶部区域。
childCount 此对象的 contentContainer 中的子元素数
clippingOptions是否应将此元素裁剪为绘制到其边界。
contentContainer 子元素通常添加到此元素中
dataWatch对此元素 DataWatch 接口的访问。
enabledInHierarchy如果 VisualElement 是在它自己的层级视图中启用,则返回 true。
enabledSelf如果 VisualElement 是本地启用,则返回 true。
persistenceKey用于查看数据持久性(即树展开状态、滚动位置、缩放级别)。
schedule检索此 VisualElement 的 IVisualElementScheduler
shadow 访问此元素物理层级视图
style引用此元素的样式对象。
this[int] 访问此元素物理层级视图
tooltip用户将元素悬停一小段时间后显示在信息框内的文本。
userData此属性可用于将特定于应用程序的用户数据与此 VisualElement 关联。

公共函数

HandleEvent处理事件,通常是通过执行与事件关联的回调处理事件。
HasBubbleUpHandlers如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象,则返回 true。
HasTrickleDownHandlers如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象,则返回 true。
RegisterCallback向实例添加事件处理程序。如果已为同一阶段(TrickleDown 或 BubbleUp)注册了事件处理程序,则此方法没有效果。
SendEvent将事件发送到事件处理程序。
UnregisterCallback从此实例删除回调。
Blur通知元素释放焦点。
Focus尝试让此元素获得焦点。
GetGlobalCenter获取元素的中心点。
GetPosition获取元素位置。
HitTest查看点是否在元素之上。
IsAscendable检查元素被选中时是否会被自动带到前面。
IsDroppable元素可以拖放。
IsMovable元素可以移动。
IsResizable元素可以调整大小。
IsSelectable元素可以选择。
IsSelected当前已在特定容器中选择元素。
OnSelected在选择元素时调用。
OnUnselected在取消选择元素时调用。
ResetLayer将元素重置为其原始层。
Select选择元素。
SetPosition设置元素位置。
Unselect取消选择元素。
BuildContextualMenu向节点上下文菜单添加菜单项。
InstantiatePort创建一个特定于此节点的新端口。
RefreshExpandedState将自定义元素添加到 extensionContainer 后,调用此方法以使这些元素变得可见。
RefreshPorts刷新端口布局。
SetPosition设置节点位置。
Add向此元素的 contentContainer 添加一个元素
AddStyleSheetPath将此样式表文件添加到此元素的应用样式列表中
BringToFront将此元素放到其父子列表的末尾。此元素将显示在所有重叠的同级元素前方。
Children从元素的 contentContainer 返回元素
Clear从此元素的 contentContainer 中删除所有子元素
Contains如果元素是此 VisualElement 的直接子级,则返回 true
ElementAt检索相应位置的子元素
EnableInClassList启用或禁用具有给定名称的类。
FindAncestorUserData向上搜索此 VisualElement 的层级视图并检索存储的 userData(如果找到)。
FindCommonAncestor查找 VisualTree 层级视图中两个 VisualElement 之间的最低共同上级
GetEnumerator允许循环访问此元素的子级
GetFirstAncestorOfType从此元素的父级开始向上访问层级视图,返回第一个此类型的 VisualElement
GetFirstOfType从此元素开始向上访问层级视图,返回第一个此类型的 VisualElement
GetFullHierarchicalPersistenceKey将此 VisualElement 与其父级的 VisualElement.persistenceKey 进行组合,从而创建更具唯一性的键以供 VisualElement.GetOrCreatePersistentData 使用。
GetOrCreatePersistentData引用现有的持久化对象和键,返回以保持的状态填充的对象或原样返回对象。
HasStyleSheetPath检查此样式表文件是否位于此元素的应用样式列表中
IndexOf检索指定的 VisualElement 的子索引。
Insert向此元素的 contentContainer 插入一个元素
MarkDirtyRepaint在下一帧触发 VisualElement 的重绘。
OnPersistentDataReady当持久数据可访问和/或当数据或持久键发生更改时调用(VisualElement 有正确的父子关系)。
OverwriteFromPersistedData从持久性数据存储覆盖对象。
PlaceBehind将此元素放在其父子列表中同级元素之前紧邻的位置。如果此元素和同级元素位置重叠,此元素将显示在其同级元素之后。
PlaceInFront将此元素放在其父子列表中同级元素之后紧邻的位置。如果此元素和同级元素位置重叠,此元素将显示在其同级元素之前。
Remove从层级视图中删除此子级
RemoveAt从此元素的 contentContainer 中删除位于此位置的子元素
RemoveFromHierarchy将此元素从其父层级视图中删除
RemoveStyleSheetPath从此元素的应用样式列表中删除此样式表文件
SavePersistentData将持久性数据写入文件。
SendEvent将事件发送到事件处理程序。
SendToBack将此元素发送到其父子列表的开始处。此元素将显示在所有重叠的同级元素之后。
SetEnabled更改是否启用当前 VisualElement。禁用时,VisualElement 不接收大多数事件。
Sort重新排序来自此 VisualElement contentContainer 的子元素。
ToggleInClassList在类列表中添加和删除给定类名之间切换。

受保护的函数

OnPortRemoved删除端口时调用。
ToggleCollapse切换节点的折叠状态。
UseDefaultStyling应用节点的默认样式。必须由使用自身 uxml 文件的 Node 子类显式调用此方法。