Struct ProgressBar 

pub struct ProgressBar {
    pub value: Option<f32>,
    pub max: f32,
    pub period_ms: u32,
}

State for one <progress> element (the track entity).

Fields

value: Option<f32>

Some(v) = determinate at v / max; None = indeterminate. bind-value writes flip an indeterminate bar to determinate.

max: f32

Upper bound for value. Authored max=, default 1.0.

period_ms: u32

Indeterminate sweep period in milliseconds (one full left-to-right-to-left bounce).

Implementations

impl ProgressBar

pub fn clamp(&self, value: f32) -> f32

value held to this bar’s bounds.

A progress bar starts at zero and runs to its Self::max; it has no lower bound of its own, which is what separates it from a lumen_core::components::SliderValue. A negative max would leave no range at all, so the upper bound is held at zero too.

Both the signal binding and the web emitter writing the page ahead of it read the rule here, so a bar in a document and a bar in the app that adopts it sit in the same place.

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> ProgressBar

Returns a duplicate 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.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns [ComponentRelationshipAccessor] required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Debug for ProgressBar

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

Formats the value using the given formatter.

impl Default for ProgressBar

fn default() -> Self

Returns the “default value” for a type.