Struct polyhorn_ios::linalg::Quaternion3D

pub struct Quaternion3D<T> {
    pub x: T,
    pub y: T,
    pub z: T,
    pub w: T,
}

A 3D rotation quaternion.

Fields

x: T

The x-element of this quaternion.

y: T

The y-element of this quaternion.

z: T

The z-element of this quaternion.

w: T

The w-element of this quaternion.

Implementations

impl<T> Quaternion3D<T>

pub fn new(x: T, y: T, z: T, w: T) -> Quaternion3D<T>

Returns a new quaternion with the given elements.

pub fn map<F, O>(self, op: F) -> Quaternion3D<O> where
    F: FnMut(T) -> O, 

Applies the given transformation to each element of the given quaternion and returns the result.

pub fn as_ref(&self) -> Quaternion3D<&T>

Returns a new quaternion with references to each of the original elements. This is particularly useful when T does not implement Copy.

impl<T> Quaternion3D<T> where
    T: Float, 

pub fn with_angle(angle: T, rx: T, ry: T, rz: T) -> Quaternion3D<T>

Converts the rotation with the given angle radians around a vector with the given coordinates, into a quaternion with the corresponding elements.

pub fn dot(&self, other: &Quaternion3D<T>) -> T

Computes the inner product of this quaternion and the given quaternion.

pub fn mix(self, weight: T, other: Quaternion3D<T>) -> Quaternion3D<T>

Interpolates between the given quaternions with the given weight. If the weight is one, self is returned. If the weight is zero, other is returned.

pub fn addition(&self, other: &Quaternion3D<T>) -> Quaternion3D<T>

Returns the element-wise addition of this quaternion and the given quaternion.

pub fn subtract(&self, other: &Quaternion3D<T>) -> Quaternion3D<T>

Returns the element-wise subtraction of this quaternion and the given quaternion.

Trait Implementations

impl<T> Clone for Quaternion3D<T> where
    T: Clone, 

fn clone(&self) -> Quaternion3D<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Copy for Quaternion3D<T> where
    T: Copy, 

impl<T> Debug for Quaternion3D<T> where
    T: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Default for Quaternion3D<T> where
    T: Default, 

fn default() -> Quaternion3D<T>

Returns the "default value" for a type.

impl<T> Eq for Quaternion3D<T> where
    T: Eq, 

impl<T> Index<usize> for Quaternion3D<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &<Quaternion3D<T> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Quaternion3D<T>

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Quaternion3D<T> as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.

impl<T> PartialEq<Quaternion3D<T>> for Quaternion3D<T> where
    T: PartialEq<T>, 

fn eq(&self, other: &Quaternion3D<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Quaternion3D<T>) -> bool

This method tests for !=.

impl<T> StructuralEq for Quaternion3D<T>

impl<T> StructuralPartialEq for Quaternion3D<T>