Struct game_library::progress_bar::ProgressBarConfig

pub struct ProgressBarConfig<T: Percentage + Component> {
    pub color_scheme: ColorScheme,
    pub size: Vec2,
    pub position_translation: Vec3,
    /* private fields */
}

Configuration of a progress bar.

Fields

color_scheme: ColorScheme

The color scheme to use for the progress bar.

size: Vec2

The size of the progress bar.

This is the size to draw the background for the bar, and the foreground bar will be drawn inside of this. At full, the foreground bar will be the same size as the background bar.

position_translation: Vec3

The relative position of the progress bar to the entity it will be attached to.

This is relative to the [Transform.translation] of the entity.

Implementations

impl<T: Percentage + Component> ProgressBarConfig<T>

pub const BACKGROUND_BAR_SHIFT: f32 = 1f32

The shift of the background bar (in the z-axis) relative to the entity’s translation.

pub const FOREGROUND_BAR_SHIFT: f32 = 0.100000001f32

The shift of the foreground bar (in the z-axis) relative to the background bar.

pub fn new(color_scheme: ColorScheme) -> Self

Create a new progress bar config with the given color scheme.

pub const fn with_color_scheme(self, color_scheme: ColorScheme) -> Self

Update the progress bar config with the given color scheme.

pub const fn with_background_color(self, color: Color) -> Self

Update the progress bar’s color scheme with the given background color.

pub fn with_color(self, state: &BarState, color: Color) -> Self

Update the progress bar’s color scheme with the given color for the given state.

pub fn with_moderate_cutoff(self, cutoff: f32) -> Self

Update the progress bar’s color scheme with the given moderate cutoff.

pub fn with_critical_cutoff(self, cutoff: f32) -> Self

Update the progress bar’s color scheme with the given critical cutoff.

pub fn with_single_color(self, color: Color) -> Self

Update the progress bar to use a single color for all states.

pub const fn with_size(self, size: Vec2) -> Self

Update the progress bar’s size.

pub const fn with_position_translation(self, position_translation: Vec3) -> Self

Update the progress bar’s relative position.

pub fn set_size(&mut self, size: Vec2)

Set the size of the progress bar.

pub fn set_position_translation(&mut self, position_translation: Vec3)

Set the relative position of the progress bar.

pub fn set_color_scheme(&mut self, color_scheme: ColorScheme)

Set the color scheme of the progress bar.

pub const fn background_color(&self) -> Color

Get the background color.

pub fn color(&self, percentage: &T) -> Color

Get the foreground color for the given T.

pub fn background_transform(&self, entity_transform: &Transform) -> Transform

Get the realized [Transform] for the progress bar background.

This adjusts the translation of the background to be relative to the entity’s translation.

pub fn foreground_transform( &self, entity_transform: &Transform, percentage: &T ) -> Transform

Get the realized [Transform] for the progress bar foreground.

This adjusts the translation of the foreground to be relative to the entity’s translation. It also adjusts the translation of the foreground to be centered on the entity’s translation.

pub fn background_mesh(&self) -> Mesh

Get the mesh for the progress bar background.

This is a [Quad] with the size of the progress bar.

pub fn foreground_mesh(&self, percentage: &T) -> Mesh

Get the mesh for the progress bar foreground.

This is a [Quad] with the size of the progress bar foreground, which is the size of the progress bar background scaled by the percentage.

pub fn get_state(&self, percentage: &T) -> BarState

Get the current BarState for the given percentage.

pub const fn color_for_state(&self, state: &BarState) -> Color

Get the color for the given BarState.

Trait Implementations

impl<T: Clone + Percentage + Component> Clone for ProgressBarConfig<T>

fn clone(&self) -> ProgressBarConfig<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Percentage + Component> Component for ProgressBarConfig<T>

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].

impl<T: Debug + Percentage + Component> Debug for ProgressBarConfig<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Percentage + Component> Default for ProgressBarConfig<T>

fn default() -> Self

Returns the “default value” for a type.