Struct rin::math::geometry::DualQuaternion

#[repr(C)]
pub struct DualQuaternion<N> where
    N: SimdRealField,  {
    pub real: Quaternion<N>,
    pub dual: Quaternion<N>,
}

A dual quaternion.

Indexing

DualQuaternions are stored as [..real, ..dual]. Both of the quaternion components are laid out in i, j, k, w order.

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);

let dq = DualQuaternion::from_real_and_dual(real, dual);
assert_eq!(dq[0], 2.0);
assert_eq!(dq[1], 3.0);

assert_eq!(dq[4], 6.0);
assert_eq!(dq[7], 5.0);

NOTE: As of December 2020, dual quaternion support is a work in progress. If a feature that you need is missing, feel free to open an issue or a PR. See https://github.com/dimforge/nalgebra/issues/487

Fields

real: Quaternion<N>

The real component of the quaternion

dual: Quaternion<N>

The dual component of the quaternion

Implementations

impl<N> DualQuaternion<N> where
    N: SimdRealField,
    <N as SimdValue>::Element: SimdRealField, 

#[must_use = "Did you mean to use normalize_mut()?"]

pub fn normalize(&self) -> DualQuaternion<N>

Normalizes this quaternion.

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let dq = DualQuaternion::from_real_and_dual(real, dual);

let dq_normalized = dq.normalize();

relative_eq!(dq_normalized.real.norm(), 1.0);

pub fn normalize_mut(&mut self)

Normalizes this quaternion.

Example

let real = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let dual = Quaternion::new(5.0, 6.0, 7.0, 8.0);
let mut dq = DualQuaternion::from_real_and_dual(real, dual);

dq.normalize_mut();

relative_eq!(dq.real.norm(), 1.0);

impl<N> DualQuaternion<N> where
    N: SimdRealField, 

pub fn from_real_and_dual(
    real: Quaternion<N>,
    dual: Quaternion<N>
) -> DualQuaternion<N>

Creates a dual quaternion from its rotation and translation components.

Example

let rot = Quaternion::new(1.0, 2.0, 3.0, 4.0);
let trans = Quaternion::new(5.0, 6.0, 7.0, 8.0);

let dq = DualQuaternion::from_real_and_dual(rot, trans);
assert_eq!(dq.real.w, 1.0);

pub fn identity() -> DualQuaternion<N>

The dual quaternion multiplicative identity

Example

let dq1 = DualQuaternion::identity();
let dq2 = DualQuaternion::from_real_and_dual(
    Quaternion::new(1.,2.,3.,4.),
    Quaternion::new(5.,6.,7.,8.)
);

assert_eq!(dq1 * dq2, dq2);
assert_eq!(dq2 * dq1, dq2);

Trait Implementations

impl<N> Add<DualQuaternion<N>> for DualQuaternion<N> where
    N: SimdRealField,
    <N as SimdValue>::Element: SimdRealField, 

type Output = DualQuaternion<N>

The resulting type after applying the + operator.

pub fn add(
    self,
    rhs: DualQuaternion<N>
) -> <DualQuaternion<N> as Add<DualQuaternion<N>>>::Output

Performs the + operation.

impl<N> AsMut<[N; 8]> for DualQuaternion<N> where
    N: SimdRealField, 

pub fn as_mut(&mut self) -> &mut [N; 8]

Performs the conversion.

impl<N> AsRef<[N; 8]> for DualQuaternion<N> where
    N: SimdRealField, 

pub fn as_ref(&self) -> &[N; 8]

Performs the conversion.

impl<N> Clone for DualQuaternion<N> where
    N: Clone + SimdRealField, 

pub fn clone(&self) -> DualQuaternion<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for DualQuaternion<N> where
    N: Debug + SimdRealField, 

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

Formats the value using the given formatter.

impl<N> Default for DualQuaternion<N> where
    N: Default + SimdRealField, 

pub fn default() -> DualQuaternion<N>

Returns the “default value” for a type.

impl<'a, N> Deserialize<'a> for DualQuaternion<N> where
    N: SimdRealField + Deserialize<'a>, 

pub fn deserialize<Des>(
    deserializer: Des
) -> Result<DualQuaternion<N>, <Des as Deserializer<'a>>::Error> where
    Des: Deserializer<'a>, 

Deserialize this value from the given Serde deserializer.

impl<N> Index<usize> for DualQuaternion<N> where
    N: SimdRealField, 

type Output = N

The returned type after indexing.

pub fn index(&self, i: usize) -> &<DualQuaternion<N> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl<N> IndexMut<usize> for DualQuaternion<N> where
    N: SimdRealField, 

pub fn index_mut(&mut self, i: usize) -> &mut N

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

impl<N> Mul<DualQuaternion<N>> for DualQuaternion<N> where
    N: SimdRealField,
    <N as SimdValue>::Element: SimdRealField, 

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

pub fn mul(
    self,
    rhs: DualQuaternion<N>
) -> <DualQuaternion<N> as Mul<DualQuaternion<N>>>::Output

Performs the * operation.

impl<N> Mul<N> for DualQuaternion<N> where
    N: SimdRealField,
    <N as SimdValue>::Element: SimdRealField, 

type Output = DualQuaternion<N>

The resulting type after applying the * operator.

pub fn mul(self, rhs: N) -> <DualQuaternion<N> as Mul<N>>::Output

Performs the * operation.

impl<N> PartialEq<DualQuaternion<N>> for DualQuaternion<N> where
    N: PartialEq<N> + SimdRealField, 

pub fn eq(&self, other: &DualQuaternion<N>) -> bool

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

pub fn ne(&self, other: &DualQuaternion<N>) -> bool

This method tests for !=.

impl<N> Serialize for DualQuaternion<N> where
    N: SimdRealField + Serialize, 

pub 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<N> Sub<DualQuaternion<N>> for DualQuaternion<N> where
    N: SimdRealField,
    <N as SimdValue>::Element: SimdRealField, 

type Output = DualQuaternion<N>

The resulting type after applying the - operator.

pub fn sub(
    self,
    rhs: DualQuaternion<N>
) -> <DualQuaternion<N> as Sub<DualQuaternion<N>>>::Output

Performs the - operation.

impl<N> Copy for DualQuaternion<N> where
    N: Copy + SimdRealField, 

impl<N> Eq for DualQuaternion<N> where
    N: Eq + SimdRealField, 

impl<N> StructuralEq for DualQuaternion<N> where
    N: SimdRealField, 

impl<N> StructuralPartialEq for DualQuaternion<N> where
    N: SimdRealField,