script/dom/webxr/
xrframe.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::cell::Cell;
6
7use dom_struct::dom_struct;
8use js::gc::CustomAutoRooterGuard;
9use js::typedarray::Float32Array;
10use webxr_api::{Frame, LayerId, SubImages};
11
12use crate::dom::bindings::codegen::Bindings::XRFrameBinding::XRFrameMethods;
13use crate::dom::bindings::error::Error;
14use crate::dom::bindings::inheritance::Castable;
15use crate::dom::bindings::num::Finite;
16use crate::dom::bindings::reflector::{DomGlobal, Reflector, reflect_dom_object};
17use crate::dom::bindings::root::{Dom, DomRoot};
18use crate::dom::window::Window;
19use crate::dom::xrhittestresult::XRHitTestResult;
20use crate::dom::xrhittestsource::XRHitTestSource;
21use crate::dom::xrjointpose::XRJointPose;
22use crate::dom::xrjointspace::XRJointSpace;
23use crate::dom::xrpose::XRPose;
24use crate::dom::xrreferencespace::XRReferenceSpace;
25use crate::dom::xrsession::{ApiPose, XRSession};
26use crate::dom::xrspace::XRSpace;
27use crate::dom::xrviewerpose::XRViewerPose;
28use crate::script_runtime::CanGc;
29
30#[dom_struct]
31pub(crate) struct XRFrame {
32    reflector_: Reflector,
33    session: Dom<XRSession>,
34    #[no_trace]
35    data: Frame,
36    active: Cell<bool>,
37    animation_frame: Cell<bool>,
38}
39
40impl XRFrame {
41    fn new_inherited(session: &XRSession, data: Frame) -> XRFrame {
42        XRFrame {
43            reflector_: Reflector::new(),
44            session: Dom::from_ref(session),
45            data,
46            active: Cell::new(false),
47            animation_frame: Cell::new(false),
48        }
49    }
50
51    pub(crate) fn new(
52        window: &Window,
53        session: &XRSession,
54        data: Frame,
55        can_gc: CanGc,
56    ) -> DomRoot<XRFrame> {
57        reflect_dom_object(
58            Box::new(XRFrame::new_inherited(session, data)),
59            window,
60            can_gc,
61        )
62    }
63
64    /// <https://immersive-web.github.io/webxr/#xrframe-active>
65    pub(crate) fn set_active(&self, active: bool) {
66        self.active.set(active);
67    }
68
69    /// <https://immersive-web.github.io/webxr/#xrframe-animationframe>
70    pub(crate) fn set_animation_frame(&self, animation_frame: bool) {
71        self.animation_frame.set(animation_frame);
72    }
73
74    pub(crate) fn get_pose(&self, space: &XRSpace) -> Option<ApiPose> {
75        space.get_pose(&self.data)
76    }
77
78    pub(crate) fn get_sub_images(&self, layer_id: LayerId) -> Option<&SubImages> {
79        self.data
80            .sub_images
81            .iter()
82            .find(|sub_images| sub_images.layer_id == layer_id)
83    }
84}
85
86impl XRFrameMethods<crate::DomTypeHolder> for XRFrame {
87    /// <https://immersive-web.github.io/webxr/#dom-xrframe-session>
88    fn Session(&self) -> DomRoot<XRSession> {
89        DomRoot::from_ref(&self.session)
90    }
91
92    /// <https://www.w3.org/TR/webxr/#dom-xrframe-predicteddisplaytime>
93    fn PredictedDisplayTime(&self) -> Finite<f64> {
94        // TODO: If inline, return the same value
95        // as the timestamp passed to XRFrameRequestCallback
96        Finite::new(self.data.predicted_display_time)
97            .expect("Failed to create predictedDisplayTime")
98    }
99
100    /// <https://immersive-web.github.io/webxr/#dom-xrframe-getviewerpose>
101    fn GetViewerPose(
102        &self,
103        reference: &XRReferenceSpace,
104        can_gc: CanGc,
105    ) -> Result<Option<DomRoot<XRViewerPose>>, Error> {
106        if self.session != reference.upcast::<XRSpace>().session() {
107            return Err(Error::InvalidState(None));
108        }
109
110        if !self.active.get() || !self.animation_frame.get() {
111            return Err(Error::InvalidState(None));
112        }
113
114        let to_base = if let Some(to_base) = reference.get_base_transform(&self.data) {
115            to_base
116        } else {
117            return Ok(None);
118        };
119        let viewer_pose = if let Some(pose) = self.data.pose.as_ref() {
120            pose
121        } else {
122            return Ok(None);
123        };
124        Ok(Some(XRViewerPose::new(
125            self.global().as_window(),
126            &self.session,
127            to_base,
128            viewer_pose,
129            can_gc,
130        )))
131    }
132
133    /// <https://immersive-web.github.io/webxr/#dom-xrframe-getpose>
134    fn GetPose(
135        &self,
136        space: &XRSpace,
137        base_space: &XRSpace,
138        can_gc: CanGc,
139    ) -> Result<Option<DomRoot<XRPose>>, Error> {
140        if self.session != space.session() || self.session != base_space.session() {
141            return Err(Error::InvalidState(None));
142        }
143        if !self.active.get() {
144            return Err(Error::InvalidState(None));
145        }
146        let space = if let Some(space) = self.get_pose(space) {
147            space
148        } else {
149            return Ok(None);
150        };
151        let base_space = if let Some(r) = self.get_pose(base_space) {
152            r
153        } else {
154            return Ok(None);
155        };
156        let pose = space.then(&base_space.inverse());
157        Ok(Some(XRPose::new(self.global().as_window(), pose, can_gc)))
158    }
159
160    /// <https://immersive-web.github.io/webxr/#dom-xrframe-getpose>
161    fn GetJointPose(
162        &self,
163        space: &XRJointSpace,
164        base_space: &XRSpace,
165        can_gc: CanGc,
166    ) -> Result<Option<DomRoot<XRJointPose>>, Error> {
167        if self.session != space.upcast::<XRSpace>().session() ||
168            self.session != base_space.session()
169        {
170            return Err(Error::InvalidState(None));
171        }
172        if !self.active.get() {
173            return Err(Error::InvalidState(None));
174        }
175        let joint_frame = if let Some(frame) = space.frame(&self.data) {
176            frame
177        } else {
178            return Ok(None);
179        };
180        let base_space = if let Some(r) = self.get_pose(base_space) {
181            r
182        } else {
183            return Ok(None);
184        };
185        let pose = joint_frame.pose.then(&base_space.inverse());
186        Ok(Some(XRJointPose::new(
187            self.global().as_window(),
188            pose.cast_unit(),
189            Some(joint_frame.radius),
190            can_gc,
191        )))
192    }
193
194    /// <https://immersive-web.github.io/hit-test/#dom-xrframe-gethittestresults>
195    fn GetHitTestResults(&self, source: &XRHitTestSource) -> Vec<DomRoot<XRHitTestResult>> {
196        self.data
197            .hit_test_results
198            .iter()
199            .filter(|r| r.id == source.id())
200            .map(|r| XRHitTestResult::new(self.global().as_window(), *r, self, CanGc::note()))
201            .collect()
202    }
203
204    /// <https://www.w3.org/TR/webxr-hand-input-1/#dom-xrframe-filljointradii>
205    fn FillJointRadii(
206        &self,
207        joint_spaces: Vec<DomRoot<XRJointSpace>>,
208        mut radii: CustomAutoRooterGuard<Float32Array>,
209    ) -> Result<bool, Error> {
210        if !self.active.get() {
211            return Err(Error::InvalidState(None));
212        }
213
214        for joint_space in &joint_spaces {
215            if self.session != joint_space.upcast::<XRSpace>().session() {
216                return Err(Error::InvalidState(None));
217            }
218        }
219
220        if joint_spaces.len() > radii.len() {
221            return Err(Error::Type(
222                c"Length of radii does not match length of joint spaces".to_owned(),
223            ));
224        }
225
226        let mut radii_vec = radii.to_vec();
227        let mut all_valid = true;
228        radii_vec.iter_mut().enumerate().for_each(|(i, radius)| {
229            if let Some(joint_frame) = joint_spaces
230                .get(i)
231                .and_then(|joint_space| joint_space.frame(&self.data))
232            {
233                *radius = joint_frame.radius;
234            } else {
235                all_valid = false;
236            }
237        });
238
239        if !all_valid {
240            radii_vec.fill(f32::NAN);
241        }
242
243        radii.update(&radii_vec);
244
245        Ok(all_valid)
246    }
247
248    /// <https://www.w3.org/TR/webxr-hand-input-1/#dom-xrframe-fillposes>
249    fn FillPoses(
250        &self,
251        spaces: Vec<DomRoot<XRSpace>>,
252        base_space: &XRSpace,
253        mut transforms: CustomAutoRooterGuard<Float32Array>,
254    ) -> Result<bool, Error> {
255        if !self.active.get() {
256            return Err(Error::InvalidState(None));
257        }
258
259        for space in &spaces {
260            if self.session != space.session() {
261                return Err(Error::InvalidState(None));
262            }
263        }
264
265        if self.session != base_space.session() {
266            return Err(Error::InvalidState(None));
267        }
268
269        if spaces.len() * 16 > transforms.len() {
270            return Err(Error::Type(
271                c"Transforms array length does not match 16 * spaces length".to_owned(),
272            ));
273        }
274
275        let mut transforms_vec = transforms.to_vec();
276        let mut all_valid = true;
277        spaces.iter().enumerate().for_each(|(i, space)| {
278            let Some(joint_pose) = self.get_pose(space) else {
279                all_valid = false;
280                return;
281            };
282            let Some(base_pose) = self.get_pose(base_space) else {
283                all_valid = false;
284                return;
285            };
286            let pose = joint_pose.then(&base_pose.inverse());
287            let elements = pose.to_transform();
288            let elements_arr = elements.to_array();
289            transforms_vec[i * 16..(i + 1) * 16].copy_from_slice(&elements_arr);
290        });
291
292        if !all_valid {
293            transforms_vec.fill(f32::NAN);
294        }
295
296        transforms.update(&transforms_vec);
297
298        Ok(all_valid)
299    }
300}
script/dom/webxr/xrframe.rs

script/dom/webxr/
xrframe.rs
