Struct SliderValue 

pub struct SliderValue {
    pub value: f32,
    pub min: f32,
    pub max: f32,
    pub step: Option<f32>,
}

Bounded scalar state for <slider> entities. value is held in [min, max]; the runtime emits on_slider(id, value) on drag or track click.

Fields

value: f32

Current value, clamped to [min, max].

min: f32

Lower bound.

max: f32

Upper bound.

step: Option<f32>

Authored step="..." increment for keyboard arrows and wheel notches. None falls back to (max - min) / 100 - the <input type=range> browser default of 100 discrete positions (see Self::step_size).

Implementations

impl SliderValue

pub fn step_size(&self) -> f32

Effective step increment: the authored Self::step, or (max - min) / 100 when unset.

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

value held to this slider’s bounds.

The bounds are taken either way round, so a slider authored with its max below its min still has a range rather than an empty one.

Every path that puts a value on a slider comes through here: the spawner with what the markup authored, the signal binding with what a script wrote, and the web emitter writing the page ahead of both. A second copy of the rule would let a page disagree with the app that adopts it.

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

value moved to the nearest position on this slider’s step grid, then held to its bounds.

The grid starts at the near bound and rises by Self::step_size, which is what <input type=range> does and what a QSlider’s integer range gives for free. A pointer landing anywhere on the track therefore writes a value the arrow keys could also have reached, so step="1024" means multiples of 1024 whichever way the user moved it.

A range that is not a whole number of steps stops short of its far bound: the last position on the grid is the highest one that fits, so min="0" max="100" step="30" tops out at 90. That is what <input type=range> does, and it is the only answer that keeps every value the control can take on the grid.

A grid position is written with no more decimal places than the near bound and the step carry between them, so min="0.8" step="0.1" lands on 0.9 rather than on the 0.90000004 that adding the two in binary floating point gives. That is the value a bound signal and a label reading it show.

Trait Implementations

impl Clone for SliderValue

fn clone(&self) -> SliderValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for SliderValue

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 SliderValue

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

Formats the value using the given formatter.

impl Default for SliderValue

fn default() -> Self

Returns the “default value” for a type.

impl From<&SliderValue> for A11yRole

fn from(_: &SliderValue) -> Self

Converts to this type from the input type.

impl From<&SliderValue> for A11yValue

fn from(s: &SliderValue) -> Self

Converts to this type from the input type.

impl Copy for SliderValue