Class ProgressBar

Represents a progress bar UI element.

Inheritance
object
Widget
ProgressBar
Inherited Members
Namespace: Genesis.UI
Assembly: Genesis.dll
Syntax
public class ProgressBar : Widget

Constructors

ProgressBar(string, Vec3, Vec3)

Initializes a new instance of the ProgressBar class with the specified name, location, and size.

Declaration
public ProgressBar(string name, Vec3 location, Vec3 size)
Parameters
Type Name Description
string name

The name of the progress bar.
Vec3 location

The location of the progress bar.
Vec3 size

The size of the progress bar.

ProgressBar(string, Vec3, Vec3, WidgetAnchor)

Initializes a new instance of the ProgressBar class with the specified name, location, and size.

Declaration
public ProgressBar(string name, Vec3 location, Vec3 size, WidgetAnchor anchor)
Parameters
Type Name Description
string name

The name of the progress bar.
Vec3 location

The location of the progress bar.
Vec3 size

The size of the progress bar.
WidgetAnchor anchor

The anchor for the progress bar

Properties

BackgroundColor

Gets or sets the background color of the progress bar.

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

BarColor

Gets or sets the color of the progress bar.

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

BorderColor

Gets or sets the color of the progress bar border.

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

MaxValue

Gets or sets the maximum value of the progress bar.

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

Value

Gets or sets the current value of the progress bar.

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

Methods

OnRender(Game, IRenderDevice, Scene, Canvas)

Renders the progress bar with its background, bar, and border.

Declaration
public override void OnRender(Game game, IRenderDevice renderDevice, Scene scene, Canvas canvas)
Parameters
Type Name Description
Game game

The game instance.
IRenderDevice renderDevice

The render device used for rendering.
Scene scene

The scene in which the progress bar is rendered.
Canvas canvas

The canvas to which the progress bar belongs.
Overrides