Struct ultraviolet::bivec::Bivec2

#[repr(C)]pub struct Bivec2 {
    pub xy: f32,
}

A bivector in 2d space.

Since in 2d there is only one plane in the whole of 2d space, a 2d bivector has only one component.

Please see the module level documentation for more information on bivectors generally!

Fields

xy: f32

Implementations

impl Bivec2

pub const fn new(xy: f32) -> Self

pub fn zero() -> Self

pub fn unit_xy() -> Self

pub fn mag_sq(&self) -> f32

pub fn mag(&self) -> f32

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

pub fn dot(&self, rhs: Self) -> f32

pub fn layout() -> Layout

pub fn as_slice(&self) -> &[f32]

pub fn as_byte_slice(&self) -> &[u8]

pub fn as_mut_slice(&mut self) -> &mut [f32]

pub fn as_mut_byte_slice(&mut self) -> &mut [u8]

pub const fn as_ptr(&self) -> *const f32

Returns a constant unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

pub fn as_mut_ptr(&mut self) -> *mut f32

Returns a mutable unsafe pointer to the underlying data in the underlying type. This function is safe because all types here are repr(C) and can be represented as their underlying type.

Safety

It is up to the caller to correctly use this pointer and its bounds.

Trait Implementations

impl Add<Bivec2> for Bivec2

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Bivec2> for Bivec2

fn add_assign(&mut self, rhs: Bivec2)

Performs the += operation.

impl Clone for Bivec2

fn clone(&self) -> Bivec2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Bivec2

impl Debug for Bivec2

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

Formats the value using the given formatter.

impl Default for Bivec2

fn default() -> Bivec2

Returns the “default value” for a type.

impl Div<Bivec2> for Bivec2

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Bivec2

type Output = Bivec2

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Bivec2

Performs the / operation.

impl DivAssign<Bivec2> for Bivec2

fn div_assign(&mut self, rhs: Bivec2)

Performs the /= operation.

impl DivAssign<f32> for Bivec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Lerp<f32> for Bivec2

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

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 performance 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<Bivec2> for Bivec2

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Bivec2

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Bivec2> for Bivec2

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl MulAssign<f32> for Bivec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Bivec2

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Bivec2> for Bivec2

fn eq(&self, other: &Bivec2) -> bool

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

fn ne(&self, other: &Bivec2) -> bool

This method tests for !=.

impl Slerp<f32> for Bivec2

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

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 StructuralPartialEq for Bivec2

impl Sub<Bivec2> for Bivec2

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Bivec2> for Bivec2

fn sub_assign(&mut self, rhs: Bivec2)

Performs the -= operation.