Struct ark_api::Quat

#[repr(C, align(16))]
pub struct Quat(_);

A quaternion representing an orientation.

This quaternion is intended to be of unit length but may denormalize due to floating point “error creep” which can occur when successive quaternion operations are applied.

This type is 16 byte aligned.

Implementations

impl Quat

pub const IDENTITY: Quat = Self(InnerF32::W)

The identity quaternion. Corresponds to no rotation.

pub const NAN: Quat = Self(<InnerF32 as crate::core::traits::scalar::NanConstEx>::NAN)

All NAN:s.

pub fn from_xyzw(x: f32, y: f32, z: f32, w: f32) -> Quat

Creates a new rotation quaternion.

This should generally not be called manually unless you know what you are doing. Use one of the other constructors instead such as identity or from_axis_angle.

from_xyzw is mostly used by unit tests and serde deserialization.

Preconditions

This function does not check if the input is normalized, it is up to the user to provide normalized input or to normalized the resulting quaternion.

pub fn from_array(a: [f32; 4]) -> Quat

Creates a rotation quaternion from an array.

Preconditions

This function does not check if the input is normalized, it is up to the user to provide normalized input or to normalized the resulting quaternion.

pub fn from_vec4(v: Vec4) -> Quat

Creates a new rotation quaternion from a 4D vector.

Preconditions

This function does not check if the input is normalized, it is up to the user to provide normalized input or to normalized the resulting quaternion.

pub fn from_slice(slice: &[f32]) -> Quat

Creates a rotation quaternion from a slice.

Preconditions

This function does not check if the input is normalized, it is up to the user to provide normalized input or to normalized the resulting quaternion.

Panics

Panics if slice length is less than 4.

pub fn write_to_slice(self, slice: &mut [f32])

Writes the quaternion to an unaligned slice.

Panics

Panics if slice length is less than 4.

pub fn from_axis_angle(axis: Vec3, angle: f32) -> Quat

Create a quaternion for a normalized rotation axis and angle (in radians). The axis must be normalized (unit-length).

Panics

Will panic if axis is not normalized when glam_assert is enabled.

pub fn from_scaled_axis(v: Vec3) -> Quat

Create a quaternion that rotates v.length() radians around v.normalize().

from_scaled_axis(Vec3::ZERO) results in the identity quaternion.

pub fn from_rotation_x(angle: f32) -> Quat

Creates a quaternion from the angle (in radians) around the x axis.

pub fn from_rotation_y(angle: f32) -> Quat

Creates a quaternion from the angle (in radians) around the y axis.

pub fn from_rotation_z(angle: f32) -> Quat

Creates a quaternion from the angle (in radians) around the z axis.

pub fn from_euler(euler: EulerRot, a: f32, b: f32, c: f32) -> Quat

Creates a quaternion from the given euler rotation sequence and the angles (in radians).

pub fn from_mat3(mat: &Mat3) -> Quat

Creates a quaternion from a 3x3 rotation matrix.

pub fn from_mat4(mat: &Mat4) -> Quat

Creates a quaternion from a 3x3 rotation matrix inside a homogeneous 4x4 matrix.

pub fn from_rotation_arc(from: Vec3, to: Vec3) -> Quat

Gets the minimal rotation for transforming from to to. The rotation is in the plane spanned by the two vectors. Will rotate at most 180 degrees.

The input vectors must be normalized (unit-length).

from_rotation_arc(from, to) * from ≈ to.

For near-singular cases (from≈to and from≈-to) the current implementation is only accurate to about 0.001 (for f32).

Panics

Will panic if from or to are not normalized when glam_assert is enabled.

pub fn from_rotation_arc_colinear(from: Vec3, to: Vec3) -> Quat

Gets the minimal rotation for transforming from to either to or -to. This means that the resulting quaternion will rotate from so that it is colinear with to.

The rotation is in the plane spanned by the two vectors. Will rotate at most 90 degrees.

The input vectors must be normalized (unit-length).

to.dot(from_rotation_arc_colinear(from, to) * from).abs() ≈ 1.

Panics

Will panic if from or to are not normalized when glam_assert is enabled.

pub fn from_rotation_arc_2d(from: Vec2, to: Vec2) -> Quat

Gets the minimal rotation for transforming from to to. The resulting rotation is around the z axis. Will rotate at most 180 degrees.

The input vectors must be normalized (unit-length).

from_rotation_arc_2d(from, to) * from ≈ to.

For near-singular cases (from≈to and from≈-to) the current implementation is only accurate to about 0.001 (for f32).

Panics

Will panic if from or to are not normalized when glam_assert is enabled.

pub fn to_axis_angle(self) -> (Vec3, f32)

Returns the rotation axis and angle (in radians) of self.

pub fn to_scaled_axis(self) -> Vec3

Returns the rotation axis scaled by the rotation in radians.

pub fn to_euler(self, euler: EulerRot) -> (f32, f32, f32)

Returns the rotation angles for the given euler rotation sequence.

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

[x, y, z, w]

pub fn xyz(self) -> Vec3

Returns the vector part of the quaternion.

pub fn conjugate(self) -> Quat

Returns the quaternion conjugate of self. For a unit quaternion the conjugate is also the inverse.

pub fn inverse(self) -> Quat

Returns the inverse of a normalized quaternion.

Typically quaternion inverse returns the conjugate of a normalized quaternion. Because self is assumed to already be unit length this method does not normalize before returning the conjugate.

Panics

Will panic if self is not normalized when glam_assert is enabled.

pub fn dot(self, other: Quat) -> f32

Computes the dot product of self and other. The dot product is equal to the the cosine of the angle between two quaternion rotations.

pub fn length(self) -> f32

Computes the length of self.

pub fn length_squared(self) -> f32

Computes the squared length of self.

This is generally faster than length() as it avoids a square root operation.

pub fn length_recip(self) -> f32

Computes 1.0 / length().

For valid results, self must not be of length zero.

pub fn normalize(self) -> Quat

Returns self normalized to length 1.0.

For valid results, self must not be of length zero.

Panics

Will panic if self is zero length when glam_assert is enabled.

pub fn is_finite(self) -> bool

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

pub fn is_nan(self) -> bool

pub fn is_normalized(self) -> bool

Returns whether self of length 1.0 or not.

Uses a precision threshold of 1e-6.

pub fn is_near_identity(self) -> bool

pub fn angle_between(self, other: Quat) -> f32

Returns the angle (in radians) for the minimal rotation for transforming this quaternion into another.

Both quaternions must be normalized.

Panics

Will panic if self or other are not normalized when glam_assert is enabled.

pub fn abs_diff_eq(self, other: Quat, max_abs_diff: f32) -> bool

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two quaternions contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

pub fn lerp(self, end: Quat, s: f32) -> Quat

Performs a linear interpolation between self and other based on the value s.

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to other.

Panics

Will panic if self or end are not normalized when glam_assert is enabled.

pub fn slerp(self, end: Quat, s: f32) -> Quat

Performs a spherical linear interpolation between self and end based on the value s.

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to end.

Panics

Will panic if self or end are not normalized when glam_assert is enabled.

pub fn mul_vec3(self, other: Vec3) -> Vec3

Multiplies a quaternion and a 3D vector, returning the rotated vector.

Panics

Will panic if self is not normalized when glam_assert is enabled.

pub fn mul_quat(self, other: Quat) -> Quat

Multiplies two quaternions. If they each represent a rotation, the result will represent the combined rotation.

Note that due to floating point rounding the result may not be perfectly normalized.

Panics

Will panic if self or other are not normalized when glam_assert is enabled.

pub fn mul_vec3a(self, other: Vec3A) -> Vec3A

Multiplies a quaternion and a 3D vector, returning the rotated vector.

pub fn as_f64(self) -> DQuat

pub fn from_affine3(mat: &Affine3A) -> Quat

Creates a quaternion from a 3x3 rotation matrix inside a 3D affine transform.

Trait Implementations

impl Add<Quat> for Quat

fn add(self, other: Quat) -> Quat

Adds two quaternions.

The sum is not guaranteed to be normalized.

Note that addition is not the same as combining the rotations represented by the two quaternions! That corresponds to multiplication.

type Output = Quat

The resulting type after applying the + operator.

impl AsMut<[f32; 4]> for Quat

fn as_mut(&mut self) -> &mut [f32; 4]

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

impl AsRef<[f32; 4]> for Quat

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

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

impl Clone for Quat

fn clone(&self) -> Quat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quat

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

Formats the value using the given formatter.

impl Default for Quat

fn default() -> Quat

Returns the “default value” for a type.

impl Deref for Quat

type Target = XYZW<f32>

The resulting type after dereferencing.

fn deref(&self) -> &<Quat as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Quat

fn deserialize<D>(
    deserializer: D
) -> Result<Quat, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Quat

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

Formats the value using the given formatter.

impl Div<f32> for Quat

fn div(self, other: f32) -> Quat

Divides a quaternion by a scalar value. The quotient is not guaranteed to be normalized.

type Output = Quat

The resulting type after applying the / operator.

impl From<Quat> for Vec4

fn from(q: Quat) -> Vec4

Converts to this type from the input type.

impl From<Quat> for XYZW<f32>

fn from(q: Quat) -> XYZW<f32>

Converts to this type from the input type.

impl Mul<Quat> for Quat

fn mul(self, other: Quat) -> Quat

Multiplies two quaternions. If they each represent a rotation, the result will represent the combined rotation.

Note that due to floating point rounding the result may not be perfectly normalized.

Panics

Will panic if self or other are not normalized when glam_assert is enabled.

type Output = Quat

The resulting type after applying the * operator.

impl Mul<Vec3> for Quat

fn mul(self, other: Vec3) -> <Quat as Mul<Vec3>>::Output

Multiplies a quaternion and a 3D vector, returning the rotated vector.

Panics

Will panic if self is not normalized when glam_assert is enabled.

type Output = Vec3

The resulting type after applying the * operator.

impl Mul<Vec3A> for Quat

type Output = Vec3A

The resulting type after applying the * operator.

fn mul(self, other: Vec3A) -> <Quat as Mul<Vec3A>>::Output

Performs the * operation.

impl Mul<f32> for Quat

fn mul(self, other: f32) -> Quat

Multiplies a quaternion by a scalar value.

The product is not guaranteed to be normalized.

type Output = Quat

The resulting type after applying the * operator.

impl MulAssign<Quat> for Quat

fn mul_assign(&mut self, other: Quat)

Multiplies two quaternions. If they each represent a rotation, the result will represent the combined rotation.

Note that due to floating point rounding the result may not be perfectly normalized.

Panics

Will panic if self or other are not normalized when glam_assert is enabled.

impl Neg for Quat

type Output = Quat

The resulting type after applying the - operator.

fn neg(self) -> Quat

Performs the unary - operation.

impl PartialEq<Quat> for Quat

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

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

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

This method tests for !=.

impl<'a> Product<&'a Quat> for Quat

fn product<I>(iter: I) -> Quat where
    I: Iterator<Item = &'a Quat>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

impl QuatExt for Quat

fn rotate_negative_z_towards(forward: Vec3, up: Vec3) -> Option<Quat>

Return a Quaternion that rotates -Z to the forward direction, using up to control roll, so that +Y will approximately point in the up direction.

fn rotate_positive_z_towards(forward: Vec3, up: Vec3) -> Option<Quat>

Return a Quaternion that rotates +Z to the forward direction, using up to control roll, so that +Y will approximately point in the up direction.

impl<'a, C> Readable<'a, C> for Quat where
    C: Context, 

fn read_from<R>(reader: &mut R) -> Result<Quat, <C as Context>::Error> where
    R: Reader<'a, C>, 

fn minimum_bytes_needed() -> usize

fn read_from_buffer(buffer: &'a [u8]) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer.

fn read_with_length_from_buffer(
    buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize) where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer while also returning the amount of bytes consumed.

fn read_from_buffer_copying_data(
    buffer: &[u8]
) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer.

fn read_with_length_from_buffer_copying_data(
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize) where
    Self: DefaultContext<Context = C>,
    C: Default, 

Deserializes from a given buffer while also returning the amount of bytes consumed.

fn read_from_stream_unbuffered(
    stream: impl Read
) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Reads from a given stream without any buffering.

fn read_from_stream_buffered(
    stream: impl Read
) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

Reads from a given stream with internal buffering.

fn read_from_file(path: impl AsRef<Path>) -> Result<Self, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn read_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx(
    context: C,
    buffer: &'a [u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx(
    context: C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut(
    context: &mut C,
    buffer: &[u8]
) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_stream_buffered_with_ctx<S>(
    context: C,
    stream: S
) -> Result<Self, <C as Context>::Error> where
    S: Read, 

fn read_from_file_with_ctx(
    context: C,
    path: impl AsRef<Path>
) -> Result<Self, <C as Context>::Error>

impl Serialize for Quat

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sub<Quat> for Quat

fn sub(self, other: Quat) -> Quat

Subtracts the other quaternion from self.

The difference is not guaranteed to be normalized.

type Output = Quat

The resulting type after applying the - operator.

impl<'a> Sum<&'a Quat> for Quat

fn sum<I>(iter: I) -> Quat where
    I: Iterator<Item = &'a Quat>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl ValueConverterTrait<Quat> for ValueConverter

fn into_value(v: Quat) -> Value

Wraps the passed-in value in a Value enum.

fn from_value(v: &Value) -> Quat

Extracts the value from a Value enum.

impl<C> Writable<C> for Quat where
    C: Context, 

fn write_to<T>(&self, writer: &mut T) -> Result<(), <C as Context>::Error> where
    T: Writer<C> + ?Sized, 

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

fn write_to_buffer(&self, buffer: &mut [u8]) -> Result<(), <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_vec(&self) -> Result<Vec<u8, Global>, <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_stream<S>(&self, stream: S) -> Result<(), <C as Context>::Error> where
    S: Write,
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_file(
    &self,
    path: impl AsRef<Path>
) -> Result<(), <C as Context>::Error> where
    Self: DefaultContext<Context = C>,
    C: Default, 

fn write_to_buffer_with_ctx(
    &self,
    context: C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut(
    &self,
    context: &mut C,
    buffer: &mut [u8]
) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx(
    &self,
    context: C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut(
    &self,
    context: &mut C
) -> Result<Vec<u8, Global>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>(
    &self,
    context: C,
    stream: S
) -> Result<(), <C as Context>::Error> where
    S: Write, 

fn write_to_file_with_ctx(
    &self,
    context: C,
    path: impl AsRef<Path>
) -> Result<(), <C as Context>::Error>

impl Copy for Quat