Struct Quat 

#[repr(C)]
pub struct Quat<T: QuatScalar> {
    pub x: T,
    pub y: T,
    pub z: T,
    pub w: T,
}

A quaternion type, representing a rotation in 3D space.

Fields

x: T

The x component of the quaternion.

y: T

The y component of the quaternion.

z: T

The z component of the quaternion.

w: T

The w component of the quaternion.

Implementations

impl<T: QuatScalar> Quat<T>

pub const IDENTITY: Self

The identity quaternion, representing no rotation.

pub const fn new(x: T, y: T, z: T, w: T) -> Self

Creates a new quaternion with the given components.

impl<T> Quat<T>

where T: QuatScalar,

pub const fn splat(scalar: T) -> Self

Creates a new instance of the tuple type with all elements set to the given scalar value.

pub const fn as_ptr(&self) -> *const T

Returns a raw pointer to the first element of the tuple.

pub const fn as_mut_ptr(&mut self) -> *mut T

Returns a mutable raw pointer to the first element of the tuple.

pub const fn as_slice(&self) -> &[T]

Returns a slice containing all elements of the tuple.

pub const fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing all elements of the tuple.

pub const fn to_array(self) -> [T; 4]

Converts the tuple into an array of its scalar elements.

pub const fn from_array(a: [T; 4]) -> Self

Creates a new instance of the tuple type from an array of scalar elements.

impl<T> Quat<T>

where T: QuatScalar,

pub fn dot(self, rhs: Self) -> T

Trait Implementations

impl<T> AbsDiffEq for Quat<T>

where T: QuatScalar + AbsDiffEq<Epsilon = T>,

type Epsilon = T

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T> AsMut<[T]> for Quat<T>

where T: QuatScalar,

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<[T]> for Quat<T>

where T: QuatScalar,

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + QuatScalar> Clone for Quat<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + QuatScalar> Copy for Quat<T>

impl<T: Debug + QuatScalar> Debug for Quat<T>

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

Formats the value using the given formatter.

impl<T> Default for Quat<T>

where T: QuatScalar,

fn default() -> Self

Returns the “default value” for a type.

impl<T> DotProduct for Quat<T>

where T: QuatScalar,

type Output = T

fn dot(self, rhs: Self) -> Self::Output

Computes the dot product of two values.

impl<T> From<Quat<T>> for [T; 4]

where T: QuatScalar,

fn from(t: Quat<T>) -> Self

Converts to this type from the input type.

impl<T> From<[T; 4]> for Quat<T>

where T: QuatScalar,

fn from(a: [T; 4]) -> Self

Converts to this type from the input type.

impl<T> HasScalar for Quat<T>

where T: QuatScalar,

type Scalar = T

The associated scalar type for the implementing type.

impl<T> Index<usize> for Quat<T>

where T: QuatScalar,

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Quat<T>

where T: QuatScalar,

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

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

impl<T> Neg for Quat<T>

where T: QuatScalar,

type Output = Quat<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T> Negate for Quat<T>

where T: QuatScalar,

fn negate(self) -> Self

Returns the additive inverse of the value.

impl<T: PartialEq + QuatScalar> PartialEq for Quat<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Quaternion for Quat<T>

where T: QuatScalar,

impl<T> RelativeEq for Quat<T>

where T: QuatScalar + RelativeEq<Epsilon = T>,

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<T> ScalarTuple for Quat<T>

where T: QuatScalar,

const LEN: usize = 4

The number of scalar elements in the tuple.

type Array = [T; 4]

The array type corresponding to the tuple, containing the same number of scalar elements.

fn splat(scalar: Self::Scalar) -> Self

Creates a new instance of the tuple type with all elements set to the given scalar value.

fn as_ptr(&self) -> *const Self::Scalar

Returns a raw pointer to the first element of the tuple.

fn as_mut_ptr(&mut self) -> *mut Self::Scalar

Returns a mutable raw pointer to the first element of the tuple.

fn as_slice(&self) -> &[Self::Scalar]

Returns a slice containing all elements of the tuple.

fn as_mut_slice(&mut self) -> &mut [Self::Scalar]

Returns a mutable slice containing all elements of the tuple.

fn to_array(self) -> Self::Array

Converts the tuple into an array of its scalar elements.

fn from_array(a: Self::Array) -> Self

Creates a new instance of the tuple type from an array of scalar elements.

impl<T: PartialEq + QuatScalar> StructuralPartialEq for Quat<T>

impl<T> UlpsEq for Quat<T>

where T: QuatScalar + UlpsEq<Epsilon = T>,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.