Struct fmath::types::Quaternion

source · [−]

pub struct Quaternion { /* private fields */ }

Expand description

Quaternion

Compact way to represent rotations without gimbal lock.

Implements: Clone, Copy, PartialEq, Debug

Implementations

source

impl Quaternion

source

pub fn new(scalar: f32, x: f32, y: f32, z: f32) -> Self

Create new Quaternion from given scalar and x y z values

source

pub fn from_scalar_vector(scalar: f32, v: Vector3) -> Self

Create new Quaternion from given scalar and Vector3

source

pub fn from_array(components: [f32 ; 4]) -> Self

Create new Quaternion from f32;4

0 = scalar

1 2 3 = vector

source

pub fn from_euler_angles(euler: Vector3) -> Self

Create new Quaternion from given euler angles (Vector3)

Angles in Radians

source

pub fn as_euler_angles(&self) -> Vector3

Get Quaternion rotation as euler angles

Angles in Radians

Note: if Quaternion was created from euler angles, this euler angles representation might not have the same values as the original

source

pub fn as_array(&self) -> &[f32 ; 4]

Get Quaternion values as f32 array

0 = scalar

1 2 3 = vector

source

pub fn sqr_magnitude(&self) -> f32

Returns: Quaternion length without applying square root

alias: norm

source

pub fn norm(&self) -> f32

Returns: Quaternion length without applying square root

alias: sqr_magnitude

source

pub fn magnitude(&self) -> f32

Returns: Quaternion length

source

pub fn normalize(&self) -> Result<Self, String>

Returns: normalization result

Ok: if Quaternion’s norm is not zero.

Err: if Quaternion’s norm is zero.

source

pub fn conjugate(&self) -> Self

Returns: new Quaternion with the same magtinude but the sign of the imaginary components flipped

Trait Implementations

source

impl Add<Quaternion> for Quaternion

type Output = Quaternion

The resulting type after applying the + operator.

source

fn add(self, rhs: Self) -> Self

Performs the + operation. Read more

source

impl Clone for Quaternion

source

fn clone(&self) -> Quaternion

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Quaternion

source

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

Formats the value using the given formatter. Read more

source

impl Display for Quaternion

source

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

Formats the value using the given formatter. Read more

source

impl Div<f32> for Quaternion

type Output = Quaternion

The resulting type after applying the / operator.

source

fn div(self, rhs: f32) -> Self

Performs the / operation. Read more

source

impl Index<usize> for Quaternion

type Output = f32

The returned type after indexing.

source

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more

source

impl IndexMut<usize> for Quaternion

source

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

source

impl Mul<Quaternion> for Quaternion

type Output = Quaternion

The resulting type after applying the * operator.

source

fn mul(self, rhs: Self) -> Self

Performs the * operation. Read more

source

impl Mul<Vector3> for Quaternion

type Output = Vector3

The resulting type after applying the * operator.

source

fn mul(self, rhs: Vector3) -> Vector3

Performs the * operation. Read more

source

impl Mul<f32> for Quaternion

type Output = Quaternion

The resulting type after applying the * operator.

source

fn mul(self, rhs: f32) -> Self

Performs the * operation. Read more

source

impl PartialEq<Quaternion> for Quaternion

source

fn eq(&self, other: &Quaternion) -> bool

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

source

fn ne(&self, other: &Quaternion) -> bool

This method tests for !=.

source

impl Sub<Quaternion> for Quaternion

type Output = Quaternion

The resulting type after applying the - operator.

source

fn sub(self, rhs: Self) -> Self

Performs the - operation. Read more

source

impl Copy for Quaternion

source

impl StructuralPartialEq for Quaternion

Auto Trait Implementations

impl RefUnwindSafe for Quaternion

impl Send for Quaternion

impl Sync for Quaternion

impl Unpin for Quaternion

impl UnwindSafe for Quaternion

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct fmath::types::Quaternion

Implementations

impl Quaternion

pub fn new(scalar: f32, x: f32, y: f32, z: f32) -> Self

pub fn from_scalar_vector(scalar: f32, v: Vector3) -> Self

pub fn from_array(components: [f32; 4]) -> Self

pub fn from_euler_angles(euler: Vector3) -> Self

pub fn as_euler_angles(&self) -> Vector3

pub fn as_array(&self) -> &[f32; 4]

pub fn sqr_magnitude(&self) -> f32

pub fn norm(&self) -> f32

pub fn magnitude(&self) -> f32

pub fn normalize(&self) -> Result<Self, String>

pub fn conjugate(&self) -> Self

Trait Implementations

impl Add<Quaternion> for Quaternion

type Output = Quaternion

fn add(self, rhs: Self) -> Self

impl Clone for Quaternion

fn clone(&self) -> Quaternion

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

impl Debug for Quaternion

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

impl Display for Quaternion

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

impl Div<f32> for Quaternion

type Output = Quaternion

fn div(self, rhs: f32) -> Self

impl Index<usize> for Quaternion

type Output = f32

fn index(&self, index: usize) -> &Self::Output

impl IndexMut<usize> for Quaternion

fn index_mut(&mut self, index: usize) -> &mut Self::Output

impl Mul<Quaternion> for Quaternion

type Output = Quaternion

fn mul(self, rhs: Self) -> Self

impl Mul<Vector3> for Quaternion

type Output = Vector3

fn mul(self, rhs: Vector3) -> Vector3

impl Mul<f32> for Quaternion

type Output = Quaternion

fn mul(self, rhs: f32) -> Self

impl PartialEq<Quaternion> for Quaternion

fn eq(&self, other: &Quaternion) -> bool

fn ne(&self, other: &Quaternion) -> bool

impl Sub<Quaternion> for Quaternion

type Output = Quaternion

fn sub(self, rhs: Self) -> Self

impl Copy for Quaternion

impl StructuralPartialEq for Quaternion

Auto Trait Implementations

impl RefUnwindSafe for Quaternion

impl Send for Quaternion

impl Sync for Quaternion

impl Unpin for Quaternion

impl UnwindSafe for Quaternion

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

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

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn from_array(components: [f32 ; 4]) -> Self

pub fn as_array(&self) -> &[f32 ; 4]

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,