Struct ProgressBar

pub struct ProgressBar {
    pub sections: Vec<(u32, Color)>,
    pub empty_color: Color,
    /* private fields */
}

The Progress Bar. Has Different Colored section with relative size to each other and a Color for the empty space

Fields

sections: Vec<(u32, Color)>

The Different Sections The amount is the space relative to the other Sections.

empty_color: Color

The Color of the space that is not progressed to

Implementations

impl ProgressBar

pub fn new(sections: Vec<(u32, Color)>) -> Self

Creates a new ProgressBar

Examples

use bevy_progressbar::ProgressBar;
use bevy_color::palettes::tailwind;
let bar = ProgressBar::new(vec![(10, tailwind::RED_500.into()), (9, tailwind::BLUE_500.into())]);

pub fn single(color: Color) -> Self

Creates a new ProgressBar with a single section

pub fn set_progress(&mut self, amount: f32) -> &mut Self

Sets the progress of the bar

Arguments

• amount - The Progress. gets clamped between 0.0 and 1.0

Examples

use bevy_progressbar::ProgressBar;

let mut bar = ProgressBar::default();
bar.set_progress(0.5);
assert_eq!(bar.get_progress(), 0.5);
bar.set_progress(10.0);
assert_eq!(bar.get_progress(), 1.0);

pub fn get_progress(&self) -> f32

Returns the current progress

pub fn increase_progress(&mut self, amount: f32) -> &mut Self

Increases the progress the new progress is at most 1.0

Examples

use bevy_progressbar::ProgressBar;
let mut bar = ProgressBar::default();
bar.increase_progress(0.5);
assert_eq!(bar.get_progress(), 0.5);
bar.increase_progress(4.2);
assert_eq!(bar.get_progress(), 1.0);

pub fn reset(&mut self) -> &mut Self

Resets the progress to 0.0

pub fn is_finished(&self) -> bool

Returns true if the ProgressBar is is_finished

Examples

use bevy_progressbar::ProgressBar;
let mut bar = ProgressBar::default();
assert_eq!(bar.is_finished(), false);
bar.increase_progress(1.0);
assert_eq!(bar.is_finished(), true);

pub fn clear_sections(&mut self) -> &mut Self

pub fn add_section(&mut self, amount: u32, color: Color) -> &mut Self

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> ProgressBar

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for ProgressBar

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Default for ProgressBar

fn default() -> Self

Returns the “default value” for a type.