Class ProgressBar

Progress bar control shows visual progress of the action or set of actions.

System.Object
Control
ContainerControl
ProgressBar
System.IComparable
Namespace: FlaxEngine.GUI
Assembly: FlaxEngine.CSharp.dll
Syntax
[ActorToolbox("GUI")]
public class ProgressBar : ContainerControl, IComparable, IDrawable

Constructors

ProgressBar()

Initializes a new instance of the ProgressBar class.

Declaration
public ProgressBar()

ProgressBar(Single, Single, Single, Single)

Initializes a new instance of the ProgressBar class.

Declaration
public ProgressBar(float x, float y, float width, float height = 28F)
Parameters
System.Single x

System.Single y

System.Single width

System.Single height

Fields

_current

The current value (used to apply smooth progress changes).

Declaration
protected float _current
Field Value
System.Single

_maximum

The maximum progress value.

Declaration
protected float _maximum
Field Value
System.Single

_minimum

The minimum progress value.

Declaration
protected float _minimum
Field Value
System.Single

_value

The value.

Declaration
protected float _value
Field Value
System.Single

Method

The method used to effect the bar.

Declaration
[EditorOrder(41)]
[Tooltip("The method used to effect the bar.")]
public ProgressBar.BarMethod Method
Field Value
ProgressBar.BarMethod

Origin

The origin or where the bar decreases to.

Declaration
[EditorOrder(42)]
[Tooltip("The origin or where the bar decreases to.")]
public ProgressBar.BarOrigin Origin
Field Value
ProgressBar.BarOrigin

Properties

BarBrush

Gets or sets the brush used for progress bar drawing.

Declaration
[EditorDisplay("Bar Style", null)]
[EditorOrder(2012)]
[Tooltip("The brush used for progress bar drawing.")]
public IBrush BarBrush { get; set; }
Property Value
IBrush

BarColor

Gets or sets the color of the progress bar rectangle.

Declaration
[EditorDisplay("Bar Style", null)]
[EditorOrder(2010)]
[Tooltip("The color of the progress bar rectangle.")]
[ExpandGroups]
public Color BarColor { get; set; }
Property Value
Color

BarMargin

Gets or sets the margin for the progress bar rectangle within the control bounds.

Declaration
[EditorDisplay("Bar Style", null)]
[EditorOrder(2011)]
[Tooltip("The margin for the progress bar rectangle within the control bounds.")]
public Margin BarMargin { get; set; }
Property Value
Margin

Maximum

Gets or sets the maximum value.

Declaration
[EditorOrder(30)]
[Tooltip("The maximum progress value.")]
public float Maximum { get; set; }
Property Value
System.Single

Minimum

Gets or sets the minimum value.

Declaration
[EditorOrder(20)]
[Tooltip("The minimum progress value.")]
public float Minimum { get; set; }
Property Value
System.Single

SmoothingScale

Gets or sets the value smoothing scale (0 to not use it).

Declaration
[EditorOrder(40)]
[Limit(0F, 100F, 0.1F)]
[Tooltip("The value smoothing scale (0 to not use it).")]
public float SmoothingScale { get; set; }
Property Value
System.Single

UseSmoothing

Gets a value indicating whether use progress value smoothing.

Declaration
public bool UseSmoothing { get; }
Property Value
System.Boolean

Value

Gets or sets the value.

Declaration
[EditorOrder(10)]
[Tooltip("The current progress value.")]
public float Value { get; set; }
Property Value
System.Single

Methods

DrawSelf()

Draws the control.

Declaration
public override void DrawSelf()
Overrides

Update(Single)

Perform control update and all its children

Declaration
public override void Update(float deltaTime)
Parameters
System.Single deltaTime

Delta time in seconds
Overrides

Extension Methods

See Also