UnityEngine.UIElements 中的类
/
继承自:UIElements.BindableElement
/
实现于:UnityEngine.UIElementsModule
表示 UXML 文件的根VisualElement。
Unity 创建 TemplateContainer 实例来表示 UXML 文件的根，并充当文件中所有元素的父级。用户通常不会直接创建 TemplateContainer 对象。当使用VisualTreeAsset.Instantiate时，会返回一个 TemplateContainer 实例以表示层次结构的根。当使用 UXML 模板时，会为模板实例生成一个 TemplateContainer，并将其插入父 UXML 文件的层次结构中。
| templateId | 父 UXML 文件中模板的本地 ID（只读）。 |
| templateSource | 如果生成的元素是从 VisualTreeAsset 克隆的，作为另一个 VisualTreeAsset 内部的模板声明，则存储模板资产引用。 |
| disabledUssClassName | 本地禁用元素的 USS 类名称。 |
| 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) 的 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 尚未成为 Panel 的一部分时设置。一旦成为 Panel 的一部分，此属性便有效地变为只读，并且尝试更改它将引发异常。正确 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 | 尝试将焦点赋予此元素。 |
| 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 | 从 contentContainerhierarchy 中删除此子元素。 |
| 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 | 在冒泡阶段在此元素上执行逻辑，紧接在此元素的冒泡回调之前。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。 |
| HandleEventTrickleDown | 在 TrickleDown 阶段在此元素上执行逻辑，紧接在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。 |
| NotifyPropertyChanged | 通知数据绑定系统控件的某个属性已更改。 |