skyler
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix id clash in `Ui::response` (#5192) 

This adds a new `Ui::unique_id` used in `Ui::response`.

I'll make a follow-up PR where the old `id` is renamed `stable_id`, and
deprecate `fn id` to force users to think through which `id` they want.

* Closes https://github.com/emilk/egui/issues/5190
This commit is contained in:
Emil Ernerfeldt 2024-09-30 13:20:34 +02:00 committed by GitHub
parent 5390ecdf4a
commit 448e12d6b6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 57 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
crates/egui/src/ui.rs
View File

@ -49,15 +49,27 @@ use crate::Stroke;
/// # });
/// ```
pub struct Ui {
/// ID of this ui.
/// Generated based on id of parent ui together with an optional id salt.
///
/// Generated based on id of parent ui together with
/// another source of child identity (e.g. window title).
/// Acts like a namespace for child uis.
/// Should be unique and persist predictably from one frame to next
/// so it can be used as a source for storing state (e.g. window position, or if a collapsing header is open).
/// This should be stable from one frame to next
/// so it can be used as a source for storing state
/// (e.g. window position, or if a collapsing header is open).
///
/// However, it is not necessarily globally unique.
/// For instance, sibling `Ui`s share the same [`Self::id`]
/// unless they where explicitly given different id salts using
/// [`UiBuilder::id_salt`].
id: Id,
/// This is a globally unique ID of this `Ui`,
/// based on where in the hierarchy of widgets this Ui is in.
///
/// This means it is not _stable_, as it can change if new widgets
/// are added or removed prior to this one.
/// It should therefore only be used for transient interactions (clicks etc),
/// not for storing state over time.
unique_id: Id,
/// This is used to create a unique interact ID for some widgets.
///
/// This value is based on where in the hierarchy of widgets this Ui is in,
@ -144,6 +156,7 @@ impl Ui {
};
let mut ui = Ui {
id,
unique_id: id,
next_auto_id_salt: id.with("auto").value(),
painter: Painter::new(ctx, layer_id, clip_rect),
style,
@ -157,10 +170,10 @@ impl Ui {
};
// Register in the widget stack early, to ensure we are behind all widgets we contain:
let start_rect = Rect::NOTHING; // This will be overwritten when/if `interact_bg` is called
let start_rect = Rect::NOTHING; // This will be overwritten when/if `remember_min_rect` is called
ui.ctx().create_widget(
WidgetRect {
id: ui.id,
id: ui.unique_id,
layer_id: ui.layer_id(),
rect: start_rect,
interact_rect: start_rect,
@ -266,14 +279,15 @@ impl Ui {
}
debug_assert!(!max_rect.any_nan());
let new_id = self.id.with(id_salt);
let next_auto_id_salt = new_id.with(self.next_auto_id_salt).value();
let stable_id = self.id.with(id_salt);
let unique_id = stable_id.with(self.next_auto_id_salt);
let next_auto_id_salt = unique_id.value().wrapping_add(1);
self.next_auto_id_salt = self.next_auto_id_salt.wrapping_add(1);
let placer = Placer::new(max_rect, layout);
let ui_stack = UiStack {
id: new_id,
id: unique_id,
layout_direction: layout.main_dir,
info: ui_stack_info,
parent: Some(self.stack.clone()),
@ -281,7 +295,8 @@ impl Ui {
max_rect: placer.max_rect(),
};
let child_ui = Ui {
id: new_id,
id: stable_id,
unique_id,
next_auto_id_salt,
painter,
style,
@ -295,10 +310,10 @@ impl Ui {
};
// Register in the widget stack early, to ensure we are behind all widgets we contain:
let start_rect = Rect::NOTHING; // This will be overwritten when/if `interact_bg` is called
let start_rect = Rect::NOTHING; // This will be overwritten when/if `remember_min_rect` is called
child_ui.ctx().create_widget(
WidgetRect {
id: child_ui.id,
id: child_ui.unique_id,
layer_id: child_ui.layer_id(),
rect: start_rect,
interact_rect: start_rect,
@ -334,12 +349,33 @@ impl Ui {
// -------------------------------------------------
/// A unique identity of this [`Ui`].
/// Generated based on id of parent ui together with an optional id salt.
///
/// This should be stable from one frame to next
/// so it can be used as a source for storing state
/// (e.g. window position, or if a collapsing header is open).
///
/// However, it is not necessarily globally unique.
/// For instance, sibling `Ui`s share the same [`Self::id`]
/// unless they where explicitly given different id salts using
/// [`UiBuilder::id_salt`].
#[inline]
pub fn id(&self) -> Id {
self.id
}
/// This is a globally unique ID of this `Ui`,
/// based on where in the hierarchy of widgets this Ui is in.
///
/// This means it is not _stable_, as it can change if new widgets
/// are added or removed prior to this one.
/// It should therefore only be used for transient interactions (clicks etc),
/// not for storing state over time.
#[inline]
pub fn unique_id(&self) -> Id {
self.unique_id
}
/// Style options for this [`Ui`] and its children.
///
/// Note that this may be a different [`Style`] than that of [`Context::style`].
@ -1044,8 +1080,8 @@ impl Ui {
viewport
.prev_pass
.widgets
.get(self.id)
.or_else(|| viewport.this_pass.widgets.get(self.id))
.get(self.unique_id)
.or_else(|| viewport.this_pass.widgets.get(self.unique_id))
.copied()
})
.map(|widget_rect| self.ctx().get_response(widget_rect))
@ -1062,12 +1098,12 @@ impl Ui {
// when the ui was created with `UiBuilder::sense`.
// This is a bit hacky, is there a better way?
self.ctx().pass_state_mut(|fs| {
fs.used_ids.remove(&self.id);
fs.used_ids.remove(&self.unique_id);
});
// This will update the WidgetRect that was first created in `Ui::new`.
self.ctx().create_widget(
WidgetRect {
id: self.id,
id: self.unique_id,
layer_id: self.layer_id(),
rect: self.min_rect(),
interact_rect: self.clip_rect().intersect(self.min_rect()),
@ -1085,7 +1121,7 @@ impl Ui {
#[deprecated = "Use UiBuilder::sense with Ui::response instead"]
pub fn interact_bg(&self, sense: Sense) -> Response {
// This will update the WidgetRect that was first created in `Ui::new`.
self.interact(self.min_rect(), self.id, sense)
self.interact(self.min_rect(), self.unique_id, sense)
}
/// Is the pointer (mouse/touch) above this rectangle in this [`Ui`]?
@ -1372,7 +1408,7 @@ impl Ui {
let item_spacing = self.spacing().item_spacing;
self.placer.advance_after_rects(rect, rect, item_spacing);
register_rect(self, rect);
let response = self.interact(rect, child_ui.id, Sense::hover());
let response = self.interact(rect, child_ui.unique_id, Sense::hover());
InnerResponse::new(inner, response)
}