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 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
use ahash::HashMap;
use emath::TSTransform;
use crate::*;
/// Result of a hit-test against [`WidgetRects`].
///
/// Answers the question "what is under the mouse pointer?".
///
/// Note that this doesn't care if the mouse button is pressed or not,
/// or if we're currently already dragging something.
#[derive(Clone, Debug, Default)]
pub struct WidgetHits {
/// All widgets that contains the pointer, back-to-front.
///
/// i.e. both a Window and the button in it can contain the pointer.
///
/// Some of these may be widgets in a layer below the top-most layer.
pub contains_pointer: Vec<WidgetRect>,
/// If the user would start a clicking now, this is what would be clicked.
///
/// This is the top one under the pointer, or closest one of the top-most.
pub click: Option<WidgetRect>,
/// If the user would start a dragging now, this is what would be dragged.
///
/// This is the top one under the pointer, or closest one of the top-most.
pub drag: Option<WidgetRect>,
}
/// Find the top or closest widgets to the given position,
/// none which is closer than `search_radius`.
pub fn hit_test(
widgets: &WidgetRects,
layer_order: &[LayerId],
layer_transforms: &HashMap<LayerId, TSTransform>,
pos: Pos2,
search_radius: f32,
) -> WidgetHits {
crate::profile_function!();
let search_radius_sq = search_radius * search_radius;
// Transform the position into the local coordinate space of each layer:
let pos_in_layers: HashMap<LayerId, Pos2> = layer_transforms
.iter()
.map(|(layer_id, t)| (*layer_id, t.inverse() * pos))
.collect();
let mut closest_dist_sq = f32::INFINITY;
let mut closest_hit = None;
// First pass: find the few widgets close to the given position, sorted back-to-front.
let mut close: Vec<WidgetRect> = layer_order
.iter()
.filter(|layer| layer.order.allow_interaction())
.flat_map(|&layer_id| widgets.get_layer(layer_id))
.filter(|&w| {
if w.interact_rect.is_negative() {
return false;
}
let pos_in_layer = pos_in_layers.get(&w.layer_id).copied().unwrap_or(pos);
let dist_sq = w.interact_rect.distance_sq_to_pos(pos_in_layer);
// In tie, pick last = topmost.
if dist_sq <= closest_dist_sq {
closest_dist_sq = dist_sq;
closest_hit = Some(w);
}
dist_sq <= search_radius_sq
})
.copied()
.collect();
// We need to pick one single layer for the interaction.
if let Some(closest_hit) = closest_hit {
// Select the top layer, and ignore widgets in any other layer:
let top_layer = closest_hit.layer_id;
close.retain(|w| w.layer_id == top_layer);
// If the widget is disabled, treat it as if it isn't sensing anything.
// This simplifies the code in `hit_test_on_close` so it doesn't have to check
// the `enabled` flag everywhere:
for w in &mut close {
if !w.enabled {
w.sense.click = false;
w.sense.drag = false;
}
}
let pos_in_layer = pos_in_layers.get(&top_layer).copied().unwrap_or(pos);
let hits = hit_test_on_close(&close, pos_in_layer);
if let Some(drag) = hits.drag {
debug_assert!(drag.sense.drag);
}
if let Some(click) = hits.click {
debug_assert!(click.sense.click);
}
hits
} else {
// No close widgets.
Default::default()
}
}
fn hit_test_on_close(close: &[WidgetRect], pos: Pos2) -> WidgetHits {
#![allow(clippy::collapsible_else_if)]
// Only those widgets directly under the `pos`.
let hits: Vec<WidgetRect> = close
.iter()
.filter(|widget| widget.interact_rect.contains(pos))
.copied()
.collect();
let hit_click = hits.iter().copied().filter(|w| w.sense.click).last();
let hit_drag = hits.iter().copied().filter(|w| w.sense.drag).last();
match (hit_click, hit_drag) {
(None, None) => {
// No direct hit on anything. Find the closest interactive widget.
let closest = find_closest(
close
.iter()
.copied()
.filter(|w| w.sense.click || w.sense.drag),
pos,
);
if let Some(closest) = closest {
WidgetHits {
contains_pointer: hits,
click: closest.sense.click.then_some(closest),
drag: closest.sense.drag.then_some(closest),
}
} else {
// Found nothing
WidgetHits {
contains_pointer: hits,
click: None,
drag: None,
}
}
}
(None, Some(hit_drag)) => {
// We have a perfect hit on a drag, but not on click.
// We have a direct hit on something that implements drag.
// This could be a big background thing, like a `ScrollArea` background,
// or a moveable window.
// It could also be something small, like a slider, or panel resize handle.
let closest_click = find_closest(close.iter().copied().filter(|w| w.sense.click), pos);
if let Some(closest_click) = closest_click {
if closest_click.sense.drag {
// We have something close that sense both clicks and drag.
// Should we use it over the direct drag-hit?
if hit_drag
.interact_rect
.contains_rect(closest_click.interact_rect)
{
// This is a smaller thing on a big background - help the user hit it,
// and ignore the big drag background.
WidgetHits {
contains_pointer: hits,
click: Some(closest_click),
drag: Some(closest_click),
}
} else {
// The drag wiudth is separate from the click wiudth,
// so return only the drag widget
WidgetHits {
contains_pointer: hits,
click: None,
drag: Some(hit_drag),
}
}
} else {
// These is a close pure-click widget.
// However, we should be careful to only return two different widgets
// when it is absolutely not going to confuse the user.
if hit_drag
.interact_rect
.contains_rect(closest_click.interact_rect)
{
// The drag widget is a big background thing (scroll area),
// so returning a separate click widget should not be confusing
WidgetHits {
contains_pointer: hits,
click: Some(closest_click),
drag: Some(hit_drag),
}
} else {
// The two widgets are just two normal small widgets close to each other.
// Highlighting both would be very confusing.
WidgetHits {
contains_pointer: hits,
click: None,
drag: Some(hit_drag),
}
}
}
} else {
// No close clicks.
// Maybe there is a close drag widget, that is a smaller
// widget floating on top of a big background?
// If so, it would be nice to help the user click that.
let closest_drag = find_closest(
close
.iter()
.copied()
.filter(|w| w.sense.drag && w.id != hit_drag.id),
pos,
);
if let Some(closest_drag) = closest_drag {
if hit_drag
.interact_rect
.contains_rect(closest_drag.interact_rect)
{
// `hit_drag` is a big background thing and `closest_drag` is something small on top of it.
// Be helpful and return the small things:
return WidgetHits {
contains_pointer: hits,
click: None,
drag: Some(closest_drag),
};
}
}
WidgetHits {
contains_pointer: hits,
click: None,
drag: Some(hit_drag),
}
}
}
(Some(hit_click), None) => {
// We have a perfect hit on a click-widget, but not on a drag-widget.
//
// Note that we don't look for a close drag widget in this case,
// because I can't think of a case where that would be helpful.
// This is in contrast with the opposite case,
// where when hovering directly over a drag-widget (like a big ScrollArea),
// we look for close click-widgets (e.g. buttons).
// This is because big background drag-widgets (ScrollArea, Window) are common,
// but bit clickable things aren't.
// Even if they were, I think it would be confusing for a user if clicking
// a drag-only widget would click something _behind_ it.
WidgetHits {
contains_pointer: hits,
click: Some(hit_click),
drag: None,
}
}
(Some(hit_click), Some(hit_drag)) => {
// We have a perfect hit on both click and drag. Which is the topmost?
let click_idx = hits.iter().position(|w| *w == hit_click).unwrap();
let drag_idx = hits.iter().position(|w| *w == hit_drag).unwrap();
let click_is_on_top_of_drag = drag_idx < click_idx;
if click_is_on_top_of_drag {
if hit_click.sense.drag {
// The top thing senses both clicks and drags.
WidgetHits {
contains_pointer: hits,
click: Some(hit_click),
drag: Some(hit_click),
}
} else {
// They are interested in different things,
// and click is on top. Report both hits,
// e.g. the top Button and the ScrollArea behind it.
WidgetHits {
contains_pointer: hits,
click: Some(hit_click),
drag: Some(hit_drag),
}
}
} else {
if hit_drag.sense.click {
// The top thing senses both clicks and drags.
WidgetHits {
contains_pointer: hits,
click: Some(hit_drag),
drag: Some(hit_drag),
}
} else {
// The top things senses only drags,
// so we ignore the click-widget, because it would be confusing
// if clicking a drag-widget would actually click something else below it.
WidgetHits {
contains_pointer: hits,
click: None,
drag: Some(hit_drag),
}
}
}
}
}
}
fn find_closest(widgets: impl Iterator<Item = WidgetRect>, pos: Pos2) -> Option<WidgetRect> {
let mut closest = None;
let mut closest_dist_sq = f32::INFINITY;
for widget in widgets {
if widget.interact_rect.is_negative() {
continue;
}
let dist_sq = widget.interact_rect.distance_sq_to_pos(pos);
// In case of a tie, take the last one = the one on top.
if dist_sq <= closest_dist_sq {
closest_dist_sq = dist_sq;
closest = Some(widget);
}
}
closest
}
#[cfg(test)]
mod tests {
use super::*;
fn wr(id: Id, sense: Sense, rect: Rect) -> WidgetRect {
WidgetRect {
id,
layer_id: LayerId::background(),
rect,
interact_rect: rect,
sense,
enabled: true,
}
}
#[test]
fn buttons_on_window() {
let widgets = vec![
wr(
Id::new("bg-area"),
Sense::drag(),
Rect::from_min_size(pos2(0.0, 0.0), vec2(100.0, 100.0)),
),
wr(
Id::new("click"),
Sense::click(),
Rect::from_min_size(pos2(10.0, 10.0), vec2(10.0, 10.0)),
),
wr(
Id::new("click-and-drag"),
Sense::click_and_drag(),
Rect::from_min_size(pos2(100.0, 10.0), vec2(10.0, 10.0)),
),
];
// Perfect hit:
let hits = hit_test_on_close(&widgets, pos2(15.0, 15.0));
assert_eq!(hits.click.unwrap().id, Id::new("click"));
assert_eq!(hits.drag.unwrap().id, Id::new("bg-area"));
// Close hit:
let hits = hit_test_on_close(&widgets, pos2(5.0, 5.0));
assert_eq!(hits.click.unwrap().id, Id::new("click"));
assert_eq!(hits.drag.unwrap().id, Id::new("bg-area"));
// Perfect hit:
let hits = hit_test_on_close(&widgets, pos2(105.0, 15.0));
assert_eq!(hits.click.unwrap().id, Id::new("click-and-drag"));
assert_eq!(hits.drag.unwrap().id, Id::new("click-and-drag"));
// Close hit - should still ignore the drag-background so as not to confuse the userr:
let hits = hit_test_on_close(&widgets, pos2(105.0, 5.0));
assert_eq!(hits.click.unwrap().id, Id::new("click-and-drag"));
assert_eq!(hits.drag.unwrap().id, Id::new("click-and-drag"));
}
#[test]
fn thin_resize_handle_next_to_label() {
let widgets = vec![
wr(
Id::new("bg-area"),
Sense::drag(),
Rect::from_min_size(pos2(0.0, 0.0), vec2(100.0, 100.0)),
),
wr(
Id::new("bg-left-label"),
Sense::click_and_drag(),
Rect::from_min_size(pos2(0.0, 0.0), vec2(40.0, 100.0)),
),
wr(
Id::new("thin-drag-handle"),
Sense::drag(),
Rect::from_min_size(pos2(30.0, 0.0), vec2(70.0, 100.0)),
),
wr(
Id::new("fg-right-label"),
Sense::click_and_drag(),
Rect::from_min_size(pos2(60.0, 0.0), vec2(50.0, 100.0)),
),
];
for (i, w) in widgets.iter().enumerate() {
eprintln!("Widget {i}: {:?}", w.id);
}
// In the middle of the bg-left-label:
let hits = hit_test_on_close(&widgets, pos2(25.0, 50.0));
assert_eq!(hits.click.unwrap().id, Id::new("bg-left-label"));
assert_eq!(hits.drag.unwrap().id, Id::new("bg-left-label"));
// On both the left click-and-drag and thin handle, but the thin handle is on top and should win:
let hits = hit_test_on_close(&widgets, pos2(35.0, 50.0));
assert_eq!(hits.click, None);
assert_eq!(hits.drag.unwrap().id, Id::new("thin-drag-handle"));
// Only on the thin-drag-handle:
let hits = hit_test_on_close(&widgets, pos2(50.0, 50.0));
assert_eq!(hits.click, None);
assert_eq!(hits.drag.unwrap().id, Id::new("thin-drag-handle"));
// On both the thin handle and right label. The label is on top and should win
let hits = hit_test_on_close(&widgets, pos2(65.0, 50.0));
assert_eq!(hits.click.unwrap().id, Id::new("fg-right-label"));
assert_eq!(hits.drag.unwrap().id, Id::new("fg-right-label"));
}
}