wgui: refresh widgets with dirty tree state

This commit is contained in:
Aleksander
2025-11-15 11:46:34 +01:00
parent 5ce745d2b9
commit 127cb5c8d0
6 changed files with 133 additions and 77 deletions

View File

@@ -91,7 +91,9 @@ impl ComponentTrait for ComponentButton {
&mut self.base &mut self.base
} }
fn refresh(&self, _data: &mut RefreshData) {} fn refresh(&self, _data: &mut RefreshData) {
// nothing to do
}
} }
impl ComponentButton { impl ComponentButton {

View File

@@ -76,7 +76,9 @@ impl ComponentTrait for ComponentCheckbox {
&mut self.base &mut self.base
} }
fn refresh(&self, _data: &mut RefreshData) {} fn refresh(&self, _data: &mut RefreshData) {
// nothing to do
}
} }
const COLOR_CHECKED: Color = Color::new(0.1, 0.5, 1.0, 1.0); const COLOR_CHECKED: Color = Color::new(0.1, 0.5, 1.0, 1.0);

View File

@@ -142,15 +142,24 @@ fn get_width(slider_body_node: taffy::NodeId, tree: &taffy::tree::TaffyTree<Widg
fn conf_handle_style( fn conf_handle_style(
values: &ValuesMinMax, values: &ValuesMinMax,
slider_body_node: taffy::NodeId, slider_body_node: taffy::NodeId,
slider_handle_style: &mut taffy::Style, slider_handle_style: &taffy::Style,
tree: &taffy::tree::TaffyTree<WidgetID>, tree: &taffy::tree::TaffyTree<WidgetID>,
) { ) -> Option<taffy::Style> {
let norm = values.to_normalized(); let norm = values.to_normalized();
// convert normalized value to taffy percentage margin in percent // convert normalized value to taffy percentage margin in percent
let width = get_width(slider_body_node, tree); let width = get_width(slider_body_node, tree);
let percent_margin = (HANDLE_WIDTH / width) / 2.0; let percent_margin = (HANDLE_WIDTH / width) / 2.0;
slider_handle_style.margin.left = percent(percent_margin + norm * (1.0 - percent_margin * 2.0));
let new_percent = percent(percent_margin + norm * (1.0 - percent_margin * 2.0));
if slider_handle_style.margin.left == new_percent {
None // nothing changed
} else {
let mut new_style = slider_handle_style.clone();
new_style.margin.left = new_percent;
Some(new_style)
}
} }
const PAD_PERCENT: f32 = 0.75; const PAD_PERCENT: f32 = 0.75;
@@ -196,11 +205,14 @@ impl State {
self.values.set_value(value); self.values.set_value(value);
let changed = self.values.value != before; let changed = self.values.value != before;
let mut style = common.state.tree.style(data.slider_handle_node_id).unwrap().clone(); let style = common.state.tree.style(data.slider_handle_node_id).unwrap();
conf_handle_style(&self.values, data.slider_body_node, &mut style, &common.state.tree); let Some(new_style) = conf_handle_style(&self.values, data.slider_body_node, style, &common.state.tree) else {
return; //nothing changed visually
};
common.alterables.mark_dirty(data.slider_handle_node_id); common.alterables.mark_dirty(data.slider_handle_node_id);
common.alterables.mark_redraw(); common.alterables.mark_redraw();
common.alterables.set_style(data.slider_handle.id, style); common.alterables.set_style(data.slider_handle.id, new_style);
if let Some(mut label) = common.state.widgets.get_as::<WidgetLabel>(data.slider_text_id) { if let Some(mut label) = common.state.widgets.get_as::<WidgetLabel>(data.slider_text_id) {
Self::update_text(common, &mut label, self.values.value); Self::update_text(common, &mut label, self.values.value);
@@ -482,6 +494,6 @@ pub fn construct(ess: &mut ConstructEssentials, params: Params) -> anyhow::Resul
let slider = Rc::new(ComponentSlider { base, data, state }); let slider = Rc::new(ComponentSlider { base, data, state });
ess.layout.defer_component_refresh(Component(slider.clone())); ess.layout.register_component_refresh(Component(slider.clone()));
Ok((root, slider)) Ok((root, slider))
} }

View File

@@ -73,7 +73,9 @@ impl ComponentTrait for ComponentTooltip {
&self.base &self.base
} }
fn refresh(&self, _data: &mut RefreshData) {} fn refresh(&self, _data: &mut RefreshData) {
// nothing to do
}
} }
impl ComponentTooltip {} impl ComponentTooltip {}

View File

@@ -1,6 +1,6 @@
use std::{ use std::{
cell::{RefCell, RefMut}, cell::{RefCell, RefMut},
collections::VecDeque, collections::{HashMap, VecDeque},
io::Write, io::Write,
rc::{Rc, Weak}, rc::{Rc, Weak},
}; };
@@ -139,7 +139,8 @@ pub struct Layout {
pub tasks: LayoutTasks, pub tasks: LayoutTasks,
components_to_refresh: Vec<Component>, components_to_refresh_once: Vec<Component>,
registered_components_to_refresh: HashMap<taffy::NodeId, Component>,
pub widgets_to_tick: Vec<WidgetID>, pub widgets_to_tick: Vec<WidgetID>,
@@ -281,6 +282,7 @@ impl Layout {
self.state.widgets.remove_single(widget_id); self.state.widgets.remove_single(widget_id);
self.state.nodes.remove(widget_id); self.state.nodes.remove(widget_id);
if let Some(node_id) = node_id { if let Some(node_id) = node_id {
self.registered_components_to_refresh.remove(&node_id);
let _ = self.state.tree.remove(node_id); let _ = self.state.tree.remove(node_id);
} }
} }
@@ -312,7 +314,7 @@ impl Layout {
} }
fn process_pending_components(&mut self, alterables: &mut EventAlterables) { fn process_pending_components(&mut self, alterables: &mut EventAlterables) {
for comp in &self.components_to_refresh { for comp in &self.components_to_refresh_once {
let mut common = CallbackDataCommon { let mut common = CallbackDataCommon {
state: &self.state, state: &self.state,
alterables, alterables,
@@ -324,7 +326,7 @@ impl Layout {
comp.0.refresh(&mut RefreshData { common: &mut common }); comp.0.refresh(&mut RefreshData { common: &mut common });
} }
self.components_to_refresh.clear(); self.components_to_refresh_once.clear();
} }
fn process_pending_widget_ticks(&mut self, alterables: &mut EventAlterables) { fn process_pending_widget_ticks(&mut self, alterables: &mut EventAlterables) {
@@ -338,8 +340,20 @@ impl Layout {
self.widgets_to_tick.clear(); self.widgets_to_tick.clear();
} }
// call ComponentTrait::refresh() once
pub fn defer_component_refresh(&mut self, component: Component) { pub fn defer_component_refresh(&mut self, component: Component) {
self.components_to_refresh.push(component); self.components_to_refresh_once.push(component);
}
// call ComponentTrait::refresh() every time the layout is dirty
pub fn register_component_refresh(&mut self, component: Component) {
let widget_id = component.0.base().get_id();
let Some(node_id) = self.state.nodes.get(widget_id) else {
debug_assert!(false);
return;
};
self.registered_components_to_refresh.insert(*node_id, component);
} }
/// Convenience function to avoid repeated `WidgetID` → `WidgetState` lookups. /// Convenience function to avoid repeated `WidgetID` → `WidgetState` lookups.
@@ -557,22 +571,48 @@ impl Layout {
needs_redraw: true, needs_redraw: true,
haptics_triggered: false, haptics_triggered: false,
animations: Animations::default(), animations: Animations::default(),
components_to_refresh: Vec::new(), components_to_refresh_once: Vec::new(),
registered_components_to_refresh: HashMap::new(),
widgets_to_tick: Vec::new(), widgets_to_tick: Vec::new(),
tasks: LayoutTasks::new(), tasks: LayoutTasks::new(),
}) })
} }
fn refresh_recursively(&self, node_id: taffy::NodeId, to_refresh: &mut Vec<Component>) {
// skip refreshing clean nodes
if !self.state.tree.dirty(node_id).unwrap() {
return;
}
if let Some(component) = self.registered_components_to_refresh.get(&node_id) {
to_refresh.push(component.clone());
}
for child_id in self.state.tree.child_ids(node_id) {
self.refresh_recursively(child_id, to_refresh);
}
}
fn try_recompute_layout(&mut self, size: Vec2) -> anyhow::Result<()> { fn try_recompute_layout(&mut self, size: Vec2) -> anyhow::Result<()> {
if !self.state.tree.dirty(self.tree_root_node)? && self.prev_size == size { if !self.state.tree.dirty(self.tree_root_node)? && self.prev_size == size {
// Nothing to do // Nothing to do
return Ok(()); return Ok(());
} }
self.mark_redraw();
log::debug!("re-computing layout, size {}x{}", size.x, size.y); log::debug!("re-computing layout, size {}x{}", size.x, size.y);
self.mark_redraw();
self.prev_size = size; self.prev_size = size;
let mut to_refresh = Vec::<Component>::new();
self.refresh_recursively(self.tree_root_node, &mut to_refresh);
if !to_refresh.is_empty() {
log::debug!("refreshing {} registered widgets", to_refresh.len());
for c in &to_refresh {
self.components_to_refresh_once.push(c.clone());
}
}
let globals = self.state.globals.get(); let globals = self.state.globals.get();
self.state.tree.compute_layout_with_measure( self.state.tree.compute_layout_with_measure(
@@ -686,10 +726,10 @@ impl Layout {
} }
for (widget_id, style) in alterables.style_set_requests { for (widget_id, style) in alterables.style_set_requests {
if let Some(node_id) = self.state.nodes.get(widget_id) { if let Some(node_id) = self.state.nodes.get(widget_id)
if let Err(e) = self.state.tree.set_style(*node_id, style) { && let Err(e) = self.state.tree.set_style(*node_id, style)
log::error!("failed to set style for taffy widget ID {node_id:?}: {e:?}"); {
} log::error!("failed to set style for taffy widget ID {node_id:?}: {e:?}");
} }
} }

View File

@@ -11,8 +11,7 @@ use slotmap::Key;
use wgui::{ use wgui::{
components::{checkbox::ComponentCheckbox, slider::ComponentSlider}, components::{checkbox::ComponentCheckbox, slider::ComponentSlider},
event::{CallbackDataCommon, EventAlterables, EventCallback}, event::{CallbackDataCommon, EventAlterables, EventCallback},
layout::Layout, parser::Fetchable,
parser::{CustomAttribsInfoOwned, Fetchable},
widget::EventResult, widget::EventResult,
}; };
@@ -20,16 +19,16 @@ use wgui::{
use crate::{backend::task::TaskType, windowing::OverlaySelector}; use crate::{backend::task::TaskType, windowing::OverlaySelector};
use crate::{ use crate::{
backend::{input::HoverResult, task::TaskContainer}, backend::{input::HoverResult, task::TaskContainer},
gui::panel::{button::BUTTON_EVENTS, GuiPanel, NewGuiPanelParams}, gui::panel::{GuiPanel, NewGuiPanelParams, OnCustomAttribFunc, button::BUTTON_EVENTS},
overlays::edit::{ overlays::edit::{
lock::InteractLockHandler, pos::PositioningHandler, tab::ButtonPaneTabSwitcher, lock::InteractLockHandler, pos::PositioningHandler, tab::ButtonPaneTabSwitcher,
}, },
state::AppState, state::AppState,
subsystem::hid::WheelDelta, subsystem::hid::WheelDelta,
windowing::{ windowing::{
OverlayID,
backend::{DummyBackend, OverlayBackend, RenderResources, ShouldRender}, backend::{DummyBackend, OverlayBackend, RenderResources, ShouldRender},
window::OverlayWindowConfig, window::OverlayWindowConfig,
OverlayID,
}, },
}; };
@@ -222,65 +221,64 @@ fn make_edit_panel(app: &mut AppState) -> anyhow::Result<EditModeWrapPanel> {
pos: PositioningHandler::default(), pos: PositioningHandler::default(),
}; };
let on_custom_attrib: Box<dyn Fn(&mut Layout, &CustomAttribsInfoOwned, &AppState)> = let on_custom_attrib: OnCustomAttribFunc = Box::new(move |layout, attribs, _app| {
Box::new(move |layout, attribs, _app| { for (name, kind) in &BUTTON_EVENTS {
for (name, kind) in &BUTTON_EVENTS { let Some(action) = attribs.get_value(name) else {
let Some(action) = attribs.get_value(name) else { continue;
continue; };
};
let mut args = action.split_whitespace(); let mut args = action.split_whitespace();
let Some(command) = args.next() else { let Some(command) = args.next() else {
continue; continue;
}; };
let callback: EventCallback<AppState, EditModeState> = match command { let callback: EventCallback<AppState, EditModeState> = match command {
"::EditModeToggleLock" => Box::new(move |common, _data, app, state| { "::EditModeToggleLock" => Box::new(move |common, _data, app, state| {
let sel = OverlaySelector::Id(*state.id.borrow());
let task = state.lock.toggle(common, app);
app.tasks.enqueue(TaskType::Overlay(sel, task));
Ok(EventResult::Consumed)
}),
"::EditModeTab" => {
let tab_name = args.next().unwrap().to_owned();
Box::new(move |common, _data, _app, state| {
state.tabs.tab_button_clicked(common, &tab_name);
Ok(EventResult::Consumed)
})
}
"::EditModeSetPos" => {
let pos_key = args.next().unwrap().to_owned();
Box::new(move |common, _data, app, state| {
let sel = OverlaySelector::Id(*state.id.borrow()); let sel = OverlaySelector::Id(*state.id.borrow());
let task = state.lock.toggle(common, app); let task = state.pos.pos_button_clicked(common, &pos_key);
app.tasks.enqueue(TaskType::Overlay(sel, task)); app.tasks.enqueue(TaskType::Overlay(sel, task));
Ok(EventResult::Consumed) Ok(EventResult::Consumed)
}), })
"::EditModeTab" => { }
let tab_name = args.next().unwrap().to_owned(); "::EditModeDeletePress" => Box::new(move |_common, _data, _app, state| {
Box::new(move |common, _data, _app, state| { state.delete.pressed = Instant::now();
state.tabs.tab_button_clicked(common, &tab_name); // TODO: animate to light up button after 2s
Ok(EventResult::Consumed) Ok(EventResult::Consumed)
}) }),
"::EditModeDeleteRelease" => Box::new(move |_common, _data, app, state| {
if state.delete.pressed.elapsed() > Duration::from_secs(2) {
return Ok(EventResult::Pass);
} }
"::EditModeSetPos" => { app.tasks.enqueue(TaskType::Overlay(
let pos_key = args.next().unwrap().to_owned(); OverlaySelector::Id(*state.id.borrow()),
Box::new(move |common, _data, app, state| { Box::new(move |_app, owc| {
let sel = OverlaySelector::Id(*state.id.borrow()); owc.active_state = None;
let task = state.pos.pos_button_clicked(common, &pos_key); }),
app.tasks.enqueue(TaskType::Overlay(sel, task)); ));
Ok(EventResult::Consumed) Ok(EventResult::Consumed)
}) }),
} _ => return,
"::EditModeDeletePress" => Box::new(move |_common, _data, _app, state| { };
state.delete.pressed = Instant::now();
// TODO: animate to light up button after 2s
Ok(EventResult::Consumed)
}),
"::EditModeDeleteRelease" => Box::new(move |_common, _data, app, state| {
if state.delete.pressed.elapsed() > Duration::from_secs(2) {
return Ok(EventResult::Pass);
}
app.tasks.enqueue(TaskType::Overlay(
OverlaySelector::Id(*state.id.borrow()),
Box::new(move |_app, owc| {
owc.active_state = None;
}),
));
Ok(EventResult::Consumed)
}),
_ => return,
};
let id = layout.add_event_listener(attribs.widget_id, *kind, callback); let id = layout.add_event_listener(attribs.widget_id, *kind, callback);
log::debug!("Registered {action} on {:?} as {id:?}", attribs.widget_id); log::debug!("Registered {action} on {:?} as {id:?}", attribs.widget_id);
} }
}); });
let mut panel = GuiPanel::new_from_template( let mut panel = GuiPanel::new_from_template(
app, app,