[][src]Struct ultraviolet::rotor::Rotor2

#[repr(C)]pub struct Rotor2 {
    pub s: f32,
    pub bv: Bivec2,
}

A Rotor in 2d space.

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

Fields

s: f32bv: Bivec2

Methods

impl Rotor2[src]

pub fn new(scalar: f32, bivector: Bivec2) -> Self[src]

pub fn identity() -> Self[src]

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

Construct a Rotor that rotates one vector to another.

pub fn from_angle_plane(planeangle: Bivec2) -> Self[src]

Construct a rotor given a bivector which defines a plane, rotation orientation, and rotation angle. The bivector defines the plane and orientation, and its magnitude defines the angle of rotation in radians. In 2d, there is only one possible plane of rotation, but two possible orientations of rotation in that plane.

pub fn from_angle(angle: f32) -> 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) -> f32[src]

pub fn mag(&self) -> f32[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 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 Vec2)[src]

Rotates a vector by this rotor.

self must be normalized!

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

pub fn layout() -> Layout[src]

Trait Implementations

impl Add<Rotor2> for Rotor2[src]

type Output = Self

The resulting type after applying the + operator.

impl AddAssign<Rotor2> for Rotor2[src]

impl Clone for Rotor2[src]

impl Copy for Rotor2[src]

impl Debug for Rotor2[src]

impl Default for Rotor2[src]

impl From<Rotor2> for Mat2[src]

impl Lerp<f32> for Rotor2[src]

impl Mul<Isometry2> for Rotor2[src]

type Output = Isometry2

The resulting type after applying the * operator.

impl Mul<Rotor2> for Rotor2[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<Rotor2> for f32[src]

type Output = Rotor2

The resulting type after applying the * operator.

impl Mul<Rotor2> for Isometry2[src]

type Output = Isometry2

The resulting type after applying the * operator.

impl Mul<Rotor2> for Similarity2[src]

type Output = Similarity2

The resulting type after applying the * operator.

impl Mul<Similarity2> for Rotor2[src]

type Output = Similarity2

The resulting type after applying the * operator.

impl Mul<Vec2> for Rotor2[src]

type Output = Vec2

The resulting type after applying the * operator.

impl Mul<f32> for Rotor2[src]

type Output = Self

The resulting type after applying the * operator.

impl MulAssign<f32> for Rotor2[src]

impl Sub<Rotor2> for Rotor2[src]

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<Rotor2> for Rotor2[src]

Auto Trait Implementations

impl RefUnwindSafe for Rotor2

impl Send for Rotor2

impl Sync for Rotor2

impl Unpin for Rotor2

impl UnwindSafe for Rotor2

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.