Struct static_math::dual_quaternion::DualQuaternion

pub struct DualQuaternion<T> { /* fields omitted */ }

Implementations

impl<T> DualQuaternion<T>

pub const fn new(q_real: Quaternion<T>, q_dual: Quaternion<T>) -> Self

impl<T: Num + Copy> DualQuaternion<T>

pub fn real(&self) -> Quaternion<T>

Get the real Quaternion part

pub fn dual(&self) -> Quaternion<T>

Get the dual Quaternion part

pub fn new_from_rotation(r: &Quaternion<T>) -> Self

Create a pure rotation transformation from a given Quaternion

pub fn new_from_point(v: &V3<T>) -> Self

Create a Dual Quaternion that represent a point when the real part is a unit and the dual part is a pure Quaternion

impl<T: Float + Signed> DualQuaternion<T>

pub fn to_homogeneous(&self) -> M44<T>

Convert the DualQuaternion to a homogeneus transformation matrix M44<Float> in SE(3)

pub fn inverse(&self) -> Self

Calculate the inverse of the DualQuaternion

pub fn get_screw_parameters(&self) -> (V3<T>, V3<T>, T, T)

Get the screw parameters from this DualQuaternion the implementation follow the following paper: “Dual Quaternions” by Yan-Bin Jia

Output: l: V3 a unit 3d vector that represent one of the plucker coordinates m: V3 a vector in 3d that represent the moment of the line l and his norm represent the distance from the origin to the line theta: Float the amount of rotation around the screw axis l d: Float the amount of translation along the screw axis l

pub fn new_from_screw_parameters(l: &V3<T>, m: &V3<T>, theta: T, d: T) -> Self

Create a DualQuaternion from the screw parameters

Function arguments: l: a unit vector that represent the screw axis

m: screw axis moment that its perpendicular to l (m * l = 0) and the norm represent the actual moment

theta: screw angle, represent the amount of rotation around the screw axis

d: screw displacement, represent the amount of displacement along the screw axis

pub fn pow(&self, exponent: T) -> Self

Compute the power of the DualQuaternion

Function arguments: exponent: Float the exponent to raise the power

Output: Self^(exponent)

pub fn screw_lerp(begin: &Self, end: &Self, tau: T) -> Self

Screw Linear Interpolation: is an extension of the spherical linear interpolation (SLERP) over Quaternions. It performs a screw motion with constant rotation and translation speeds from begin to end

Function arguments: begin: DualQuaternion<Float> the first “point” for the interpolation end: DualQuaternion<Float> the second “point” for the interpolation tau: Float in [0, 1] representing how far along and around the screw axis to interpolate

pub fn log(&self) -> Option<Self>

impl<T: Float> DualQuaternion<T>

pub fn new_from_array(array: [T; 7]) -> Self

Create a DualQuaternion from an array that encodes a Quaternion and a 3d vecto (V3)

pub fn new_from_translation(t: &V3<T>) -> Self

Create a DualQuaternion that represent a pure translation transformation

pub fn new_from_rot_trans(rot: &Quaternion<T>, translation: &V3<T>) -> Self

Create a new DualQuaternion from a rotation(Quaternion) and translation(V3)

pub fn is_normalized(&self) -> bool

impl<T: Float + FloatConst + Sum> DualQuaternion<T>

pub fn normalize(&self) -> Option<Self>

Normalize the DualQuaternion only if necessary

pub fn new_from_homogeneous(t: &M44<T>) -> Self

Create a new DualQuaternion from a homogeneous transformation matrix in SE(3)

pub fn new_from_rotation_matrix(m: &M33<T>) -> Self

Create a DualQuaternion that represent a rotation pure transformation

impl<T: Num + Copy + Signed> DualQuaternion<T>

pub fn conj(&self) -> Self

Calculate the conjugate of the DualQuaternion

pub fn conj_as_dual(&self) -> Self

Calculate the dual number conjugation of the DualQuaternion

pub fn conj_combined(&self) -> Self

Calculate the combined(as a dual number and Quaternion) conjugation of the DualQuaternion

pub fn norm(&self) -> Self

Calculate the norm of the DualQuaternion

pub fn to_rotation_translation(&self) -> (M33<T>, V3<T>)

Get the underlying rotation and translation from the DualQuaternion

pub fn get_translation(&self) -> V3<T>

Get the underlying translation from the DualQuaternion

pub fn to_quaternion_translation(&self) -> (Quaternion<T>, V3<T>)

Get the underlying Quaternion and translation from the DualQuaternion

pub fn transform_point(&self, point: &V3<T>) -> V3<T>

Transform the given point in 3D with the transformation that represent this DualQuaternion like a homogeneous transformation in SE(3)

impl<T: Num + Copy> DualQuaternion<T>

pub fn new_from_vecs(q_real: &V4<T>, q_dual: &V4<T>) -> Self

Construct a new DualQuaternion from two V4

pub fn zero() -> Self

construct a zero DualQuaternion

pub fn one() -> DualQuaternion<T>

construct a unit DualQuaternion

Trait Implementations

impl<T: Num + Copy> Add<DualQuaternion<T>> for DualQuaternion<T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl<T: Clone> Clone for DualQuaternion<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DualQuaternion<T>

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

Formats the value using the given formatter.

impl<T: Num + Display> Display for DualQuaternion<T>

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

Formats the value using the given formatter.

impl<T: Float + Signed> Div<DualQuaternion<T>> for DualQuaternion<T>

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Num + Copy> Mul<DualQuaternion<T>> for DualQuaternion<T>

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Num + Copy> Mul<T> for DualQuaternion<T>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: Num + Copy + Signed> Neg for DualQuaternion<T>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: Num + Copy> One for DualQuaternion<T>

fn one() -> Self

Create an identity DualQuaternion

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<T: PartialEq> PartialEq<DualQuaternion<T>> for DualQuaternion<T>

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

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

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

This method tests for !=.

impl<T: Num + Copy> Sub<DualQuaternion<T>> for DualQuaternion<T>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl<T: Num + Copy> Zero for DualQuaternion<T>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: Copy> Copy for DualQuaternion<T>

impl<T> StructuralPartialEq for DualQuaternion<T>