Unity - 脚本 API: Placemat

描述

允许在虚拟垫子上对元素进行交互式操作（拖动、隐藏）。

属性

折叠	放置垫是否折叠（true）或展开（false）。
CollapsedElements	折叠时放置垫隐藏的元素列表。当放置垫展开时，列表为空。
CollapsedSize	折叠时放置垫的大小。
颜色	放置垫的颜色。
ExpandedPosition	表示展开放置垫的矩形，无论当前折叠状态如何。
标题	放置垫的标题。
UncollapsedSize	展开时放置垫的大小。
ZOrder	放置垫在 PlacematContainer 中的 Z 顺序。

构造函数

Placemat

构造函数。

公共方法

SetPosition	设置放置垫位置
StartEditTitle	将焦点设置到放置垫的标题并设置标题以进行编辑。

受保护的方法

BuildContextualMenu	向放置垫上下文菜单添加菜单项。
SetCollapsedElements	设置折叠元素的列表。此方法不应被调用。

静态方法

ComputeElementBounds

计算图形元素列表的边界。

继承的成员

静态属性

disabledUssClassName

本地禁用元素的 USS 类名。

属性

canGrabFocus	如果元素可以聚焦，则返回 true。
delegatesFocus	元素是否应将其焦点委派给其子元素。
focusable	如果元素可以聚焦，则为 true。
focusController	返回此元素的焦点控制器。
tabIndex	用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
capabilities	GraphElement 的功能。
elementTypeColor	MiniMap 视图中使用的颜色。
层	GraphElement 在图形中的层。
selected	如果 GraphElement 当前已选中，则为 true。
showInMiniMap	元素是否显示在小地图中。
标题	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)。
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 尚未成为 Panel 的一部分时设置。一旦成为 Panel 的一部分，此属性便有效地变为只读，并且尝试更改它将引发异常。正确 UsageHints 的规范驱动系统做出更好的决策，即如何根据预期的使用模式处理或加速某些操作。请注意，这些提示不会影响行为或视觉结果，只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的 UsageHints，但请记住，在某些情况下，某些 UsageHints 可能会在内部被忽略（例如，由于目标平台上的硬件限制）。
userData	此属性可用于将应用程序特定的用户数据与此 VisualElement 关联。
viewDataKey	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。
visible	指示此元素是否应进行渲染。
visualTreeAssetSource	存储资产引用，如果生成的元素是从 VisualTreeAsset 克隆的。
worldBound	返回一个矩形，表示在应用世界变换后应用的轴对齐边界框 (AABB)。
worldTransform	返回一个矩阵，该矩阵累积以下操作（按顺序）：-局部缩放-局部旋转-局部平移-布局平移-父世界变换（递归定义-在没有父元素时考虑恒等式）

公共方法

HasBubbleUpHandlers	如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象，则返回 true。
HasTrickleDownHandlers	如果事件传播 TrickleDown 阶段的事件处理程序附加到此对象，则返回 true。
RegisterCallback	向实例添加事件处理程序。如果事件处理程序已针对同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。
RegisterCallbackOnce	向实例添加事件处理程序。如果事件处理程序已针对同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。事件处理程序在其被精确调用一次后自动取消注册。
UnregisterCallback	从实例中删除回调。
Blur	告诉元素释放焦点。
Focus	尝试将焦点赋予此元素。
GetGlobalCenter	获取 GraphElement 的中心点。
GetPosition	获取 GraphElement 位置。
HitTest	查看点是否在 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

Placemat

成功！

提交失败

描述

属性

构造函数

公共方法

受保护的方法

静态方法

继承的成员

静态属性

属性

公共方法

受保护的方法