Struct ultraviolet::bivec::Bivec3

#[repr(C)]
pub struct Bivec3 {
    pub xy: f32,
    pub xz: f32,
    pub yz: f32,
}

A bivector in 3d space.

In 3d, a bivector has 3 components, each one representing the signed projected area of the bivector onto one of the 3 basis bivectors, which can be thought of as corresponding to each of the three basis planes. This is analogous to the components of a 3d vector, which correspond to the projected length of the vector onto the three basis *vectors. Since in 3d, there are three components for both vectors and bivectors, 3d bivectors have been historically confused with 3d vectors quite a lot.

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

Fields

xy: f32

xz: f32

yz: f32

Implementations

impl Bivec3

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

pub fn zero() -> Self

pub fn from_normalized_axis(v: Vec3) -> Self

Create the bivector which represents the same plane of rotation as a given normalized ‘axis vector’

pub fn unit_xy() -> Self

pub fn unit_xz() -> Self

pub fn unit_yz() -> 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<Bivec3> for Bivec3

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Bivec3> for Bivec3

fn add_assign(&mut self, rhs: Bivec3)

Performs the += operation.

impl Clone for Bivec3

fn clone(&self) -> Bivec3

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bivec3

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

Formats the value using the given formatter.

impl Default for Bivec3

fn default() -> Bivec3

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bivec3

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Div<Bivec3> for Bivec3

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f32> for Bivec3

type Output = Bivec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Bivec3> for Bivec3

fn div_assign(&mut self, rhs: Bivec3)

Performs the /= operation.

impl DivAssign<f32> for Bivec3

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl Lerp<f32> for Bivec3

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<Bivec3> for Bivec3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Bivec3> for f32

type Output = Bivec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Bivec3

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Bivec3> for Bivec3

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl MulAssign<f32> for Bivec3

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Bivec3

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Bivec3> for Bivec3

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

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

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

This method tests for !=.

impl Serialize for Bivec3

fn serialize<T>(&self, serializer: T) -> Result<T::Ok, T::Error> where
    T: Serializer, 

Serialize this value into the given Serde serializer.

impl Slerp<f32> for Bivec3

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 Sub<Bivec3> for Bivec3

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Bivec3> for Bivec3

fn sub_assign(&mut self, rhs: Bivec3)

Performs the -= operation.

impl Zeroable for Bivec3

fn zeroed() -> Self

Calls zeroed.

impl Copy for Bivec3

impl Pod for Bivec3

impl StructuralPartialEq for Bivec3