1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
//! Slider and drag widget rendering methods.
//!
//! Provided [`PixState`] methods:
//!
//! - [`PixState::drag`]
//! - [`PixState::advanced_drag`]
//! - [`PixState::slider`]
//! - [`PixState::advanced_slider`]
//!
//! # Example
//!
//! ```
//! # use pix_engine::prelude::*;
//! # struct App { drag: i32, advanced_drag: f32, slider: i32, advanced_slider: f32};
//! # impl PixEngine for App {
//! fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
//! s.drag("Drag", &mut self.drag, 1)?;
//! s.advanced_drag(
//! "Advanced Drag",
//! &mut self.advanced_drag,
//! 0.005,
//! 0.0,
//! 1.0,
//! Some(|val| format!("{:.3}", val).into()),
//! )?;
//! s.slider("Slider", &mut self.slider, -5, 5)?;
//! s.advanced_slider(
//! "Advanced Slider",
//! &mut self.advanced_slider,
//! 0.0,
//! 1.0,
//! Some(|val| format!("ratio = {:.3}", val).into()),
//! )?;
//! Ok(())
//! }
//! # }
//! ```
use crate::{
gui::{scroll::THUMB_MIN, MOD_CTRL},
ops::clamp_size,
prelude::*,
};
use num_traits::{clamp, Bounded};
use std::{borrow::Cow, error::Error as StdError, fmt, str::FromStr};
impl PixState {
/// Draw a draggable number widget to the current canvas.
///
/// # Errors
///
/// If the renderer fails to draw to the current render target, then an error is returned.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App { int: i32, float: f32};
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// s.drag("Drag Int", &mut self.int, 1)?;
/// s.drag("Drag Float", &mut self.float, 0.005)?;
/// Ok(())
/// }
/// # }
/// ```
pub fn drag<T, L>(&mut self, label: L, value: &mut T, speed: T) -> PixResult<bool>
where
T: Num + num_traits::NumCast + Bounded + fmt::Display + FromStr,
<T as FromStr>::Err: StdError + Sync + Send + 'static,
L: AsRef<str>,
{
self.advanced_drag(label, value, speed, T::min_value(), T::max_value(), None)
}
/// Draw an advanced draggable number widget to the current canvas.
///
/// # Errors
///
/// If the renderer fails to draw to the current render target, then an error is returned.
///
/// # Example
/// ```
/// # use pix_engine::prelude::*;
/// # struct App { advanced_drag: f32};
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// s.advanced_drag(
/// "Advanced Drag",
/// &mut self.advanced_drag,
/// 0.005,
/// 0.0,
/// 1.0,
/// Some(|val| format!("{:.3}", val).into()),
/// )?;
/// Ok(())
/// }
/// # }
/// ```
pub fn advanced_drag<'a, T, L>(
&mut self,
label: L,
value: &mut T,
speed: T,
min: T,
max: T,
formatter: Option<fn(&T) -> Cow<'a, str>>,
) -> PixResult<bool>
where
T: Num + num_traits::NumCast + fmt::Display + FromStr,
<T as FromStr>::Err: StdError + Sync + Send + 'static,
L: AsRef<str>,
{
let label = label.as_ref();
let s = self;
let id = s.ui.get_id(&label);
let label = s.ui.get_label(label);
let pos = s.cursor_pos();
let font_size = clamp_size(s.theme.font_size);
let spacing = s.theme.spacing;
let ipad = spacing.item_pad;
// Calculate drag rect
let width =
s.ui.next_width
.take()
.unwrap_or_else(|| s.ui_width().unwrap_or(100));
let (label_width, label_height) = s.text_size(label)?;
let [mut x, y] = pos.coords();
if !label.is_empty() {
x += label_width + ipad.x();
}
let drag = rect![x, y, width, font_size + 2 * ipad.y()];
// Check hover/active/keyboard focus
let hovered = s.focused() && s.ui.try_hover(id, &drag);
let focused = s.focused() && s.ui.try_focus(id);
let disabled = s.ui.disabled;
let active = s.ui.is_active(id);
// If editing, render editable text field instead
let editing = s.ui.is_editing(id);
if editing {
if !focused || disabled {
s.ui.end_edit();
} else {
s.ui.next_width = Some(width);
let mut text = s.ui.text_edit(id, value.to_string());
let changed = s.advanced_text_field(
label,
"",
&mut text,
Some(|c| c.is_ascii_digit() || c == '.' || c == '-'),
)?;
s.ui.set_text_edit(id, text);
if let Some(Key::Return | Key::Escape) = s.ui.key_entered() {
s.ui.end_edit();
}
return Ok(changed);
}
}
let mut new_value = clamp(s.ui.parse_text_edit(id, *value), min, max);
s.push();
s.ui.push_cursor();
// Label
if !label.is_empty() {
s.set_cursor_pos([pos.x(), pos.y() + drag.height() / 2 - label_height / 2]);
s.text(label)?;
}
// Drag region
s.rect_mode(RectMode::Corner);
if hovered || active {
s.frame_cursor(&Cursor::hand())?;
}
let [stroke, bg, fg] = s.widget_colors(id, ColorType::Primary);
s.stroke(stroke);
s.fill(bg);
s.rect(drag)?;
// Value
let text = formatter.map_or_else(|| value.to_string().into(), |f| f(value));
let (vw, vh) = s.text_size(&text)?;
let center = drag.center() - point![vw, vh] / 2;
s.set_cursor_pos(center);
s.stroke(None);
s.fill(fg);
s.text(&text)?;
s.ui.pop_cursor();
s.pop();
// Process drag
if active {
if s.keymod_down(MOD_CTRL) {
// Process keyboard input
s.ui.begin_edit(id);
} else {
let mut mdelta: f64 =
num_traits::NumCast::from(s.mouse_pos().x() - s.pmouse_pos().x())
.unwrap_or_default();
if s.keymod_down(KeyMod::ALT) {
mdelta /= 10.0;
} else if s.keymod_down(KeyMod::SHIFT) {
mdelta *= 10.0;
}
let mut delta = speed * num_traits::NumCast::from(mdelta).unwrap_or_default();
// Handle integer division truncation to ensure at least some minimum drag occurs
if mdelta != 0.0 && delta == T::zero() {
delta =
T::one() * num_traits::NumCast::from(mdelta.signum()).unwrap_or_default();
}
new_value = clamp(new_value + delta, min, max);
}
}
s.ui.handle_focus(id);
s.advance_cursor([drag.right() - pos.x(), drag.height()]);
if new_value == *value {
Ok(false)
} else {
*value = new_value;
Ok(true)
}
}
/// Draw a slider widget to the current canvas.
///
/// # Errors
///
/// If the renderer fails to draw to the current render target, then an error is returned.
///
/// # Example
///
/// ```
/// # use pix_engine::prelude::*;
/// # struct App { int: i32, float: f32};
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// s.slider("Slider Int", &mut self.int, -5, 5)?;
/// s.slider("Slider Float", &mut self.float, 0.0, 1.0)?;
/// Ok(())
/// }
/// # }
/// ```
pub fn slider<T, L>(&mut self, label: L, value: &mut T, min: T, max: T) -> PixResult<bool>
where
T: Num + num_traits::NumCast + fmt::Display + FromStr,
<T as FromStr>::Err: StdError + Sync + Send + 'static,
L: AsRef<str>,
{
self.advanced_slider(label, value, min, max, None)
}
/// Draw an advanced slider widget to the current canvas.
///
/// # Errors
///
/// If the renderer fails to draw to the current render target, then an error is returned.
///
/// # Panics
///
/// Panics if `value`, `min`, or `max` can not be cast to a floating point value.
///
/// # Example
/// ```
/// # use pix_engine::prelude::*;
/// # struct App { advanced_slider: f32};
/// # impl PixEngine for App {
/// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
/// s.advanced_slider(
/// "Advanced Slider",
/// &mut self.advanced_slider,
/// 0.0,
/// 1.0,
/// Some(|val| format!("ratio = {:.3}", val).into()),
/// )?;
/// Ok(())
/// }
/// # }
/// ```
pub fn advanced_slider<'a, T, L>(
&mut self,
label: L,
value: &mut T,
min: T,
max: T,
formatter: Option<fn(&T) -> Cow<'a, str>>,
) -> PixResult<bool>
where
T: Num + num_traits::NumCast + fmt::Display + FromStr,
<T as FromStr>::Err: StdError + Sync + Send + 'static,
L: AsRef<str>,
{
let label = label.as_ref();
let s = self;
let id = s.ui.get_id(&label);
let label = s.ui.get_label(label);
let pos = s.cursor_pos();
let font_size = clamp_size(s.theme.font_size);
let spacing = s.theme.spacing;
let ipad = spacing.item_pad;
// Calculate slider rect
let width =
s.ui.next_width
.take()
.unwrap_or_else(|| s.ui_width().unwrap_or(100));
let (label_width, label_height) = s.text_size(label)?;
let [mut x, y] = pos.coords();
if !label.is_empty() {
x += label_width + ipad.x();
}
let slider = rect![x, y, width, font_size + 2 * ipad.y()];
// Check hover/active/keyboard focus
let hovered = s.focused() && s.ui.try_hover(id, &slider);
let focused = s.focused() && s.ui.try_focus(id);
let active = s.ui.is_active(id);
// If editing, render editable text field instead
let editing = s.ui.is_editing(id);
let disabled = s.ui.disabled;
if editing {
if !focused || disabled {
s.ui.end_edit();
} else {
s.ui.next_width = Some(width);
let mut text = s.ui.text_edit(id, value.to_string());
s.advanced_text_field(
label,
"",
&mut text,
Some(|c| c.is_ascii_digit() || c == '.' || c == '-'),
)?;
s.ui.set_text_edit(id, text);
if let Some(Key::Return | Key::Escape) = s.ui.key_entered() {
s.ui.end_edit();
}
return Ok(false);
}
}
let mut new_value = clamp(s.ui.parse_text_edit(id, *value), min, max);
s.push();
s.ui.push_cursor();
// Label
if !label.is_empty() {
s.set_cursor_pos([pos.x(), pos.y() + slider.height() / 2 - label_height / 2]);
s.text(label)?;
}
// Slider region
s.rect_mode(RectMode::Corner);
if hovered | active {
s.frame_cursor(&Cursor::hand())?;
}
let [stroke, bg, fg] = s.widget_colors(id, ColorType::Primary);
s.stroke(stroke);
s.fill(bg);
s.rect(slider)?;
// Scroll thumb
s.stroke(None);
s.fill(fg.blended(bg, 0.60));
let slider_w = f64::from(slider.width());
let vmin: f64 = num_traits::NumCast::from(min).unwrap_or(0.0);
let vmax: f64 = num_traits::NumCast::from(max).unwrap_or(1.0);
let val: f64 = num_traits::NumCast::from(*value).unwrap_or(0.0);
let thumb_w: f64 = if vmax - vmin > 1.0 {
slider_w / (vmax - vmin)
} else {
f64::from(THUMB_MIN)
};
let thumb_w = thumb_w.min(slider_w);
let offset = ((val - vmin) / (vmax - vmin)) * (slider_w - thumb_w);
let x = slider.x() + offset as i32;
let thumb = rect![
x + 1,
slider.y() + 1,
thumb_w as i32 - 2,
slider.height() - 2
];
s.rect(thumb)?;
// Value
let text = formatter.map_or_else(|| value.to_string().into(), |f| f(value));
let (vw, vh) = s.text_size(&text)?;
let center = slider.center() - point![vw, vh] / 2;
s.set_cursor_pos(center);
s.stroke(None);
s.fill(fg);
s.text(&text)?;
s.ui.pop_cursor();
s.pop();
if active {
if s.keymod_down(MOD_CTRL) {
// Process keyboard input
s.ui.begin_edit(id);
} else {
// Process mouse input
let mx = f64::from((s.mouse_pos().x() - slider.x()).clamp(0, slider.width()))
/ f64::from(slider.width());
new_value =
num_traits::NumCast::from(mx.mul_add(vmax - vmin, vmin)).unwrap_or(*value);
}
}
s.ui.handle_focus(id);
s.advance_cursor([slider.right() - pos.x(), slider.height()]);
if new_value == *value {
Ok(false)
} else {
*value = new_value;
Ok(true)
}
}
}