Struct ultraviolet::rotor::Rotor2

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: f32

bv: Bivec2

Methods

impl Rotor2

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

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

Construct a Rotor that rotates one vector to another.

pub fn from_angle_plane(planeangle: Bivec2) -> Self

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.

This is the equivalent of an axis-angle rotation. The plane bivector must be normalizes.

pub fn mag_sq(&self) -> f32

pub fn mag(&self) -> f32

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

pub fn reverse(&mut self)

pub fn reversed(&self) -> Self

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

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

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)

Rotates a vector by this rotor.

self must be normalized!

pub fn into_matrix(self) -> Mat2

Trait Implementations

impl Lerp<f32> for Rotor2

fn lerp(&self, end: Self, t: f32) -> Self

impl From<Rotor2> for Mat2

fn from(rotor: Rotor2) -> Mat2

Performs the conversion.

impl Clone for Rotor2

fn clone(&self) -> Rotor2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Rotor2

impl Debug for Rotor2

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

Formats the value using the given formatter.

impl Sub<Rotor2> for Rotor2

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Add<Rotor2> for Rotor2

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Mul<Rotor2> for Rotor2

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.

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

Performs the * operation.

impl Mul<Vec2> for Rotor2

type Output = Vec2

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2) -> Vec2

Performs the * operation.

impl Mul<f32> for Rotor2

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Rotor2> for f32

type Output = Rotor2

The resulting type after applying the * operator.

fn mul(self, rotor: Rotor2) -> Rotor2

Performs the * operation.

impl AddAssign<Rotor2> for Rotor2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl SubAssign<Rotor2> for Rotor2

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl MulAssign<f32> for Rotor2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.