freya-elements 0.3.4

Internal elements, attributes and events designed for Freya.
Documentation 
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

use torin::geometry::CursorPoint;
pub use winit::event::{
    Force,
    TouchPhase,
};

use crate::{
    events::ErasedEventData,
    impl_event,
};

impl_event! [
    TouchData;

    /// The `touchcancel` event fires when the user cancels the touching, this is usually caused by the hardware or the OS.
    /// Also see [`ontouchend`](crate::events::ontouchend()).
    ///
    /// Event Data: [`TouchData`](crate::events::TouchData)
    ///
    /// ### Example
    ///
    /// ```rust, no_run
    /// # use freya::prelude::*;
    /// fn app() -> Element {
    ///     rsx!(
    ///         rect {
    ///             width: "100",
    ///             height: "100",
    ///             background: "red",
    ///             ontouchcancel: |_| println!("Touching canceled!")
    ///         }
    ///     )
    /// }
    /// ```
    ontouchcancel

    /// The `touchend` event fires when the user stops touching an element.
    ///
    /// Event Data: [`TouchData`](crate::events::TouchData)
    ///
    /// ### Example
    ///
    /// ```rust, no_run
    /// # use freya::prelude::*;
    /// fn app() -> Element {
    ///     rsx!(
    ///         rect {
    ///             width: "100",
    ///             height: "100",
    ///             background: "red",
    ///             ontouchend: |_| println!("Stopped touching!")
    ///         }
    ///     )
    /// }
    /// ```
    ontouchend

    /// The `touchmove` event fires when the user is touching over an element.
    ///
    /// Event Data: [`TouchData`](crate::events::TouchData)
    ///
    /// ### Example
    ///
    /// ```rust, no_run
    /// # use freya::prelude::*;
    /// fn app() -> Element {
    ///     rsx!(
    ///         rect {
    ///             width: "100",
    ///             height: "100",
    ///             background: "red",
    ///             ontouchmove: |_| println!("Touching!")
    ///         }
    ///     )
    /// }
    /// ```
    ontouchmove

    /// The `touchstart` event fires when the user starts touching an element.
    ///
    /// Event Data: [`TouchData`](crate::events::TouchData)
    ///
    /// ### Example
    ///
    /// ```rust, no_run
    /// # use freya::prelude::*;
    /// fn app() -> Element {
    ///     rsx!(
    ///         rect {
    ///             width: "100",
    ///             height: "100",
    ///             background: "red",
    ///             ontouchstart: |_| println!("Started touching!")
    ///         }
    ///     )
    /// }
    /// ```
    ontouchstart
];

/// Data of a Touch event.
#[derive(Debug, Clone, PartialEq)]
pub struct TouchData {
    pub screen_coordinates: CursorPoint,
    pub element_coordinates: CursorPoint,
    pub finger_id: u64,
    pub phase: TouchPhase,
    pub force: Option<Force>,
}

impl TouchData {
    pub fn new(
        screen_coordinates: CursorPoint,
        element_coordinates: CursorPoint,
        finger_id: u64,
        phase: TouchPhase,
        force: Option<Force>,
    ) -> Self {
        Self {
            screen_coordinates,
            element_coordinates,
            finger_id,
            phase,
            force,
        }
    }

    /// Get the touch coordinates relative to the window bounds.
    pub fn get_screen_coordinates(&self) -> CursorPoint {
        self.screen_coordinates
    }

    /// Get the touch coordinates relatives to the element bounds.
    pub fn get_element_coordinates(&self) -> CursorPoint {
        self.element_coordinates
    }

    /// Get the finger that triggered this event.
    pub fn get_finger_id(&self) -> u64 {
        self.finger_id
    }

    /// Get the touch phase of this event.
    pub fn get_touch_phase(&self) -> TouchPhase {
        self.phase
    }

    /// Get the touch force of this event.
    pub fn get_touch_force(&self) -> Option<Force> {
        self.force
    }
}

impl From<&ErasedEventData> for TouchData {
    fn from(val: &ErasedEventData) -> Self {
        val.downcast::<TouchData>().cloned().unwrap()
    }
}