Skip to content

Commit

Permalink
Add trailing_fill() toggle to Slider (#2660)
Browse files Browse the repository at this point in the history
* slider: add trailing_color toggle

* slider/visuals: add global option in visuals with override toggle

* slider: add to demos

* use `.unwrap_or_else()` instead of match
  • Loading branch information
hinto-janai authored Feb 5, 2023
1 parent 212656f commit 628c84c
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 12 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ NOTE: [`epaint`](crates/epaint/CHANGELOG.md), [`eframe`](crates/eframe/CHANGELOG
* ⚠️ BREAKING: `egui::Context` now use closures for locking ([#2625](https://github.com/emilk/egui/pull/2625)):
* `ctx.input().key_pressed(Key::A)` -> `ctx.input(|i| i.key_pressed(Key::A))`
* `ui.memory().toggle_popup(popup_id)` -> `ui.memory_mut(|mem| mem.toggle_popup(popup_id))`
* Add `Slider::trailing_fill` for trailing color behind the circle like a `ProgressBar` ([#2660](https://github.com/emilk/egui/pull/2660)).

### Added ⭐
* Add `Response::drag_started_by` and `Response::drag_released_by` for convenience, similar to `dragged` and `dragged_by` ([#2507](https://github.com/emilk/egui/pull/2507)).
Expand Down
11 changes: 11 additions & 0 deletions crates/egui/src/style.rs
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,11 @@ pub struct Visuals {
/// Wether or not Grids and Tables should be striped by default
/// (have alternating rows differently colored).
pub striped: bool,

/// Show trailing color behind the circle of a [`Slider`]. Default is OFF.
///
/// Enabling this will affect ALL sliders, and can be enabled/disabled per slider with [`Slider::trailing_fill`].
pub slider_trailing_fill: bool,
}

impl Visuals {
Expand Down Expand Up @@ -768,6 +773,8 @@ impl Visuals {
indent_has_left_vline: true,

striped: false,

slider_trailing_fill: false,
}
}

Expand Down Expand Up @@ -1333,6 +1340,8 @@ impl Visuals {
indent_has_left_vline,

striped,

slider_trailing_fill,
} = self;

ui.collapsing("Background Colors", |ui| {
Expand Down Expand Up @@ -1395,6 +1404,8 @@ impl Visuals {

ui.checkbox(striped, "By default, add stripes to grids and tables?");

ui.checkbox(slider_trailing_fill, "Add trailing color to sliders");

ui.vertical_centered(|ui| reset_button(ui, self));
}
}
Expand Down
51 changes: 43 additions & 8 deletions crates/egui/src/widgets/slider.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ pub struct Slider<'a> {
max_decimals: Option<usize>,
custom_formatter: Option<NumFormatter<'a>>,
custom_parser: Option<NumParser<'a>>,
trailing_fill: Option<bool>,
}

impl<'a> Slider<'a> {
Expand Down Expand Up @@ -129,6 +130,7 @@ impl<'a> Slider<'a> {
max_decimals: None,
custom_formatter: None,
custom_parser: None,
trailing_fill: None,
}
}

Expand Down Expand Up @@ -269,6 +271,17 @@ impl<'a> Slider<'a> {
self
}

/// Display trailing color behind the slider's circle. Default is OFF.
///
/// This setting can be enabled globally for all sliders with [`Visuals::slider_trailing_fill`].
/// Toggling it here will override the above setting ONLY for this individual slider.
///
/// The fill color will be taken from `selection.bg_fill` in your [`Visuals`], the same as a [`ProgressBar`].
pub fn trailing_fill(mut self, trailing_fill: bool) -> Self {
self.trailing_fill = Some(trailing_fill);
self
}

/// Set custom formatter defining how numbers are converted into text.
///
/// A custom formatter takes a `f64` for the numeric value and a `RangeInclusive<usize>` representing
Expand Down Expand Up @@ -616,18 +629,40 @@ impl<'a> Slider<'a> {
let rail_radius = ui.painter().round_to_pixel(self.rail_radius_limit(rect));
let rail_rect = self.rail_rect(rect, rail_radius);

let position_1d = self.position_from_value(value, position_range);

let visuals = ui.style().interact(response);
ui.painter().add(epaint::RectShape {
rect: rail_rect,
rounding: ui.visuals().widgets.inactive.rounding,
fill: ui.visuals().widgets.inactive.bg_fill,
stroke: Default::default(),
});
let widget_visuals = &ui.visuals().widgets;

ui.painter().rect_filled(
rail_rect,
widget_visuals.inactive.rounding,
widget_visuals.inactive.bg_fill,
);

let position_1d = self.position_from_value(value, position_range);
let center = self.marker_center(position_1d, &rail_rect);

// Decide if we should add trailing fill.
let trailing_fill = self
.trailing_fill
.unwrap_or_else(|| ui.visuals().slider_trailing_fill);

// Paint trailing fill.
if trailing_fill {
let mut trailing_rail_rect = rail_rect;

// The trailing rect has to be drawn differently depending on the orientation.
match self.orientation {
SliderOrientation::Vertical => trailing_rail_rect.min.y = center.y,
SliderOrientation::Horizontal => trailing_rail_rect.max.x = center.x,
};

ui.painter().rect_filled(
trailing_rail_rect,
widget_visuals.inactive.rounding,
ui.visuals().selection.bg_fill,
);
}

ui.painter().add(epaint::CircleShape {
center,
radius: self.handle_radius(rect) + visuals.expansion,
Expand Down
20 changes: 16 additions & 4 deletions crates/egui_demo_lib/src/demo/sliders.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ pub struct Sliders {
pub integer: bool,
pub vertical: bool,
pub value: f64,
pub trailing_fill: bool,
}

impl Default for Sliders {
Expand All @@ -31,6 +32,7 @@ impl Default for Sliders {
integer: false,
vertical: false,
value: 10.0,
trailing_fill: false,
}
}
}
Expand Down Expand Up @@ -64,6 +66,7 @@ impl super::View for Sliders {
integer,
vertical,
value,
trailing_fill,
} = self;

ui.label("You can click a slider value to edit it with the keyboard.");
Expand Down Expand Up @@ -95,7 +98,8 @@ impl super::View for Sliders {
.smart_aim(*smart_aim)
.orientation(orientation)
.text("i32 demo slider")
.step_by(istep),
.step_by(istep)
.trailing_fill(*trailing_fill),
);
*value = value_i32 as f64;
} else {
Expand All @@ -106,7 +110,8 @@ impl super::View for Sliders {
.smart_aim(*smart_aim)
.orientation(orientation)
.text("f64 demo slider")
.step_by(istep),
.step_by(istep)
.trailing_fill(*trailing_fill),
);

ui.label(
Expand All @@ -126,17 +131,24 @@ impl super::View for Sliders {
Slider::new(min, type_min..=type_max)
.logarithmic(true)
.smart_aim(*smart_aim)
.text("left"),
.text("left")
.trailing_fill(*trailing_fill),
);
ui.add(
Slider::new(max, type_min..=type_max)
.logarithmic(true)
.smart_aim(*smart_aim)
.text("right"),
.text("right")
.trailing_fill(*trailing_fill),
);

ui.separator();

ui.checkbox(trailing_fill, "Toggle trailing color");
ui.label("When enabled, trailing color will be painted up until the circle.");

ui.separator();

ui.checkbox(use_steps, "Use steps");
ui.label("When enabled, the minimal value change would be restricted to a given step.");
if *use_steps {
Expand Down

0 comments on commit 628c84c

Please sign in to comment.