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

script/dom/webxr/
xrframe.rs
