graphene/
quaternion.rs

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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
// Take a look at the license at the top of the repository in the LICENSE file.

use std::fmt;

use glib::translate::*;

use crate::{ffi, Euler, Matrix, Quaternion, Vec3, Vec4};

impl Quaternion {
    /// Initializes a [`Quaternion`][crate::Quaternion] using the given four values.
    /// ## `x`
    /// the first component of the quaternion
    /// ## `y`
    /// the second component of the quaternion
    /// ## `z`
    /// the third component of the quaternion
    /// ## `w`
    /// the fourth component of the quaternion
    ///
    /// # Returns
    ///
    /// the initialized quaternion
    #[doc(alias = "graphene_quaternion_init")]
    pub fn new(x: f32, y: f32, z: f32, w: f32) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init(quat.to_glib_none_mut().0, x, y, z, w);
            quat
        }
    }

    /// Initializes a [`Quaternion`][crate::Quaternion] using an `angle` on a
    /// specific `axis`.
    /// ## `angle`
    /// the rotation on a given axis, in degrees
    /// ## `axis`
    /// the axis of rotation, expressed as a vector
    ///
    /// # Returns
    ///
    /// the initialized quaternion
    #[doc(alias = "graphene_quaternion_init_from_angle_vec3")]
    #[doc(alias = "init_from_angle_vec3")]
    pub fn from_angle_vec3(angle: f32, axis: &Vec3) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init_from_angle_vec3(
                quat.to_glib_none_mut().0,
                angle,
                axis.to_glib_none().0,
            );
            quat
        }
    }

    /// Initializes a [`Quaternion`][crate::Quaternion] using the values of
    /// the [Euler angles](http://en.wikipedia.org/wiki/Euler_angles)
    /// on each axis.
    ///
    /// See also: [`from_euler()`][Self::from_euler()]
    /// ## `deg_x`
    /// rotation angle on the X axis (yaw), in degrees
    /// ## `deg_y`
    /// rotation angle on the Y axis (pitch), in degrees
    /// ## `deg_z`
    /// rotation angle on the Z axis (roll), in degrees
    ///
    /// # Returns
    ///
    /// the initialized quaternion
    #[doc(alias = "graphene_quaternion_init_from_angles")]
    #[doc(alias = "init_from_angles")]
    pub fn from_angles(deg_x: f32, deg_y: f32, deg_z: f32) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init_from_angles(
                quat.to_glib_none_mut().0,
                deg_x,
                deg_y,
                deg_z,
            );
            quat
        }
    }

    /// Initializes a [`Quaternion`][crate::Quaternion] using the given [`Euler`][crate::Euler].
    /// ## `e`
    /// a [`Euler`][crate::Euler]
    ///
    /// # Returns
    ///
    /// the initialized [`Quaternion`][crate::Quaternion]
    #[doc(alias = "graphene_quaternion_init_from_euler")]
    #[doc(alias = "init_from_euler")]
    pub fn from_euler(e: &Euler) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init_from_euler(quat.to_glib_none_mut().0, e.to_glib_none().0);
            quat
        }
    }

    /// Initializes a [`Quaternion`][crate::Quaternion] using the rotation components
    /// of a transformation matrix.
    /// ## `m`
    /// a [`Matrix`][crate::Matrix]
    ///
    /// # Returns
    ///
    /// the initialized quaternion
    #[doc(alias = "graphene_quaternion_init_from_matrix")]
    #[doc(alias = "init_from_matrix")]
    pub fn from_matrix(m: &Matrix) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init_from_matrix(
                quat.to_glib_none_mut().0,
                m.to_glib_none().0,
            );
            quat
        }
    }

    /// Initializes a [`Quaternion`][crate::Quaternion] using the values of
    /// the [Euler angles](http://en.wikipedia.org/wiki/Euler_angles)
    /// on each axis.
    ///
    /// See also: [`from_euler()`][Self::from_euler()]
    /// ## `rad_x`
    /// rotation angle on the X axis (yaw), in radians
    /// ## `rad_y`
    /// rotation angle on the Y axis (pitch), in radians
    /// ## `rad_z`
    /// rotation angle on the Z axis (roll), in radians
    ///
    /// # Returns
    ///
    /// the initialized quaternion
    #[doc(alias = "graphene_quaternion_init_from_radians")]
    #[doc(alias = "init_from_radians")]
    pub fn from_radians(rad_x: f32, rad_y: f32, rad_z: f32) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init_from_radians(
                quat.to_glib_none_mut().0,
                rad_x,
                rad_y,
                rad_z,
            );
            quat
        }
    }

    /// Initializes a [`Quaternion`][crate::Quaternion] with the values from `src`.
    /// ## `src`
    /// a [`Vec4`][crate::Vec4]
    ///
    /// # Returns
    ///
    /// the initialized quaternion
    #[doc(alias = "graphene_quaternion_init_from_vec4")]
    #[doc(alias = "init_from_vec4")]
    pub fn from_vec4(src: &Vec4) -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init_from_vec4(
                quat.to_glib_none_mut().0,
                src.to_glib_none().0,
            );
            quat
        }
    }

    /// Initializes a [`Quaternion`][crate::Quaternion] using the identity
    /// transformation.
    ///
    /// # Returns
    ///
    /// the initialized quaternion
    #[doc(alias = "graphene_quaternion_init_identity")]
    #[doc(alias = "init_identity")]
    pub fn new_identity() -> Self {
        assert_initialized_main_thread!();
        unsafe {
            let mut quat = Self::uninitialized();
            ffi::graphene_quaternion_init_identity(quat.to_glib_none_mut().0);
            quat
        }
    }

    #[inline]
    pub fn x(&self) -> f32 {
        self.inner.x
    }

    #[inline]
    pub fn y(&self) -> f32 {
        self.inner.y
    }

    #[inline]
    pub fn z(&self) -> f32 {
        self.inner.z
    }

    #[inline]
    pub fn w(&self) -> f32 {
        self.inner.w
    }
}

impl fmt::Debug for Quaternion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Quaternion")
            .field("x", &self.x())
            .field("y", &self.y())
            .field("z", &self.z())
            .field("w", &self.w())
            .finish()
    }
}