From 95b318d3e081ce34132959ece5738d8633c8ebd3 Mon Sep 17 00:00:00 2001 From: Emil Ernerfeldt Date: Thu, 26 Jan 2023 14:58:38 +0100 Subject: [PATCH] Better naming --- crates/egui/src/containers/panel.rs | 4 +-- crates/egui/src/painter.rs | 34 +++++++++---------- crates/egui/src/ui.rs | 22 +++++++++--- .../egui_demo_app/src/apps/fractal_clock.rs | 2 +- 4 files changed, 37 insertions(+), 25 deletions(-) diff --git a/crates/egui/src/containers/panel.rs b/crates/egui/src/containers/panel.rs index 4141fd55..980ca5cb 100644 --- a/crates/egui/src/containers/panel.rs +++ b/crates/egui/src/containers/panel.rs @@ -237,7 +237,7 @@ impl SidePanel { let we_are_on_top = ui .ctx() .layer_id_at(pointer) - .map_or(true, |top_layer_id| top_layer_id == ui.layer_id()); + .map_or(true, |top_layer_id| top_layer_id == ui.area_layer_id()); let resize_x = side.opposite().side_x(panel_rect); let mouse_over_resize_line = we_are_on_top @@ -688,7 +688,7 @@ impl TopBottomPanel { let we_are_on_top = ui .ctx() .layer_id_at(pointer) - .map_or(true, |top_layer_id| top_layer_id == ui.layer_id()); + .map_or(true, |top_layer_id| top_layer_id == ui.area_layer_id()); let resize_y = side.opposite().side_y(panel_rect); let mouse_over_resize_line = we_are_on_top diff --git a/crates/egui/src/painter.rs b/crates/egui/src/painter.rs index 3f9b5a00..7c83fe88 100644 --- a/crates/egui/src/painter.rs +++ b/crates/egui/src/painter.rs @@ -20,7 +20,7 @@ pub struct Painter { ctx: Context, /// Where we paint - layer: ZLayer, + zlayer: ZLayer, /// Everything painted in this [`Painter`] will be clipped against this. /// This means nothing outside of this rectangle will be visible on screen. @@ -36,7 +36,7 @@ impl Painter { pub fn new(ctx: Context, area_layer: AreaLayerId, clip_rect: Rect) -> Self { Self { ctx, - layer: ZLayer::from_area_layer(area_layer), + zlayer: ZLayer::from_area_layer(area_layer), clip_rect, fade_to_color: None, } @@ -44,10 +44,10 @@ impl Painter { /// Redirect where you are painting. #[must_use] - pub fn with_layer(self, layer: ZLayer) -> Self { + pub fn with_layer(self, zlayer: ZLayer) -> Self { Self { ctx: self.ctx, - layer, + zlayer: zlayer, clip_rect: self.clip_rect, fade_to_color: None, } @@ -62,7 +62,7 @@ impl Painter { /// Redirect z-index #[must_use] pub fn with_z(self, z: ZOrder) -> Self { - let layer = self.layer.area_layer.with_z(z); + let layer = self.zlayer.area_layer.with_z(z); self.with_layer(layer) } @@ -73,7 +73,7 @@ impl Painter { pub fn with_clip_rect(&self, rect: Rect) -> Self { Self { ctx: self.ctx.clone(), - layer: self.layer, + zlayer: self.zlayer, clip_rect: rect.intersect(self.clip_rect), fade_to_color: self.fade_to_color, } @@ -81,17 +81,17 @@ impl Painter { /// Redirect what area layer you are painting. pub fn set_layer_id(&mut self, area_layer: AreaLayerId) { - self.layer.area_layer = area_layer; + self.zlayer.area_layer = area_layer; } /// Redirect at what z order you are drawing pub fn set_z(&mut self, z: ZOrder) { - self.layer.z = z; + self.zlayer.z = z; } /// Redirect where you are drawing pub fn set_layer(&mut self, layer: ZLayer) { - self.layer = layer; + self.zlayer = layer; } /// If set, colors will be modified to look like this @@ -112,7 +112,7 @@ impl Painter { pub fn sub_region(&self, rect: Rect) -> Self { Self { ctx: self.ctx.clone(), - layer: self.layer, + zlayer: self.zlayer, clip_rect: rect.intersect(self.clip_rect), fade_to_color: self.fade_to_color, } @@ -137,19 +137,19 @@ impl Painter { /// Where we paint #[inline(always)] - pub fn layer(&self) -> AreaLayerId { - self.layer.area_layer + pub fn area_layer_id(&self) -> AreaLayerId { + self.zlayer.area_layer } /// Where we paint, and on what Z-level #[inline(always)] pub fn zlayer(&self) -> ZLayer { - self.layer + self.zlayer } #[inline(always)] pub fn z(&self) -> ZOrder { - self.layer.z + self.zlayer.z } /// Everything painted in this [`Painter`] will be clipped against this. @@ -189,7 +189,7 @@ impl Painter { impl Painter { fn paint_list(&self, writer: impl FnOnce(&mut PaintList) -> R) -> R { self.ctx - .graphics_mut(|g| writer(g.list(self.layer.area_layer))) + .graphics_mut(|g| writer(g.list(self.zlayer.area_layer))) } fn transform_shape(&self, shape: &mut Shape) { @@ -199,11 +199,11 @@ impl Painter { } fn add_to_paint_list(&self, shape: Shape) -> ShapeIdx { - self.paint_list(|l| l.add_at_z(self.clip_rect, shape, self.layer.z)) + self.paint_list(|l| l.add_at_z(self.clip_rect, shape, self.zlayer.z)) } fn extend_paint_list(&self, shapes: impl IntoIterator) { - self.paint_list(|l| l.extend_at_z(self.clip_rect, shapes, self.layer.z)); + self.paint_list(|l| l.extend_at_z(self.clip_rect, shapes, self.zlayer.z)); } fn set_shape_in_paint_list(&self, idx: ShapeIdx, shape: Shape) { diff --git a/crates/egui/src/ui.rs b/crates/egui/src/ui.rs index e7b3ed16..a318a500 100644 --- a/crates/egui/src/ui.rs +++ b/crates/egui/src/ui.rs @@ -316,8 +316,14 @@ impl Ui { /// Use this to paint stuff within this [`Ui`]. #[inline] + pub fn area_layer_id(&self) -> AreaLayerId { + self.painter().area_layer_id() + } + + #[deprecated = "Rename area_layer_id"] + #[inline] pub fn layer_id(&self) -> AreaLayerId { - self.painter().layer() + self.area_layer_id() } #[inline] @@ -647,8 +653,14 @@ impl Ui { id: Id, sense: Sense, ) -> Response { - self.ctx() - .interact_with_hovered(self.layer_id(), id, rect, sense, self.enabled, hovered) + self.ctx().interact_with_hovered( + self.area_layer_id(), + id, + rect, + sense, + self.enabled, + hovered, + ) } /// Is the pointer (mouse/touch) above this rectangle in this [`Ui`]? @@ -657,7 +669,7 @@ impl Ui { /// if this [`Ui`] is behind some other window, this will always return `false`. pub fn rect_contains_pointer(&self, rect: Rect) -> bool { self.ctx() - .rect_contains_pointer(self.layer_id(), self.clip_rect().intersect(rect)) + .rect_contains_pointer(self.area_layer_id(), self.clip_rect().intersect(rect)) } /// Is the pointer (mouse/touch) above this [`Ui`]? @@ -953,7 +965,7 @@ impl Ui { pub fn allocate_painter(&mut self, desired_size: Vec2, sense: Sense) -> (Response, Painter) { let response = self.allocate_response(desired_size, sense); let clip_rect = self.clip_rect().intersect(response.rect); // Make sure we don't paint out of bounds - let painter = Painter::new(self.ctx().clone(), self.layer_id(), clip_rect); + let painter = Painter::new(self.ctx().clone(), self.area_layer_id(), clip_rect); (response, painter) } diff --git a/crates/egui_demo_app/src/apps/fractal_clock.rs b/crates/egui_demo_app/src/apps/fractal_clock.rs index 6afe6f04..c9b59e89 100644 --- a/crates/egui_demo_app/src/apps/fractal_clock.rs +++ b/crates/egui_demo_app/src/apps/fractal_clock.rs @@ -41,7 +41,7 @@ impl FractalClock { let painter = Painter::new( ui.ctx().clone(), - ui.layer_id(), + ui.area_layer_id(), ui.available_rect_before_wrap(), ); self.paint(&painter);