Struct DBivec3 

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

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

xz: f64

yz: f64

Implementations

impl DBivec3

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

pub fn zero() -> Self

pub fn from_normalized_axis(v: DVec3) -> 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) -> f64

pub fn mag(&self) -> f64

pub fn normalize(&mut self)

pub fn normalized(&self) -> Self

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

pub fn layout() -> Layout

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

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

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

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

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

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 f64

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

type Output = DBivec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for DBivec3

fn add_assign(&mut self, rhs: DBivec3)

Performs the += operation.

impl Clone for DBivec3

fn clone(&self) -> DBivec3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DBivec3

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

Formats the value using the given formatter.

impl Default for DBivec3

fn default() -> DBivec3

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DBivec3

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f64> for DBivec3

type Output = DBivec3

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> DBivec3

Performs the / operation.

impl Div for DBivec3

type Output = DBivec3

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f64> for DBivec3

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl DivAssign for DBivec3

fn div_assign(&mut self, rhs: DBivec3)

Performs the /= operation.

impl Lerp<f64> for DBivec3

fn lerp(&self, end: Self, t: f64) -> 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<DBivec3> for f64

type Output = DBivec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for DBivec3

type Output = DBivec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for DBivec3

type Output = DBivec3

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for DBivec3

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl MulAssign for DBivec3

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for DBivec3

type Output = DBivec3

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for DBivec3

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DBivec3

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

where T: Serializer,

Serialize this value into the given Serde serializer.

impl Slerp<f64> for DBivec3

fn slerp(&self, end: Self, t: f64) -> 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 for DBivec3

type Output = DBivec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for DBivec3

fn sub_assign(&mut self, rhs: DBivec3)

Performs the -= operation.

impl Zeroable for DBivec3

Available on crate feature f64 only.

fn zeroed() -> Self

Calls zeroed.

impl Copy for DBivec3

impl Pod for DBivec3

Available on crate feature f64 only.

impl StructuralPartialEq for DBivec3