graphene/euler.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
// 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, EulerOrder, Matrix, Quaternion, Vec3};
impl Euler {
/// Initializes a [`Euler`][crate::Euler] using the given angles.
///
/// The order of the rotations is [`EulerOrder::Default`][crate::EulerOrder::Default].
/// ## `x`
/// rotation angle on the X axis, in degrees
/// ## `y`
/// rotation angle on the Y axis, in degrees
/// ## `z`
/// rotation angle on the Z axis, in degrees
///
/// # Returns
///
/// the initialized [`Euler`][crate::Euler]
#[doc(alias = "graphene_euler_init")]
pub fn new(x: f32, y: f32, z: f32) -> Self {
assert_initialized_main_thread!();
unsafe {
let mut eul = Self::uninitialized();
ffi::graphene_euler_init(eul.to_glib_none_mut().0, x, y, z);
eul
}
}
/// Initializes a [`Euler`][crate::Euler] using the given rotation matrix.
///
/// If the [`Matrix`][crate::Matrix] `m` is [`None`], the [`Euler`][crate::Euler] will
/// be initialized with all angles set to 0.
/// ## `m`
/// a rotation matrix
/// ## `order`
/// the order used to apply the rotations
///
/// # Returns
///
/// the initialized [`Euler`][crate::Euler]
#[doc(alias = "graphene_euler_init_from_matrix")]
#[doc(alias = "init_from_matrix")]
pub fn from_matrix(m: Option<&Matrix>, order: EulerOrder) -> Self {
assert_initialized_main_thread!();
unsafe {
let mut eul = Self::uninitialized();
ffi::graphene_euler_init_from_matrix(
eul.to_glib_none_mut().0,
m.to_glib_none().0,
order.into_glib(),
);
eul
}
}
/// Initializes a [`Euler`][crate::Euler] using the given normalized quaternion.
///
/// If the [`Quaternion`][crate::Quaternion] `q` is [`None`], the [`Euler`][crate::Euler] will
/// be initialized with all angles set to 0.
/// ## `q`
/// a normalized [`Quaternion`][crate::Quaternion]
/// ## `order`
/// the order used to apply the rotations
///
/// # Returns
///
/// the initialized [`Euler`][crate::Euler]
#[doc(alias = "graphene_euler_init_from_quaternion")]
#[doc(alias = "init_from_quaternion")]
pub fn from_quaternion(q: Option<&Quaternion>, order: EulerOrder) -> Self {
assert_initialized_main_thread!();
unsafe {
let mut eul = Self::uninitialized();
ffi::graphene_euler_init_from_quaternion(
eul.to_glib_none_mut().0,
q.to_glib_none().0,
order.into_glib(),
);
eul
}
}
/// Initializes a [`Euler`][crate::Euler] using the given angles
/// and order of rotation.
/// ## `x`
/// rotation angle on the X axis, in radians
/// ## `y`
/// rotation angle on the Y axis, in radians
/// ## `z`
/// rotation angle on the Z axis, in radians
/// ## `order`
/// order of rotations
///
/// # Returns
///
/// the initialized [`Euler`][crate::Euler]
#[doc(alias = "graphene_euler_init_from_radians")]
#[doc(alias = "init_from_radians")]
pub fn from_radians(x: f32, y: f32, z: f32, order: EulerOrder) -> Self {
unsafe {
let mut eul = Self::uninitialized();
ffi::graphene_euler_init_from_radians(
eul.to_glib_none_mut().0,
x,
y,
z,
order.into_glib(),
);
eul
}
}
/// Initializes a [`Euler`][crate::Euler] using the angles contained in a
/// [`Vec3`][crate::Vec3].
///
/// If the [`Vec3`][crate::Vec3] `v` is [`None`], the [`Euler`][crate::Euler] will be
/// initialized with all angles set to 0.
/// ## `v`
/// a [`Vec3`][crate::Vec3] containing the rotation
/// angles in degrees
/// ## `order`
/// the order used to apply the rotations
///
/// # Returns
///
/// the initialized [`Euler`][crate::Euler]
#[doc(alias = "graphene_euler_init_from_vec3")]
#[doc(alias = "init_from_vec3")]
pub fn from_vec3(v: Option<&Vec3>, order: EulerOrder) -> Self {
assert_initialized_main_thread!();
unsafe {
let mut eul = Self::uninitialized();
ffi::graphene_euler_init_from_vec3(
eul.to_glib_none_mut().0,
v.to_glib_none().0,
order.into_glib(),
);
eul
}
}
/// Initializes a [`Euler`][crate::Euler] with the given angles and `order`.
/// ## `x`
/// rotation angle on the X axis, in degrees
/// ## `y`
/// rotation angle on the Y axis, in degrees
/// ## `z`
/// rotation angle on the Z axis, in degrees
/// ## `order`
/// the order used to apply the rotations
///
/// # Returns
///
/// the initialized [`Euler`][crate::Euler]
#[doc(alias = "graphene_euler_init_with_order")]
#[doc(alias = "init_with_order")]
pub fn with_order(x: f32, y: f32, z: f32, order: EulerOrder) -> Self {
assert_initialized_main_thread!();
unsafe {
let mut eul = Self::uninitialized();
ffi::graphene_euler_init_with_order(
eul.to_glib_none_mut().0,
x,
y,
z,
order.into_glib(),
);
eul
}
}
}
impl fmt::Debug for Euler {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Euler")
.field("order", &self.order())
.field("alpha", &self.alpha())
.field("beta", &self.beta())
.field("gamma", &self.gamma())
.finish()
}
}