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

ProgressBar

UnityEngine.UIElements 中的类

/

继承自:UIElements.AbstractProgressBar

/

在以下位置实现:UnityEngine.UIElementsModule

建议修改

成功!

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

关闭

提交失败

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

关闭

取消

描述

显示下限和上限值之间进度的控件。有关更多信息,请参阅UXML 元素 ProgressBar

 public ProgressBar CreateProgressBar()
 {
     var progressBar = new ProgressBar
     {
         title = "Progress",
         lowValue = 0f,
         highValue = 100f,
         value = 0f
     };

progressBar.schedule.Execute(() => { progressBar.value += 2f; }).Every(75).Until(() => progressBar.value >= 100f);

return progressBar; }

继承的成员

静态属性

backgroundUssClassName用于设置 ProgressBar 背景样式的 USS 类名称。
containerUssClassName用于设置 ProgressBar 容器样式的 USS 类名称。
progressUssClassName用于设置 ProgressBar 进度条样式的 USS 类名称。
titleContainerUssClassName用于设置 ProgressBar 标题容器样式的 USS 类名称。
titleUssClassName用于设置 ProgressBar 标题样式的 USS 类名称。
ussClassName用于设置 ProgressBar 样式的 USS 类名称。
disabledUssClassName本地禁用元素的 USS 类名称。

属性

highValue设置 ProgressBar 的最大值。
lowValue设置 ProgressBar 的最小值。
title设置 ProgressBar 的标题,该标题显示在控件的中心。
value设置进度值。如果值已更改,则会调度类型为 float 的 ChangeEvent_1。
binding将要更新的绑定对象。
bindingPath要绑定的目标属性的路径。
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返回一个矩阵,该矩阵累积了以下操作(按顺序):-本地缩放 -本地旋转 -本地平移 -布局平移 -父级 worldTransform(递归定义 - 在没有父级时考虑标识)

公共方法

SetValueWithoutNotify设置进度值。
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从 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通知数据绑定系统控件的属性已更改。