Struct Quaternion

#[repr(C)]
pub struct Quaternion {
    pub x: f32,
    pub y: f32,
    pub z: f32,
    pub w: f32,
}

Unit quaternion to represent 3D rotations.

See also Quaternion in the Godot documentation.

Godot docs

Quaternion (stable)

Fields

x: f32

y: f32

z: f32

w: f32

Implementations

impl Quaternion

pub const IDENTITY: Quaternion

The identity quaternion, representing no rotation. This has the same rotation as Basis::IDENTITY.

If a Vector3 is rotated (multiplied) by this quaternion, it does not change.

pub fn new(x: f32, y: f32, z: f32, w: f32) -> Quaternion

pub fn from_axis_angle(axis: Vector3, angle: f32) -> Quaternion

Creates a quaternion from a Vector3 and an angle.

Panics

If the vector3 is not normalized.

pub fn from_rotation_arc(arc_from: Vector3, arc_to: Vector3) -> Quaternion

Constructs a Quaternion representing the shortest arc between arc_from and arc_to.

These can be imagined as two points intersecting a unit sphere’s surface, with a radius of 1.0.

The inputs must be unit vectors.

For near-singular cases (arc_from≈arc_to or arc_from≈-arc_to) the current implementation is only accurate to about 0.001, or better if double-precision is enabled.

Godot equivalent: Quaternion(arc_from: Vector3, arc_to: Vector3)

pub fn angle_to(self, to: Quaternion) -> f32

pub fn dot(self, with: Quaternion) -> f32

pub fn exp(self) -> Quaternion

pub fn to_exp(self) -> Quaternion

👎Deprecated: Moved to Quaternion::exp()

pub fn from_euler(euler: Vector3) -> Quaternion

pub fn get_angle(self) -> f32

pub fn get_axis(self) -> Vector3

pub fn to_euler(self, order: EulerOrder) -> Vector3

pub fn inverse(self) -> Quaternion

pub fn is_finite(self) -> bool

pub fn is_normalized(self) -> bool

pub fn length(self) -> f32

pub fn length_squared(self) -> f32

pub fn log(self) -> Quaternion

pub fn normalized(self) -> Quaternion

Panics

If the quaternion has length of 0.

pub fn slerp(self, to: Quaternion, weight: f32) -> Quaternion

Panics

If either quaternion is not normalized.

pub fn slerpni(self, to: Quaternion, weight: f32) -> Quaternion

Panics

If either quaternion is not normalized.

pub fn spherical_cubic_interpolate( self, b: Quaternion, pre_a: Quaternion, post_b: Quaternion, weight: f32, ) -> Quaternion

Panics

If any quaternions are not normalized.

pub fn spherical_cubic_interpolate_in_time( self, b: Quaternion, pre_a: Quaternion, post_b: Quaternion, weight: f32, b_t: f32, pre_a_t: f32, post_b_t: f32, ) -> Quaternion

Panics

If any quaternions are not normalized.

Trait Implementations

impl Add for Quaternion

type Output = Quaternion

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Quaternion

fn add_assign(&mut self, other: Quaternion)

Performs the += operation.

impl ApproxEq for Quaternion

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

impl Clone for Quaternion

fn clone(&self) -> Quaternion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Quaternion

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

Formats the value using the given formatter.

impl Default for Quaternion

fn default() -> Quaternion

Returns the “default value” for a type.

impl Display for Quaternion

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

Formats the value using the given formatter.

impl Div<f32> for Quaternion

type Output = Quaternion

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Quaternion

fn div_assign(&mut self, other: f32)

Performs the /= operation.

impl Export for Quaternion

fn export_hint() -> PropertyHintInfo

The export info to use for an exported field of this type, if no other export info is specified.

impl FromGodot for Quaternion

fn try_from_godot( via: <Quaternion as GodotConvert>::Via, ) -> Result<Quaternion, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a Variant, returning Err on failure.

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a Variant.

impl GodotConvert for Quaternion

type Via = Quaternion

The type through which Self is represented in Godot.

impl Mul<Vector3> for Quaternion

fn mul(self, rhs: Vector3) -> <Quaternion as Mul<Vector3>>::Output

Applies the quaternion’s rotation to the 3D point represented by the vector.

Panics

If the quaternion is not normalized.

type Output = Vector3

The resulting type after applying the * operator.

impl Mul<f32> for Quaternion

type Output = Quaternion

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Quaternion

type Output = Quaternion

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Quaternion

fn mul_assign(&mut self, other: f32)

Performs the *= operation.

impl MulAssign for Quaternion

fn mul_assign(&mut self, other: Quaternion)

Performs the *= operation.

impl Neg for Quaternion

type Output = Quaternion

The resulting type after applying the - operator.

fn neg(self) -> Quaternion

Performs the unary - operation.

impl ParamType for Quaternion

fn owned_to_arg<'v>(self) -> <Quaternion as ParamType>::Arg<'v>

Converts an owned value to the canonical argument type, which can be passed to impl AsArg<T>.

impl PartialEq for Quaternion

fn eq(&self, other: &Quaternion) -> 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 Sub for Quaternion

type Output = Quaternion

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Quaternion

fn sub_assign(&mut self, other: Quaternion)

Performs the -= operation.

impl ToGodot for Quaternion

type ToVia<'v> = <Quaternion as GodotConvert>::Via

Target type of to_godot(), which can differ from Via for pass-by-reference types.

fn to_godot(&self) -> <Quaternion as ToGodot>::ToVia<'_>

Converts this type to the Godot type by reference, usually by cloning.

fn to_variant(&self) -> Variant

Converts this type to a Variant.

impl Var for Quaternion

fn get_property(&self) -> <Quaternion as GodotConvert>::Via

fn set_property(&mut self, value: <Quaternion as GodotConvert>::Via)

fn var_hint() -> PropertyHintInfo

Specific property hints, only override if they deviate from GodotType::property_info, e.g. for enums/newtypes.

impl ArrayElement for Quaternion

impl AsArg<Quaternion> for Quaternion

impl Copy for Quaternion

impl GodotType for Quaternion

impl StructuralPartialEq for Quaternion