aboutsummaryrefslogtreecommitdiffstats
path: root/components/script/dom/xrreferencespace.rs
blob: 932f917b5a588f9cad4c4f05bb158faabbb39c7d (plain) (blame)
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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

use crate::dom::bindings::codegen::Bindings::XRReferenceSpaceBinding;
use crate::dom::bindings::codegen::Bindings::XRReferenceSpaceBinding::XRReferenceSpaceMethods;
use crate::dom::bindings::inheritance::Castable;
use crate::dom::bindings::reflector::reflect_dom_object;
use crate::dom::bindings::root::{DomRoot, MutDom};
use crate::dom::globalscope::GlobalScope;
use crate::dom::xrrigidtransform::XRRigidTransform;
use crate::dom::xrsession::XRSession;
use crate::dom::xrspace::XRSpace;
use crate::dom::xrstationaryreferencespace::XRStationaryReferenceSpace;
use dom_struct::dom_struct;
use euclid::RigidTransform3D;
use webvr_traits::WebVRFrameData;

#[dom_struct]
pub struct XRReferenceSpace {
    xrspace: XRSpace,
    transform: MutDom<XRRigidTransform>,
}

impl XRReferenceSpace {
    pub fn new_inherited(session: &XRSession, transform: &XRRigidTransform) -> XRReferenceSpace {
        XRReferenceSpace {
            xrspace: XRSpace::new_inherited(session),
            transform: MutDom::new(transform),
        }
    }

    #[allow(unused)]
    pub fn identity(global: &GlobalScope, session: &XRSession) -> DomRoot<XRReferenceSpace> {
        let transform = XRRigidTransform::identity(global);
        reflect_dom_object(
            Box::new(XRReferenceSpace::new_inherited(session, &transform)),
            global,
            XRReferenceSpaceBinding::Wrap,
        )
    }
}

impl XRReferenceSpaceMethods for XRReferenceSpace {
    /// https://immersive-web.github.io/webxr/#dom-xrreferencespace-originoffset
    fn SetOriginOffset(&self, transform: &XRRigidTransform) {
        self.transform.set(transform);
    }

    /// https://immersive-web.github.io/webxr/#dom-xrreferencespace-originoffset
    fn OriginOffset(&self) -> DomRoot<XRRigidTransform> {
        self.transform.get()
    }
}

impl XRReferenceSpace {
    /// Gets pose of the viewer with respect to this space
    ///
    /// This is equivalent to `get_pose(self).inverse() * get_pose(viewerSpace)` (in column vector notation),
    /// however we specialize it to be efficient
    pub fn get_viewer_pose(&self, base_pose: &WebVRFrameData) -> RigidTransform3D<f64> {
        let pose = self.get_unoffset_viewer_pose(base_pose);

        // This may change, see https://github.com/immersive-web/webxr/issues/567

        // in column-vector notation,
        // get_viewer_pose(space) = get_pose(space).inverse() * get_pose(viewer_space)
        //                        = (get_unoffset_pose(space) * offset).inverse() * get_pose(viewer_space)
        //                        = offset.inverse() * get_unoffset_pose(space).inverse() * get_pose(viewer_space)
        //                        = offset.inverse() * get_unoffset_viewer_pose(space)
        let offset = self.transform.get().transform();
        let inverse = offset.inverse();
        inverse.pre_mul(&pose)
    }

    /// Gets pose of the viewer with respect to this space
    ///
    /// Does not apply originOffset, use get_viewer_pose instead if you need it
    pub fn get_unoffset_viewer_pose(&self, base_pose: &WebVRFrameData) -> RigidTransform3D<f64> {
        if let Some(stationary) = self.downcast::<XRStationaryReferenceSpace>() {
            stationary.get_unoffset_viewer_pose(base_pose)
        } else {
            // non-subclassed XRReferenceSpaces exist, obtained via the "identity"
            // type. These poses are equivalent to the viewer pose and follow the headset
            // around, so the viewer is always at an identity transform with respect to them
            RigidTransform3D::identity()
        }
    }

    /// Gets pose represented by this space
    ///
    /// The reference origin used is common between all
    /// get_pose calls for spaces from the same device, so this can be used to compare
    /// with other spaces
    pub fn get_pose(&self, base_pose: &WebVRFrameData) -> RigidTransform3D<f64> {
        let pose = self.get_unoffset_pose(base_pose);

        // This may change, see https://github.com/immersive-web/webxr/issues/567
        let offset = self.transform.get().transform();
        offset.post_mul(&pose)
    }

    /// Gets pose represented by this space
    ///
    /// Does not apply originOffset, use get_viewer_pose instead if you need it
    pub fn get_unoffset_pose(&self, base_pose: &WebVRFrameData) -> RigidTransform3D<f64> {
        if let Some(stationary) = self.downcast::<XRStationaryReferenceSpace>() {
            stationary.get_unoffset_pose(base_pose)
        } else {
            // non-subclassed XRReferenceSpaces exist, obtained via the "identity"
            // type. These are equivalent to the viewer pose and follow the headset
            // around
            XRSpace::pose_to_transform(&base_pose.pose)
        }
    }
}