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
use torin::geometry::CursorPoint;
pub use winit::event::MouseButton;
use winit::event::{
Force,
TouchPhase,
};
use crate::{
events::ErasedEventData,
impl_event,
};
impl_event! [
PointerData;
/// The `pointerdown` event fires when the user clicks/starts touching an element.
///
/// Event Data: [`PointerData`](crate::events::PointerData)
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// onpointerdown: |_| println!("Clicked/started pressing!")
/// }
/// )
/// }
/// ```
onpointerdown
/// The `pointerup` event fires when the user releases their mouse button or stops touching the element.
///
/// Event Data: [`PointerData`](crate::events::PointerData)
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// onpointerup: |_| println!("Released mouse button, or no longer touching!")
/// }
/// )
/// }
/// ```
onpointerup
/// The `globalpointerup` event fires when the user releases the point anywhere in the app.
///
/// Event Data: [`PointerData`](crate::events::PointerData)
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// onglobalpointerup: |_| println!("Pointer released somewhere else!")
/// }
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// onclick: |_| println!("Clicked!")
/// }
/// )
/// }
/// ```
onglobalpointerup
/// The `pointermove` event fires when the user moves the cursor or touches over an element.
/// Unlike [`onpointerenter`](crate::events::onpointerenter()), this fires even if the user was already hovering over
/// the element.
///
/// Event Data: [`PointerData`](crate::events::PointerData)
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// onpointermove: |_| println!("Moving or touching!")
/// }
/// )
/// }
/// ```
onpointermove
/// The `pointerenter` event fires when the user starts hovering/touching an element.
///
/// Event Data: [`PointerData`](crate::events::PointerData)
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// onpointerenter: |_| println!("Started hovering or touching!")
/// }
/// )
/// }
/// ```
onpointerenter
/// The `pointerleave` event fires when the user stops hovering/touching an element.
///
/// Event Data: [`PointerData`](crate::events::PointerData)
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// onpointerleave: |_| println!("Started hovering or touching!")
/// }
/// )
/// }
/// ```
onpointerleave
];
/// The type of device that triggered a Pointer event.
#[derive(Debug, Clone, PartialEq, Copy)]
pub enum PointerType {
Mouse {
trigger_button: Option<MouseButton>,
},
Touch {
finger_id: u64,
phase: TouchPhase,
force: Option<Force>,
},
}
/// Data of a Mouse event.
#[derive(Debug, Clone, PartialEq)]
pub struct PointerData {
pub screen_coordinates: CursorPoint,
pub element_coordinates: CursorPoint,
pub pointer_type: PointerType,
}
impl PointerData {
pub fn new(
screen_coordinates: CursorPoint,
element_coordinates: CursorPoint,
point_type: PointerType,
) -> Self {
Self {
screen_coordinates,
element_coordinates,
pointer_type: point_type,
}
}
}
impl PointerData {
/// Get the mouse coordinates relative to the window bounds.
pub fn get_screen_coordinates(&self) -> CursorPoint {
self.screen_coordinates
}
/// Get the mouse coordinates relatives to the element bounds.
pub fn get_element_coordinates(&self) -> CursorPoint {
self.element_coordinates
}
/// Get the pointer type that triggered this event.
pub fn get_pointer_type(&self) -> PointerType {
self.pointer_type
}
}
impl From<&ErasedEventData> for PointerData {
fn from(val: &ErasedEventData) -> Self {
val.downcast::<PointerData>().cloned().unwrap()
}
}