Tooltips, minor changes

wgui/src/components/tooltip.rs

@@ -1,29 +1,50 @@
+use glam::{Mat4, Vec3};
 use std::{cell::RefCell, rc::Rc};
 use taffy::prelude::length;
 
 use crate::{
-	components::{Component, ComponentBase, ComponentTrait, InitData},
+	components::{self, Component, ComponentBase, ComponentTrait, InitData},
 	drawing::Color,
-	event::{EventListenerCollection, EventListenerKind},
 	i18n::Translation,
-	layout::{LayoutTasks, WidgetID, WidgetPair},
+	layout::{self, LayoutTask, LayoutTasks, WidgetID, WidgetPair},
 	renderer_vk::text::{FontWeight, TextStyle},
 	widget::{
+		ConstructEssentials,
+		div::WidgetDiv,
 		label::{WidgetLabel, WidgetLabelParams},
 		rectangle::{WidgetRectangle, WidgetRectangleParams},
 		util::WLength,
-		ConstructEssentials, EventResult,
 	},
 };
 
-pub struct Params {
+#[derive(Clone, Default)]
+pub enum TooltipSide {
+	Left,
+	Right,
+	Top,
+	#[default]
+	Bottom,
+}
+
+#[derive(Clone)]
+pub struct TooltipInfo {
 	pub text: Translation,
+	pub side: TooltipSide,
+}
+
+pub struct Params {
+	pub info: TooltipInfo,
+	pub widget_to_watch: WidgetID,
 }
 
 impl Default for Params {
 	fn default() -> Self {
 		Self {
-			text: Translation::from_raw_text(""),
+			info: TooltipInfo {
+				text: Translation::from_raw_text(""),
+				side: TooltipSide::Bottom,
+			},
+			widget_to_watch: WidgetID::default(),
 		}
 	}
 }
@@ -32,13 +53,13 @@ struct State {}
 
 #[allow(clippy::struct_field_names)]
 struct Data {
-	id_container: WidgetID, // Rectangle
-	id_label: WidgetID,     // Label, parent of container
+	id_root: WidgetID, // Rectangle
 }
 
 pub struct ComponentTooltip {
 	base: ComponentBase,
 	data: Rc<Data>,
+	#[allow(dead_code)]
 	state: Rc<RefCell<State>>,
 	tasks: LayoutTasks,
 }
@@ -53,61 +74,110 @@ impl ComponentTrait for ComponentTooltip {
 
 impl ComponentTooltip {}
 
-fn register_event_mouse_enter(listeners: &mut EventListenerCollection) -> crate::event::EventListenerID {
-	listeners.register(
-		EventListenerKind::MouseEnter,
-		Box::new(move |common, _event_data, (), ()| {
-			common.alterables.trigger_haptics();
-			Ok(EventResult::Pass)
-		}),
-	)
-}
-
-fn register_event_mouse_leave(listeners: &mut EventListenerCollection) -> crate::event::EventListenerID {
-	listeners.register(
-		EventListenerKind::MouseEnter,
-		Box::new(move |common, _event_data, (), ()| {
-			common.alterables.trigger_haptics();
-			Ok(EventResult::Pass)
-		}),
-	)
+impl Drop for ComponentTooltip {
+	fn drop(&mut self) {
+		self.tasks.push(LayoutTask::RemoveWidget(self.data.id_root));
+	}
 }
 
+#[allow(clippy::too_many_lines)]
 pub fn construct(ess: &mut ConstructEssentials, params: Params) -> anyhow::Result<(WidgetPair, Rc<ComponentTooltip>)> {
-	let style = taffy::Style {
-		align_items: Some(taffy::AlignItems::Center),
-		justify_content: Some(taffy::JustifyContent::Center),
-		gap: length(4.0),
-		padding: taffy::Rect {
-			left: length(8.0),
-			right: length(8.0),
-			top: length(4.0),
-			bottom: length(4.0),
-		},
-		..Default::default()
+	let absolute_boundary = {
+		let widget_to_watch = ess
+			.layout
+			.state
+			.widgets
+			.get(params.widget_to_watch)
+			.ok_or_else(|| anyhow::anyhow!("widget_to_watch is invalid"))?;
+		let widget_to_watch_state = widget_to_watch.state();
+		widget_to_watch_state.data.cached_absolute_boundary
+	};
+
+	let spacing = 8.0;
+
+	let transform = Mat4::from_translation(Vec3::new(-0.5, 0.0, 0.0));
+
+	let (pin_left, pin_top, pin_align_items, pin_justify_content) = match params.info.side {
+		TooltipSide::Left => (
+			absolute_boundary.left() - spacing,
+			absolute_boundary.top() + absolute_boundary.size.y / 2.0,
+			taffy::AlignItems::Center,
+			taffy::JustifyContent::End,
+		),
+		TooltipSide::Right => (
+			absolute_boundary.left() + absolute_boundary.size.x + spacing,
+			absolute_boundary.top() + absolute_boundary.size.y / 2.0,
+			taffy::AlignItems::Center,
+			taffy::JustifyContent::Start,
+		),
+		TooltipSide::Top => (
+			absolute_boundary.left() + absolute_boundary.size.x / 2.0,
+			absolute_boundary.top() - spacing,
+			taffy::AlignItems::End,
+			taffy::JustifyContent::Center,
+		),
+		TooltipSide::Bottom => (
+			absolute_boundary.left() + absolute_boundary.size.x / 2.0,
+			absolute_boundary.top() + absolute_boundary.size.y + spacing,
+			taffy::AlignItems::Baseline,
+			taffy::JustifyContent::Center,
+		),
 	};
 
 	let globals = ess.layout.state.globals.clone();
 
-	let (root, _) = ess.layout.add_child(
+	let (div, _) = ess.layout.add_child(
 		ess.parent,
-		WidgetRectangle::create(WidgetRectangleParams {
-			color: Color::new(1.0, 1.0, 1.0, 0.0),
-			border_color: Color::new(1.0, 1.0, 1.0, 0.0),
-			round: WLength::Units(5.0),
+		WidgetDiv::create(),
+		taffy::Style {
+			align_items: Some(pin_align_items),
+			justify_content: Some(pin_justify_content),
+			position: taffy::Position::Absolute,
+			margin: taffy::Rect {
+				left: length(pin_left),
+				top: length(pin_top),
+				bottom: length(0.0),
+				right: length(0.0),
+			},
+			/* important, to make it centered! */
+			size: taffy::Size {
+				width: length(0.0),
+				height: length(0.0),
+			},
 			..Default::default()
-		}),
-		style,
+		},
 	)?;
 
-	let id_container = root.id;
+	div.widget.state().data.transform = transform;
 
-	let (label, _node_label) = ess.layout.add_child(
-		id_container,
+	let (rect, _) = ess.layout.add_child(
+		div.id,
+		WidgetRectangle::create(WidgetRectangleParams {
+			color: Color::new(0.1, 0.1, 0.1, 0.8),
+			border_color: Color::new(0.3, 0.3, 0.3, 1.0),
+			border: 2.0,
+			round: WLength::Percent(1.0),
+			..Default::default()
+		}),
+		taffy::Style {
+			position: taffy::Position::Relative,
+			gap: length(4.0),
+			padding: taffy::Rect {
+				left: length(16.0),
+				right: length(16.0),
+				top: length(8.0),
+				bottom: length(8.0),
+			},
+			..Default::default()
+		},
+	)?;
+
+	let (_label, _) = ess.layout.add_child(
+		rect.id,
 		WidgetLabel::create(
 			&mut globals.get(),
 			WidgetLabelParams {
-				content: params.text,
+				content: params.info.text,
 				style: TextStyle {
 					weight: Some(FontWeight::Bold),
 					..Default::default()
@@ -117,22 +187,11 @@ pub fn construct(ess: &mut ConstructEssentials, params: Params) -> anyhow::Resul
 		Default::default(),
 	)?;
 
-	let data = Rc::new(Data {
-		id_container,
-		id_label: label.id,
-	});
+	let data = Rc::new(Data { id_root: div.id });
 
 	let state = Rc::new(RefCell::new(State {}));
 
-	let base = ComponentBase {
-		lhandles: {
-			let mut widget = ess.layout.state.widgets.get(id_container).unwrap().state();
-			vec![
-				register_event_mouse_enter(&mut widget.event_listeners),
-				register_event_mouse_leave(&mut widget.event_listeners),
-			]
-		},
-	};
+	let base = ComponentBase::default();
 
 	let tooltip = Rc::new(ComponentTooltip {
 		base,
@@ -142,5 +201,18 @@ pub fn construct(ess: &mut ConstructEssentials, params: Params) -> anyhow::Resul
 	});
 
 	ess.layout.defer_component_init(Component(tooltip.clone()));
-	Ok((root, tooltip))
+	Ok((div, tooltip))
+}
+
+pub fn show(
+	layout: &mut layout::Layout,
+	widget_to_watch: WidgetID,
+	info: TooltipInfo,
+) -> anyhow::Result<Rc<ComponentTooltip>> {
+	let parent = layout.tree_root_widget;
+	let (_, tooltip) = components::tooltip::construct(
+		&mut ConstructEssentials { layout, parent },
+		components::tooltip::Params { info, widget_to_watch },
+	)?;
+	Ok(tooltip)
 }