maliput::math

Struct Quaternion

Source
pub struct Quaternion { /* private fields */ }
Expand description

A quaternion. Wrapper around C++ implementation maliput::math::Quaternion.

Implementations§

Source§

impl Quaternion

Source

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

Create a new Quaternion with the given w, x, y, and z components. The w component is the real part of the quaternion. The x, y, and z components are the imaginary parts of the quaternion.

Source

pub fn w(&self) -> f64

Get the w component of the Quaternion.

Source

pub fn x(&self) -> f64

Get the x component of the Quaternion.

Source

pub fn y(&self) -> f64

Get the y component of the Quaternion.

Source

pub fn z(&self) -> f64

Get the z component of the Quaternion.

Source

pub fn vec(&self) -> Vector3

Returns this quaternion Vector.

Source

pub fn coeffs(&self) -> Vector4

Returns this quaternion coefficients.

Source

pub fn dot(&self, other: &Quaternion) -> f64

Get the dot product of the Quaternion with another Quaternion.

Source

pub fn angular_distance(&self, other: &Quaternion) -> f64

Get the angular distance between the Quaternion and another Quaternion.

Source

pub fn norm(&self) -> f64

Get the norm of the Quaternion.

Source

pub fn normalize(&mut self)

Normalize the Quaternion.

Source

pub fn squared_norm(&self) -> f64

Get the squared norm of the Quaternion.

Source

pub fn inverse(&self) -> Quaternion

Get the inverse of the Quaternion.

Source

pub fn conjugate(&self) -> Quaternion

Get the conjugate of the Quaternion.

Source

pub fn to_rotation_matrix(&self) -> Matrix3

Get the rotation matrix representation of the Quaternion.

Source

pub fn transform_vector(&self, v: &Vector3) -> Vector3

Apply the Quaternion to a Vector3.

Trait Implementations§

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 PartialEq for Quaternion

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for Quaternion

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> 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<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.