script/dom/
touch.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::f64::consts::PI;
6
7use dom_struct::dom_struct;
8use euclid::Point2D;
9
10use crate::dom::bindings::codegen::Bindings::TouchBinding::TouchMethods;
11use crate::dom::bindings::num::Finite;
12use crate::dom::bindings::reflector::{Reflector, reflect_dom_object};
13use crate::dom::bindings::root::{DomRoot, MutDom};
14use crate::dom::event::{EventBubbles, EventCancelable};
15use crate::dom::eventtarget::EventTarget;
16use crate::dom::pointerevent::PointerEvent;
17use crate::dom::window::Window;
18use crate::script_runtime::CanGc;
19
20#[dom_struct]
21pub(crate) struct Touch {
22    reflector_: Reflector,
23    identifier: i32,
24    target: MutDom<EventTarget>,
25    screen_x: f64,
26    screen_y: f64,
27    client_x: f64,
28    client_y: f64,
29    page_x: f64,
30    page_y: f64,
31}
32
33impl Touch {
34    #[allow(clippy::too_many_arguments)]
35    fn new_inherited(
36        identifier: i32,
37        target: &EventTarget,
38        screen_x: Finite<f64>,
39        screen_y: Finite<f64>,
40        client_x: Finite<f64>,
41        client_y: Finite<f64>,
42        page_x: Finite<f64>,
43        page_y: Finite<f64>,
44    ) -> Touch {
45        Touch {
46            reflector_: Reflector::new(),
47            identifier,
48            target: MutDom::new(target),
49            screen_x: *screen_x,
50            screen_y: *screen_y,
51            client_x: *client_x,
52            client_y: *client_y,
53            page_x: *page_x,
54            page_y: *page_y,
55        }
56    }
57
58    #[allow(clippy::too_many_arguments)]
59    pub(crate) fn new(
60        window: &Window,
61        identifier: i32,
62        target: &EventTarget,
63        screen_x: Finite<f64>,
64        screen_y: Finite<f64>,
65        client_x: Finite<f64>,
66        client_y: Finite<f64>,
67        page_x: Finite<f64>,
68        page_y: Finite<f64>,
69        can_gc: CanGc,
70    ) -> DomRoot<Touch> {
71        reflect_dom_object(
72            Box::new(Touch::new_inherited(
73                identifier, target, screen_x, screen_y, client_x, client_y, page_x, page_y,
74            )),
75            window,
76            can_gc,
77        )
78    }
79
80    /// Create a PointerEvent from this Touch.
81    /// <https://w3c.github.io/pointerevents/#the-primary-pointer>
82    #[allow(clippy::too_many_arguments)]
83    pub(crate) fn to_pointer_event(
84        &self,
85        window: &Window,
86        event_type: &str,
87        pointer_id: i32,
88        is_primary: bool,
89        modifiers: keyboard_types::Modifiers,
90        is_cancelable: bool,
91        point_in_node: Option<euclid::Point2D<f32, style_traits::CSSPixel>>,
92        can_gc: CanGc,
93    ) -> DomRoot<PointerEvent> {
94        // Pressure is 0.5 for active touches, 0.0 for up/cancel/out/leave
95        // <https://w3c.github.io/pointerevents/#dom-pointerevent-pressure>
96        // TODO: add proper force support.
97        let pressure = if event_type == "pointerup" ||
98            event_type == "pointercancel" ||
99            event_type == "pointerout" ||
100            event_type == "pointerleave"
101        {
102            0.0
103        } else {
104            0.5
105        };
106
107        // <https://w3c.github.io/pointerevents/#the-button-property>
108        // For pointermove, pointerover, pointerenter, pointerout, pointerleave: button is -1
109        // For pointerdown, pointerup, pointercancel: button is 0 (primary button)
110        let button = if event_type == "pointermove" ||
111            event_type == "pointerover" ||
112            event_type == "pointerenter" ||
113            event_type == "pointerout" ||
114            event_type == "pointerleave"
115        {
116            -1
117        } else {
118            0
119        };
120
121        // Buttons: 1 if a button is pressed during the event, 0 otherwise
122        // For touch: button is pressed during over/enter/down/move, not during up/cancel/out/leave
123        let buttons = if event_type == "pointermove" ||
124            event_type == "pointerover" ||
125            event_type == "pointerenter" ||
126            event_type == "pointerdown"
127        {
128            1
129        } else {
130            0
131        };
132
133        // For enter/leave events, they don't bubble and are not cancelable
134        let (bubbles, cancelable) = match event_type {
135            "pointerenter" | "pointerleave" => {
136                (EventBubbles::DoesNotBubble, EventCancelable::NotCancelable)
137            },
138            _ => (EventBubbles::Bubbles, EventCancelable::from(is_cancelable)),
139        };
140
141        PointerEvent::new(
142            window,
143            event_type.into(),
144            bubbles,
145            cancelable,
146            Some(window),
147            0, // detail
148            Point2D::new(*self.ScreenX() as i32, *self.ScreenY() as i32),
149            Point2D::new(*self.ClientX() as i32, *self.ClientY() as i32),
150            Point2D::new(*self.PageX() as i32, *self.PageY() as i32),
151            modifiers,
152            button,
153            buttons,
154            None, // related_target
155            point_in_node,
156            pointer_id,
157            1, // width (TODO: could get from touch if available)
158            1, // height (TODO: could get from touch if available)
159            pressure,
160            0.0,      // tangential_pressure
161            0,        // tilt_x
162            0,        // tilt_y
163            0,        // twist
164            PI / 2.0, // altitude_angle (perpendicular to surface)
165            0.0,      // azimuth_angle
166            "touch".into(),
167            is_primary,
168            vec![], // coalesced_events
169            vec![], // predicted_events
170            can_gc,
171        )
172    }
173}
174
175impl TouchMethods<crate::DomTypeHolder> for Touch {
176    /// <https://w3c.github.io/touch-events/#widl-Touch-identifier>
177    fn Identifier(&self) -> i32 {
178        self.identifier
179    }
180
181    /// <https://w3c.github.io/touch-events/#widl-Touch-target>
182    fn Target(&self) -> DomRoot<EventTarget> {
183        self.target.get()
184    }
185
186    /// <https://w3c.github.io/touch-events/#widl-Touch-screenX>
187    fn ScreenX(&self) -> Finite<f64> {
188        Finite::wrap(self.screen_x)
189    }
190
191    /// <https://w3c.github.io/touch-events/#widl-Touch-screenY>
192    fn ScreenY(&self) -> Finite<f64> {
193        Finite::wrap(self.screen_y)
194    }
195
196    /// <https://w3c.github.io/touch-events/#widl-Touch-clientX>
197    fn ClientX(&self) -> Finite<f64> {
198        Finite::wrap(self.client_x)
199    }
200
201    /// <https://w3c.github.io/touch-events/#widl-Touch-clientY>
202    fn ClientY(&self) -> Finite<f64> {
203        Finite::wrap(self.client_y)
204    }
205
206    /// <https://w3c.github.io/touch-events/#widl-Touch-clientX>
207    fn PageX(&self) -> Finite<f64> {
208        Finite::wrap(self.page_x)
209    }
210
211    /// <https://w3c.github.io/touch-events/#widl-Touch-clientY>
212    fn PageY(&self) -> Finite<f64> {
213        Finite::wrap(self.page_y)
214    }
215}
script/dom/touch.rs

script/dom/
touch.rs
