[][src]Struct ultraviolet::rotor::Rotor2x8

#[repr(C)]pub struct Rotor2x8 {
    pub s: f32x8,
    pub bv: Bivec2x8,
}

A Rotor in 2d space.

Please see the module level documentation for more information on rotors!

Fields

s: f32x8bv: Bivec2x8

Implementations

impl Rotor2x8[src]

pub const fn new(scalar: f32x8, bivector: Bivec2x8) -> Self[src]

pub fn identity() -> Self[src]

pub fn from_rotation_between(from: Vec2x8, to: Vec2x8) -> Self[src]

Construct a Rotor that rotates one vector to another.

pub fn from_angle_plane(angle: f32x8, plane: Bivec2x8) -> Self[src]

Construct a rotor given a bivector which defines a plane and rotation orientation, and a rotation angle.

plane must be normalized!

This is the equivalent of an axis-angle rotation.

pub fn from_angle(angle: f32x8) -> Self[src]

Construct a rotor given only an angle. This is possible in 2d since there is only one possible plane of rotation. However, there are two possible orientations. This function uses the common definition of positive angle in 2d as meaning the direction which brings the x unit vector towards the y unit vector.

pub fn mag_sq(&self) -> f32x8[src]

pub fn mag(&self) -> f32x8[src]

pub fn normalize(&mut self)[src]

pub fn normalized(&self) -> Self[src]

pub fn reverse(&mut self)[src]

pub fn reversed(&self) -> Self[src]

pub fn dot(&self, rhs: Self) -> f32x8[src]

pub fn rotate_by(&mut self, other: Self)[src]

Rotates this rotor by another rotor in-place. Note that if you are looking to compose rotations, you should NOT use this operation and rather just use regular left-multiplication like for matrix composition.

pub fn rotated_by(self, other: Self) -> Self[src]

Rotates this rotor by another rotor and returns the result. Note that if you are looking to compose rotations, you should NOT use this operation and rather just use regular left-multiplication like for matrix composition.

pub fn rotate_vec(self, vec: &mut Vec2x8)[src]

Rotates a vector by this rotor.

self must be normalized!

pub fn into_matrix(self) -> Mat2x8[src]

pub fn layout() -> Layout[src]

Trait Implementations

impl Add<Rotor2x8> for Rotor2x8[src]

type Output = Self

The resulting type after applying the + operator.

impl AddAssign<Rotor2x8> for Rotor2x8[src]

impl Clone for Rotor2x8[src]

impl Copy for Rotor2x8[src]

impl Debug for Rotor2x8[src]

impl Default for Rotor2x8[src]

impl Div<f32x8> for Rotor2x8[src]

type Output = Self

The resulting type after applying the / operator.

impl DivAssign<f32x8> for Rotor2x8[src]

impl From<Rotor2x8> for Mat2x8[src]

impl Lerp<f32x8> for Rotor2x8[src]

fn lerp(&self, end: Self, t: f32x8) -> Self[src]

Linearly interpolate between self and end by t between 0.0 and 1.0. i.e. (1.0 - t) * self + (t) * end.

For interpolating Rotors with linear interpolation, you almost certainly want to normalize the returned Rotor. For example,

let interpolated_rotor = rotor1.lerp(rotor2, 0.5).normalized();

For most cases (especially where perfomrance is the primary concern, like in animation interpolation for games, this 'normalized lerp' or 'nlerp' is probably what you want to use. However, there are situations in which you really want the interpolation between two Rotors to be of constant angular velocity. In this case, check out Slerp.

impl Mul<Isometry2x8> for Rotor2x8[src]

type Output = Isometry2x8

The resulting type after applying the * operator.

impl Mul<Rotor2x8> for Rotor2x8[src]

The composition of self with q, i.e. self * q gives the rotation as though you first perform q and then self.

type Output = Self

The resulting type after applying the * operator.

impl Mul<Rotor2x8> for f32x8[src]

type Output = Rotor2x8

The resulting type after applying the * operator.

impl Mul<Rotor2x8> for Isometry2x8[src]

type Output = Isometry2x8

The resulting type after applying the * operator.

impl Mul<Rotor2x8> for Similarity2x8[src]

type Output = Similarity2x8

The resulting type after applying the * operator.

impl Mul<Similarity2x8> for Rotor2x8[src]

type Output = Similarity2x8

The resulting type after applying the * operator.

impl Mul<Vec2x8> for Rotor2x8[src]

type Output = Vec2x8

The resulting type after applying the * operator.

impl Mul<f32x8> for Rotor2x8[src]

type Output = Self

The resulting type after applying the * operator.

impl MulAssign<f32x8> for Rotor2x8[src]

impl Slerp<f32x8> for Rotor2x8[src]

fn slerp(&self, end: Self, t: f32x8) -> Self[src]

Spherical-linear interpolation between self and end based on t from 0.0 to 1.0.

self and end should both be normalized or something bad will happen!

The implementation for SIMD types also requires that the two things being interpolated between are not exactly aligned, or else the result is undefined.

Basically, interpolation that maintains a constant angular velocity from one orientation on a unit hypersphere to another. This is sorta the "high quality" interpolation for Rotors, and it can also be used to interpolate other things, one example being interpolation of 3d normal vectors.

Note that you should often normalize the result returned by this operation, when working with Rotors, etc!

impl Sub<Rotor2x8> for Rotor2x8[src]

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<Rotor2x8> for Rotor2x8[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.