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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
//! Quaternions are a convenient representation for rotations in 3D spaces.
use approx::{AbsDiffEq, RelativeEq, UlpsEq};
use num_traits::{real::Real, One, Zero};
use crate::ops::*;
use std::ops::Add;
use std::ops::*;
#[cfg(feature = "bytemuck")]
use crate::bytemuck;
macro_rules! impl_mul_by_vec {
($Vec3:ident $Vec4:ident) => {
/// 3D vectors can be rotated by being premultiplied by a quaternion, **assuming the
/// quaternion is normalized**.
/// On `Vec4`s, the `w` element is preserved, so you can safely rotate
/// points and directions.
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::{Quaternion, Vec4};
/// use std::f32::consts::PI;
///
/// # fn main() {
/// let v = Vec4::unit_x();
///
/// let q = Quaternion::<f32>::identity();
/// assert_relative_eq!(q * v, v);
///
/// let q = Quaternion::rotation_z(PI);
/// assert_relative_eq!(q * v, -v);
///
/// let q = Quaternion::rotation_z(PI * 0.5);
/// assert_relative_eq!(q * v, Vec4::unit_y());
///
/// let q = Quaternion::rotation_z(PI * 1.5);
/// assert_relative_eq!(q * v, -Vec4::unit_y());
///
/// let angles = 32;
/// for i in 0..angles {
/// let theta = PI * 2. * (i as f32) / (angles as f32);
///
/// // See what rotating unit vectors do for most angles between 0 and 2*PI.
/// // It's helpful to picture this as a right-handed coordinate system.
///
/// let v = Vec4::unit_y();
/// let q = Quaternion::rotation_x(theta);
/// assert_relative_eq!(q * v, Vec4::new(0., theta.cos(), theta.sin(), 0.));
///
/// let v = Vec4::unit_z();
/// let q = Quaternion::rotation_y(theta);
/// assert_relative_eq!(q * v, Vec4::new(theta.sin(), 0., theta.cos(), 0.));
///
/// let v = Vec4::unit_x();
/// let q = Quaternion::rotation_z(theta);
/// assert_relative_eq!(q * v, Vec4::new(theta.cos(), theta.sin(), 0., 0.));
/// }
/// # }
/// ```
impl<T: Real + Add<T, Output=T>> Mul<$Vec4<T>> for Quaternion<T> {
type Output = $Vec4<T>;
fn mul(self, rhs: $Vec4<T>) -> Self::Output {
let $Vec4 { x, y, z, w } = rhs;
let $Vec3 { x, y, z } = self * $Vec3 { x, y, z };
$Vec4 { x, y, z, w }
}
}
/// 3D vectors can be rotated by being premultiplied by a quaternion, **assuming the
/// quaternion is normalized**.
impl<T: Real + Add<T, Output=T>> Mul<$Vec3<T>> for Quaternion<T> {
type Output = $Vec3<T>;
fn mul(self, rhs: $Vec3<T>) -> Self::Output {
let $Vec3 { x, y, z } = rhs;
let v = Self { x, y, z, w: T::zero() };
let qi = self.conjugate(); // We want the inverse, and assume self is normalized.
(self * v * qi).into()
}
}
};
}
macro_rules! quaternion_vec3_vec4 {
($Vec3:ident $Vec4:ident) => {
impl_mul_by_vec!{$Vec3 $Vec4}
/// A quaternion can be created directly from a `Vec4`'s `x`, `y`, `z` and `w` elements.
/// **You are responsible for ensuring that the resulting quaternion is normalized.**
impl<T> From<$Vec4<T>> for Quaternion<T> {
fn from(v: $Vec4<T>) -> Self {
let $Vec4 { x, y, z, w } = v;
Self { x, y, z, w }
}
}
/// A `Vec4` can be created directly from a quaternion's `x`, `y`, `z` and `w` elements.
impl<T> From<Quaternion<T>> for $Vec4<T> {
fn from(v: Quaternion<T>) -> Self {
let Quaternion { x, y, z, w } = v;
Self { x, y, z, w }
}
}
/// A `Vec3` can be created directly from a quaternion's `x`, `y` and `z` elements.
impl<T> From<Quaternion<T>> for $Vec3<T> {
fn from(v: Quaternion<T>) -> Self {
let Quaternion { x, y, z, .. } = v;
Self { x, y, z }
}
}
};
}
macro_rules! quaternion_complete_mod {
($mod:ident #[$attrs:meta]) => {
use crate::vec::$mod::*;
/// Quaternions are a convenient representation for rotations in 3D spaces.
///
/// **IMPORTANT**: Quaternions are only valid as rotations as long as they are
/// **normalized** (i.e their magnitude is 1). Most operations assume
/// this, instead of normalizing inputs behind your back, so be careful.
///
/// They essentially consist of a vector part (`x`, `y`, `z`), and scalar part (`w`).
/// For unit quaternions, the vector part is the unit axis of rotation scaled by the sine of
/// the half-angle of the rotation, and the scalar part is the cosine of the half-angle.
#[derive(Debug, Clone, Copy, Hash, Eq, PartialEq, /*Ord, PartialOrd*/)]
#[cfg_attr(feature="serde", derive(Serialize, Deserialize))]
#[$attrs]
#[allow(missing_docs)]
pub struct Quaternion<T> { pub x: T, pub y: T, pub z: T, pub w: T }
/// The default value for a quaternion is the identity.
///
/// ```
/// # use vek::Quaternion;
/// assert_eq!(Quaternion::<f32>::identity(), Quaternion::default());
/// ```
impl<T: Zero + One> Default for Quaternion<T> {
fn default() -> Self {
Self::identity()
}
}
impl<T> Quaternion<T> {
/// Creates a new quaternion with `x`, `y`, `z` and `w` elements in order.
///
/// **You are responsible for ensuring that the resulting quaternion is normalized.**
pub fn from_xyzw(x: T, y: T, z: T, w: T) -> Self {
Self { x, y, z, w }
}
/// Creates a new quaternion from a scalar-and-vector pair.
///
/// **You are responsible for ensuring that the resulting quaternion is normalized.**
pub fn from_scalar_and_vec3<V: Into<Vec3<T>>>(pair: (T, V)) -> Self {
let Vec3 { x, y, z } = pair.1.into();
Self { x, y, z, w: pair.0 }
}
/// Converts this quaternion into a scalar-and-vector pair by destructuring.
///
/// **Not to be confused with `into_angle_axis()`**.
pub fn into_scalar_and_vec3(self) -> (T, Vec3<T>) {
let Self { x, y, z, w } = self;
(w, Vec3 { x, y, z })
}
/// Creates a new quaternion with all elements set to zero.
///
/// **Be careful: since it has a magnitude equal to zero, it is not
/// valid to use for most operations.**
pub fn zero() -> Self where T: Zero {
Self {
x: T::zero(),
y: T::zero(),
z: T::zero(),
w: T::zero(),
}
}
/// Creates the identity quaternion.
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::Quaternion;
/// use std::f32::consts::PI;
///
/// # fn main() {
/// let id = Quaternion::<f32>::identity();
/// assert_eq!(id, Default::default());
/// assert_relative_eq!(id, id.conjugate());
/// assert_relative_eq!(id, id.inverse());
///
/// let q = Quaternion::rotation_y(PI);
/// assert_relative_eq!(id * q, q);
/// assert_relative_eq!(q * id, q);
/// # }
/// ```
pub fn identity() -> Self where T: Zero + One {
Self {
x: T::zero(),
y: T::zero(),
z: T::zero(),
w: T::one(),
}
}
/// Gets this quaternion's conjugate (copy with negated vector part).
///
/// On normalized quaternions, the conjugate also happens to be the inverse.
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::Quaternion;
/// use std::f32::consts::PI;
///
/// # fn main() {
/// let p = Quaternion::rotation_x(PI);
/// let q = Quaternion::rotation_z(PI);
/// assert_relative_eq!((p*q).conjugate(), q.conjugate() * p.conjugate());
///
/// // Rotation quaternions are normalized, so their conjugate is also their inverse.
/// assert_relative_eq!(q.conjugate(), q.inverse());
/// # }
/// ```
pub fn conjugate(self) -> Self where T: Neg<Output=T> {
Self {
x: -self.x,
y: -self.y,
z: -self.z,
w: self.w,
}
}
/// Gets this quaternion's inverse, i.e the one that reverses its effect.
///
/// On normalized quaternions, the inverse happens to be the conjugate.
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::Quaternion;
/// use std::f32::consts::PI;
///
/// # fn main() {
/// let rot = Quaternion::rotation_y(PI);
/// let inv = rot.inverse();
/// assert_relative_eq!(rot*inv, Quaternion::identity());
/// assert_relative_eq!(inv*rot, Quaternion::identity());
///
/// let p = Quaternion::rotation_x(PI);
/// let q = Quaternion::rotation_z(PI);
/// assert_relative_eq!((p*q).inverse(), q.inverse() * p.inverse());
/// # }
/// ```
pub fn inverse(self) -> Self where T: Neg<Output=T> + Copy + Add<T, Output=T> + Mul<Output=T> + Div<Output=T> {
self.conjugate() / self.into_vec4().magnitude_squared()
}
/// Gets the dot product between two quaternions.
pub fn dot(self, q: Self) -> T
where T: Copy + Add<T, Output=T> + Mul<Output=T>
{
self.into_vec4().dot(q.into_vec4())
}
/// Gets a normalized copy of this quaternion.
pub fn normalized(self) -> Self where T: Real + Add<T, Output=T> {
self.into_vec4().normalized().into()
}
/// Gets this quaternion's magnitude, squared.
pub fn magnitude_squared(self) -> T where T: Real + Add<T, Output=T> {
self.into_vec4().magnitude_squared().into()
}
/// Gets this quaternion's magnitude.
pub fn magnitude(self) -> T where T: Real + Add<T, Output=T> {
self.into_vec4().magnitude().into()
}
/// Creates a quaternion that would rotate a `from` direction to `to`.
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::{Vec4, Quaternion};
///
/// # fn main() {
/// let (from, to) = (Vec4::<f32>::unit_x(), Vec4::<f32>::unit_y());
/// let q = Quaternion::<f32>::rotation_from_to_3d(from, to);
/// assert_relative_eq!(q * from, to);
/// assert_relative_eq!(q * Vec4::unit_y(), -Vec4::unit_x());
///
/// let (from, to) = (Vec4::<f32>::unit_x(), -Vec4::<f32>::unit_x());
/// let q = Quaternion::<f32>::rotation_from_to_3d(from, to);
/// assert_relative_eq!(q * from, to);
/// # }
/// ```
pub fn rotation_from_to_3d<V: Into<Vec3<T>>>(from: V, to: V) -> Self
where T: Real + Add<T, Output=T>
{
// From GLM
let (from, to) = (from.into(), to.into());
let norm_u_norm_v = (from.dot(from) * to.dot(to)).sqrt();
let w = norm_u_norm_v + from.dot(to);
let (Vec3 { x, y, z }, w) = if w < norm_u_norm_v * T::epsilon() {
// If we are here, it is a 180° rotation, which we have to handle.
if from.x.abs() > from.z.abs() {
(Vec3::new(-from.y, from.x, T::zero()), T::zero())
} else {
(Vec3::new(T::zero(), -from.z, from.y), T::zero())
}
} else {
(from.cross(to), w)
};
Self { x, y, z, w }.normalized()
}
/// Creates a quaternion from an angle and axis.
/// The axis is not required to be normalized.
pub fn rotation_3d<V: Into<Vec3<T>>>(angle_radians: T, axis: V) -> Self
where T: Real + Add<T, Output=T>
{
let axis = axis.into().normalized();
let two = T::one() + T::one();
let Vec3 { x, y, z } = axis * (angle_radians/two).sin();
let w = (angle_radians/two).cos();
Self { x, y, z, w }
}
/// Creates a quaternion from an angle for a rotation around the X axis.
pub fn rotation_x(angle_radians: T) -> Self where T: Real + Add<T, Output=T> {
Self::rotation_3d(angle_radians, Vec3::unit_x())
}
/// Creates a quaternion from an angle for a rotation around the Y axis.
pub fn rotation_y(angle_radians: T) -> Self where T: Real + Add<T, Output=T> {
Self::rotation_3d(angle_radians, Vec3::unit_y())
}
/// Creates a quaternion from an angle for a rotation around the Y axis.
pub fn rotation_z(angle_radians: T) -> Self where T: Real + Add<T, Output=T> {
Self::rotation_3d(angle_radians, Vec3::unit_z())
}
/// Returns this quaternion rotated around the given axis with given angle.
/// The axis is not required to be normalized.
pub fn rotated_3d<V: Into<Vec3<T>>>(self, angle_radians: T, axis: V) -> Self where T: Real + Add<T, Output=T> {
Self::rotation_3d(angle_radians, axis) * self
}
/// Returns this quaternion rotated around the X axis with given angle.
pub fn rotated_x(self, angle_radians: T) -> Self where T: Real + Add<T, Output=T> {
Self::rotation_x(angle_radians) * self
}
/// Returns this quaternion rotated around the Y axis with given angle.
pub fn rotated_y(self, angle_radians: T) -> Self where T: Real + Add<T, Output=T> {
Self::rotation_y(angle_radians) * self
}
/// Returns this quaternion rotated around the Z axis with given angle.
pub fn rotated_z(self, angle_radians: T) -> Self where T: Real + Add<T, Output=T> {
Self::rotation_z(angle_radians) * self
}
/// Rotates this quaternion around the given axis with given angle.
/// The axis is not required to be normalized.
pub fn rotate_3d<V: Into<Vec3<T>>>(&mut self, angle_radians: T, axis: V) where T: Real + Add<T, Output=T> {
*self = self.rotated_3d(angle_radians, axis);
}
/// Rotates this quaternion around the X axis with given angle.
pub fn rotate_x(&mut self, angle_radians: T) where T: Real + Add<T, Output=T> {
*self = self.rotated_x(angle_radians);
}
/// Rotates this quaternion around the Y axis with given angle.
pub fn rotate_y(&mut self, angle_radians: T) where T: Real + Add<T, Output=T> {
*self = self.rotated_y(angle_radians);
}
/// Rotates this quaternion around the Z axis with given angle.
pub fn rotate_z(&mut self, angle_radians: T) where T: Real + Add<T, Output=T> {
*self = self.rotated_z(angle_radians);
}
/// Convert this quaternion to angle-axis representation,
/// **assuming the quaternion is normalized.**
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::{Quaternion, Vec3};
/// use std::f32::consts::PI;
///
/// # fn main() {
/// let q = Quaternion::rotation_x(PI/2.);
/// let (angle, axis) = q.into_angle_axis();
/// assert_relative_eq!(angle, PI/2.);
/// assert_relative_eq!(axis, Vec3::unit_x());
///
/// let angle = PI*4./5.;
/// let axis = Vec3::new(1_f32, 2., 3.);
/// let q = Quaternion::rotation_3d(angle, axis);
/// let (a, v) = q.into_angle_axis();
/// assert_relative_eq!(a, angle);
/// assert_relative_eq!(v, axis.normalized());
/// # }
/// ```
pub fn into_angle_axis(self) -> (T, Vec3<T>) where T: Real {
// http://www.euclideanspace.com/maths/geometry/rotations/conversions/quaternionToAngle/
// Also, Q57 of matrix-quaternion FAQ
let Self { x, y, z, w } = self;
let angle = w.acos();
let angle = angle + angle;
let s = (T::one() - w*w).sqrt();
let axis = if s < T::epsilon() {
Vec3::unit_x() // Any axis would do
} else {
Vec3 { x, y, z } / s
};
(angle, axis)
}
/// Converts this quaternion to a `Vec4` by destructuring.
pub fn into_vec4(self) -> Vec4<T> {
self.into()
}
/// Creates a quaternion from a `Vec4` by destructuring.
/// **You are responsible for ensuring that the resulting quaternion is normalized.**
pub fn from_vec4(v: Vec4<T>) -> Self {
v.into()
}
/// Converts this quaternion to a `Vec3` by destructuring, dropping the `w` element.
pub fn into_vec3(self) -> Vec3<T> {
self.into()
}
}
#[cfg(feature = "mint")]
impl<T> From<mint::Quaternion<T>> for Quaternion<T> {
fn from(q: mint::Quaternion<T>) -> Self {
let mint::Quaternion { s, v } = q;
Self::from_scalar_and_vec3((s, v))
}
}
#[cfg(feature = "mint")]
impl<T> Into<mint::Quaternion<T>> for Quaternion<T> {
fn into(self) -> mint::Quaternion<T> {
let (s, v) = self.into_scalar_and_vec3();
mint::Quaternion { s, v: v.into() }
}
}
/// The `Lerp` implementation for quaternion is the "Normalized LERP".
impl<T, Factor> Lerp<Factor> for Quaternion<T>
where T: Lerp<Factor,Output=T> + Add<T, Output=T> + Real,
Factor: Copy
{
type Output = Self;
fn lerp_unclamped_precise(from: Self, to: Self, factor: Factor) -> Self {
let (from, to) = (from.into_vec4(), to.into_vec4());
Lerp::lerp_unclamped_precise(from, to, factor).normalized().into()
}
fn lerp_unclamped(from: Self, to: Self, factor: Factor) -> Self {
let (from, to) = (from.into_vec4(), to.into_vec4());
Lerp::lerp_unclamped(from, to, factor).normalized().into()
}
}
/// The `Lerp` implementation for quaternion is the "Normalized LERP".
impl<'a, T, Factor> Lerp<Factor> for &'a Quaternion<T>
// Real implies Copy, so no &'a T here.
where T: Lerp<Factor,Output=T> + Add<T, Output=T> + Real,
Factor: Copy
{
type Output = Quaternion<T>;
fn lerp_unclamped_precise(from: Self, to: Self, factor: Factor) -> Quaternion<T> {
Lerp::lerp_unclamped_precise(*from, *to, factor)
}
fn lerp_unclamped(from: Self, to: Self, factor: Factor) -> Quaternion<T> {
Lerp::lerp_unclamped(*from, *to, factor)
}
}
impl<T> Quaternion<T>
where T: Copy + One + Mul<Output=T> + Sub<Output=T> + MulAdd<T,T,Output=T>
{
/// Performs linear interpolation **without normalizing the result**,
/// using an implementation that supposedly yields a more precise result.
///
/// This is probably not what you're looking for.
/// For an implementation that normalizes the result (which is more commonly wanted), see the `Lerp` implementation.
pub fn lerp_precise_unnormalized(from: Self, to: Self, factor: T) -> Self where T: Clamp + Zero {
Self::lerp_unclamped_precise_unnormalized(from, to, factor.clamped01())
}
/// Performs linear interpolation **without normalizing the result** and without
/// implicitly constraining `factor` to be between 0 and 1,
/// using an implementation that supposedly yields a more precise result.
///
/// This is probably not what you're looking for.
/// For an implementation that normalizes the result (which is more commonly wanted), see the `Lerp` implementation.
pub fn lerp_unclamped_precise_unnormalized(from: Self, to: Self, factor: T) -> Self {
Vec4::lerp_unclamped_precise(from.into(), to.into(), factor).into()
}
}
impl<T> Quaternion<T>
where T: Copy + Sub<Output=T> + MulAdd<T,T,Output=T>
{
/// Performs linear interpolation **without normalizing the result**.
///
/// This is probably not what you're looking for.
/// For an implementation that normalizes the result (which is more commonly wanted), see the `Lerp` implementation.
pub fn lerp_unnormalized(from: Self, to: Self, factor: T) -> Self where T: Clamp + Zero + One {
Self::lerp_unclamped_unnormalized(from, to, factor.clamped01())
}
/// Performs linear interpolation **without normalizing the result** and without
/// implicitly constraining `factor` to be between 0 and 1.
///
/// This is probably not what you're looking for.
/// For an implementation that normalizes the result (which is more commonly wanted), see the `Lerp` implementation.
pub fn lerp_unclamped_unnormalized(from: Self, to: Self, factor: T) -> Self {
Vec4::lerp_unclamped(from.into(), to.into(), factor).into()
}
}
impl<T> Quaternion<T>
where T: Lerp<T,Output=T> + Add<T, Output=T> + Real
{
/// Performs spherical linear interpolation without implictly constraining `factor` to
/// be between 0 and 1.
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::Quaternion;
/// use std::f32::consts::PI;
///
/// # fn main() {
/// let from = Quaternion::rotation_z(0_f32);
/// let to = Quaternion::rotation_z(PI*9./10.);
///
/// let angles = 32;
/// for i in 0..angles {
/// let factor = (i as f32) / (angles as f32);
/// let expected = Quaternion::rotation_z(factor * PI*9./10.);
/// let slerp = Quaternion::slerp(from, to, factor);
/// assert_relative_eq!(slerp, expected);
/// }
/// # }
/// ```
// From GLM's source code.
pub fn slerp_unclamped(from: Self, mut to: Self, factor: T) -> Self {
let mut cos_theta = from.dot(to);
// If cosTheta < 0, the interpolation will take the long way around the sphere.
// To fix this, one quat must be negated.
if cos_theta < T::zero() {
to = -to;
cos_theta = -cos_theta;
}
// Perform a linear interpolation when cosTheta is close to 1 to avoid side effect of sin(angle) becoming a zero denominator
if cos_theta > T::one() - T::epsilon() {
return Self::lerp_unclamped(from, to, factor);
}
let angle = cos_theta.acos();
(from * ((T::one() - factor) * angle).sin() + to * (factor * angle).sin()) / angle.sin()
}
/// Perform spherical linear interpolation, constraining `factor` to
/// be between 0 and 1.
pub fn slerp(from: Self, to: Self, factor: T) -> Self where T: Clamp {
Slerp::slerp(from, to, factor)
}
}
impl<T, Factor> Slerp<Factor> for Quaternion<T>
where T: Lerp<T,Output=T> + Add<T, Output=T> + Real,
Factor: Into<T>
{
type Output = Self;
fn slerp_unclamped(from: Self, to: Self, factor: Factor) -> Self {
Self::slerp_unclamped(from, to, factor.into())
}
}
impl<'a, T, Factor> Slerp<Factor> for &'a Quaternion<T>
where T: Lerp<T,Output=T> + Add<T, Output=T> + Real,
Factor: Into<T>
{
type Output = Quaternion<T>;
fn slerp_unclamped(from: Self, to: Self, factor: Factor) -> Quaternion<T> {
Quaternion::slerp_unclamped(*from, *to, factor.into())
}
}
impl<T> Neg for Quaternion<T> where T: Neg<Output=T> {
type Output = Self;
fn neg(self) -> Self::Output {
Self {
x: -self.x,
y: -self.y,
z: -self.z,
w: -self.w,
}
}
}
impl<T> Div<T> for Quaternion<T> where T: Copy + Div<Output=T> {
type Output = Self;
fn div(self, rhs: T) -> Self::Output {
Self {
x: self.x / rhs,
y: self.y / rhs,
z: self.z / rhs,
w: self.w / rhs,
}
}
}
impl<T> Add for Quaternion<T> where T: Add<Output=T> {
type Output = Self;
fn add(self, rhs: Self) -> Self::Output {
Self {
x: self.x + rhs.x,
y: self.y + rhs.y,
z: self.z + rhs.z,
w: self.w + rhs.w,
}
}
}
impl<T> Sub for Quaternion<T> where T: Sub<Output=T> {
type Output = Self;
fn sub(self, rhs: Self) -> Self::Output {
Self {
x: self.x - rhs.x,
y: self.y - rhs.y,
z: self.z - rhs.z,
w: self.w - rhs.w,
}
}
}
/// The `Mul` implementation for quaternions is concatenation, a.k.a Grassman product.
///
/// ```
/// # extern crate vek;
/// # #[macro_use] extern crate approx;
/// # use vek::{Quaternion, Vec4};
/// use std::f32::consts::PI;
///
/// # fn main() {
/// let v = Vec4::unit_x();
/// let p = Quaternion::rotation_y(PI/2.);
/// let q = Quaternion::rotation_z(PI/2.);
/// assert_relative_eq!((p*q)*v, p*(q*v));
/// assert_relative_eq!(p*q*v, Vec4::unit_y());
/// assert_relative_eq!(q*p*v, -Vec4::unit_z());
/// # }
/// ```
impl<T> Mul for Quaternion<T>
where T: Copy + Mul<Output=T> + Sub<Output=T> + Zero + Add<T, Output=T>
{
type Output = Self;
fn mul(self, rhs: Self) -> Self::Output {
let ((ps, pv), (qs, qv)) = (
self.into_scalar_and_vec3(),
rhs.into_scalar_and_vec3()
);
let Vec3 { x, y, z } = qv*ps + pv*qs + pv.cross(qv);
let w = ps*qs - pv.dot(qv);
Self { x, y, z, w }
}
}
impl<T> Mul<T> for Quaternion<T>
where T: Mul<Output=T> + Copy
{
type Output = Self;
fn mul(self, rhs: T) -> Self::Output {
Self {
x: self.x * rhs,
y: self.y * rhs,
z: self.z * rhs,
w: self.w * rhs,
}
}
}
/*
// WISH: OrthoMat4 * Quaternion; Only for orthogonal matrices
static inline void mat4o_mul_quat(mat4 R, mat4 M, quat q)
{
quat_mul_vec3(R[0], q, M[0]);
quat_mul_vec3(R[1], q, M[1]);
quat_mul_vec3(R[2], q, M[2]);
R[3][0] = R[3][1] = R[3][2] = 0.f;
R[3][3] = 1.f;
}
*/
impl<T: AbsDiffEq> AbsDiffEq for Quaternion<T>
where
T::Epsilon: Copy,
{
type Epsilon = T::Epsilon;
fn default_epsilon() -> T::Epsilon {
T::default_epsilon()
}
fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool {
T::abs_diff_eq(&self.w, &other.w, epsilon)
&& T::abs_diff_eq(&self.x, &other.x, epsilon)
&& T::abs_diff_eq(&self.y, &other.y, epsilon)
&& T::abs_diff_eq(&self.z, &other.z, epsilon)
}
}
impl<T: UlpsEq> UlpsEq for Quaternion<T>
where
T::Epsilon: Copy,
{
fn default_max_ulps() -> u32 {
T::default_max_ulps()
}
fn ulps_eq(&self, other: &Self, epsilon: T::Epsilon, max_ulps: u32) -> bool {
T::ulps_eq(&self.w, &other.w, epsilon, max_ulps)
&& T::ulps_eq(&self.x, &other.x, epsilon, max_ulps)
&& T::ulps_eq(&self.y, &other.y, epsilon, max_ulps)
&& T::ulps_eq(&self.z, &other.z, epsilon, max_ulps)
}
}
impl<T: RelativeEq> RelativeEq for Quaternion<T>
where
T::Epsilon: Copy,
{
fn default_max_relative() -> T::Epsilon {
T::default_max_relative()
}
fn relative_eq(
&self,
other: &Self,
epsilon: T::Epsilon,
max_relative: T::Epsilon,
) -> bool {
T::relative_eq(&self.w, &other.w, epsilon, max_relative)
&& T::relative_eq(&self.x, &other.x, epsilon, max_relative)
&& T::relative_eq(&self.y, &other.y, epsilon, max_relative)
&& T::relative_eq(&self.z, &other.z, epsilon, max_relative)
}
}
#[cfg(feature = "bytemuck")]
unsafe impl<T> bytemuck::Zeroable for Quaternion<T> where T: bytemuck::Zeroable, Vec4<T>: bytemuck::Zeroable {
fn zeroed() -> Self {
Self {
x: T::zeroed(),
y: T::zeroed(),
z: T::zeroed(),
w: T::zeroed(),
}
}
}
#[cfg(feature = "bytemuck")]
unsafe impl<T> bytemuck::Pod for Quaternion<T> where T: bytemuck::Pod {
// Nothing here
}
};
}
#[cfg(all(nightly, feature="repr_simd"))]
pub mod repr_simd {
//! `Quaternion`s which are marked `#[repr(simd)]`.
use super::*;
use super::super::vec::repr_c::{Vec3 as CVec3, Vec4 as CVec4};
quaternion_complete_mod!(repr_simd #[repr(simd)]);
quaternion_vec3_vec4!(Vec3 Vec4);
quaternion_vec3_vec4!(CVec3 CVec4);
}
pub mod repr_c {
//! `Quaternion`s which are marked `#[repr(C)]`.
use super::*;
quaternion_complete_mod!(repr_c #[repr(C)]);
quaternion_vec3_vec4!(Vec3 Vec4);
#[cfg(all(nightly, feature="repr_simd"))]
use super::super::vec::repr_simd::{Vec3 as SimdVec3, Vec4 as SimdVec4};
#[cfg(all(nightly, feature="repr_simd"))]
quaternion_vec3_vec4!(SimdVec3 SimdVec4);
}
pub use self::repr_c::*;
#[cfg(test)]
mod tests {
use super::Quaternion;
use crate::vec::Vec3;
// Ensures that quaternions generated by our API are normalized.
mod is_normalized {
use super::*;
#[test] fn mul_quat() {
let a = Quaternion::rotation_3d(5_f32, Vec3::new(2_f32, 3., 5.)).normalized();
let b = Quaternion::rotation_3d(3_f32, Vec3::new(1_f32, 5., 20.)).normalized();
assert_relative_eq!((a * b).magnitude(), 1.);
}
#[test] fn rotation_from_to_3d() {
let a = Vec3::new(1_f32, 200., 3.);
let b = Vec3::new(80_f32, 0., 352.);
let q = Quaternion::<f32>::rotation_from_to_3d(a, b);
assert_relative_eq!(q.magnitude(), 1.);
}
#[test] fn rotation_3d() {
let v = Vec3::new(1_f32, 200., 3.);
let q = Quaternion::rotation_3d(3_f32, v);
assert_relative_eq!(q.magnitude(), 1.);
}
#[test] fn slerp() {
let a = Quaternion::rotation_3d(5_f32, Vec3::new(2_f32, 3., 5.)).normalized();
let b = Quaternion::rotation_3d(3_f32, Vec3::new(1_f32, 5., 20.)).normalized();
let count = 32;
for i in 0..(count+1) {
let q = Quaternion::slerp(a, b, i as f32 / (count as f32));
assert_relative_eq!(q.magnitude(), 1.);
}
}
}
}