Class Progress

A base class for all progress UI elements. This class is not meant to be used directly.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BaseVisualElement
Progress
CircularProgress
LinearProgress
Implements
Inherited Members
VisualElement.ExecuteDefaultAction(EventBase)
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
public abstract class Progress : BaseVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, IAdditionalDataHolder, ISizeableElement

Constructors

Progress()

Default constructor.

Declaration
protected Progress()

Fields

containerUssClassName

The Progress container styling class.

Declaration
public const string containerUssClassName = "appui-progress__container"
Field Value
Type Description
string

imageUssClassName

The Progress image styling class.

Declaration
public const string imageUssClassName = "appui-progress__image"
Field Value
Type Description
string

m_ColorFromStyle

The main color of the progress.

Declaration
protected Color m_ColorFromStyle
Field Value
Type Description
Color

m_Image

The image that contains the rendered texture of the progress.

Declaration
protected readonly Image m_Image
Field Value
Type Description
Image

m_RT

The rendered texture of the progress.

Declaration
protected RenderTexture m_RT
Field Value
Type Description
RenderTexture

roundedProgressCornersUssClassName

The Progress rounded corners styling class.

Declaration
public const string roundedProgressCornersUssClassName = "appui-progress--rounded-corners"
Field Value
Type Description
string

sizeUssClassName

The Progress size styling class.

Declaration
public const string sizeUssClassName = "appui-progress--size-"
Field Value
Type Description
string

ussClassName

The Progress main styling class.

Declaration
public const string ussClassName = "appui-progress"
Field Value
Type Description
string

variantUssClassName

The Progress variant styling class.

Declaration
public const string variantUssClassName = "appui-progress--"
Field Value
Type Description
string

Properties

bufferOpacity

The opacity of the secondary progress (buffer).

Declaration
public float bufferOpacity { get; set; }
Property Value
Type Description
float

bufferValue

The secondary progress (buffer) value (normalized).

Declaration
public float bufferValue { get; set; }
Property Value
Type Description
float

colorOverride

The color of the progress.

Declaration
public Color colorOverride { get; set; }
Property Value
Type Description
Color

contentContainer

The content container of the progress.

Declaration
public override VisualElement contentContainer { get; }
Property Value
Type Description
VisualElement
Overrides

roundedProgressCorners

Whether to use rounded corners for the progress.

Declaration
public bool roundedProgressCorners { get; set; }
Property Value
Type Description
bool

size

The LinearProgress size.

Declaration
public Size size { get; set; }
Property Value
Type Description
Size

value

The progress value (normalized).

Declaration
public float value { get; set; }
Property Value
Type Description
float

variant

The variant of the progress.

Declaration
public Progress.Variant variant { get; set; }
Property Value
Type Description
Progress.Variant

Methods

GenerateTextures()

Generates the textures for the progress.

Declaration
protected virtual void GenerateTextures()

GetSizeUssClassName(Size)

Declaration
public static string GetSizeUssClassName(Size enumValue)
Parameters
Type Name Description
Size enumValue
Returns
Type Description
string

GetVariantUssClassName(Variant)

Declaration
public static string GetVariantUssClassName(Progress.Variant enumValue)
Parameters
Type Name Description
Progress.Variant enumValue
Returns
Type Description
string

Implements

Extension Methods