Struct ultraviolet::bivec::Bivec3[−][src]

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

Expand description

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

Implementations

`impl Bivec3`[src]

`pub const fn new(xy: f32, xz: f32, yz: f32) -> Self`[src]

`pub fn zero() -> Self`[src]

`pub fn from_normalized_axis(v: Vec3) -> Self`[src]

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

`pub fn unit_xy() -> Self`[src]

`pub fn unit_xz() -> Self`[src]

`pub fn unit_yz() -> Self`[src]

`pub fn mag_sq(&self) -> f32`[src]

`pub fn mag(&self) -> f32`[src]

`pub fn normalize(&mut self)`[src]

#[must_use = "Did you mean to use `.normalize()` to normalize `self` in place?"] pub fn normalized(&self) -> Self [src]

`pub fn dot(&self, rhs: Self) -> f32`[src]

`pub fn layout() -> Layout`[src]

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

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

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

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

`pub const fn as_ptr(&self) -> *const f32`[src]

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`[src]

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`[src]

`type Output = Self`

The resulting type after applying the + operator.

`fn add(self, rhs: Bivec3) -> Self`[src]

Performs the + operation. Read more

`impl AddAssign<Bivec3> for Bivec3`[src]

`fn add_assign(&mut self, rhs: Bivec3)`[src]

Performs the += operation. Read more

`impl Clone for Bivec3`[src]

`fn clone(&self) -> Bivec3`[src]

Returns a copy of the value. Read more

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from source. Read more

`impl Debug for Bivec3`[src]

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

Formats the value using the given formatter. Read more

`impl Default for Bivec3`[src]

`fn default() -> Bivec3`[src]

Returns the “default value” for a type. Read more

`impl<'de> Deserialize<'de> for Bivec3`[src]

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

Deserialize this value from the given Serde deserializer. Read more

`impl Div<Bivec3> for Bivec3`[src]

`type Output = Self`

The resulting type after applying the / operator.

`fn div(self, rhs: Bivec3) -> Self`[src]

Performs the / operation. Read more

`impl Div<f32> for Bivec3`[src]

`type Output = Bivec3`

The resulting type after applying the / operator.

`fn div(self, rhs: f32) -> Bivec3`[src]

Performs the / operation. Read more

`impl DivAssign<Bivec3> for Bivec3`[src]

`fn div_assign(&mut self, rhs: Bivec3)`[src]

Performs the /= operation. Read more

`impl DivAssign<f32> for Bivec3`[src]

`fn div_assign(&mut self, rhs: f32)`[src]

Performs the /= operation. Read more

`impl Lerp<f32> for Bivec3`[src]

`fn lerp(&self, end: Self, t: f32) -> Self`[src]

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`[src]

`type Output = Self`

The resulting type after applying the * operator.

`fn mul(self, rhs: Bivec3) -> Self`[src]

Performs the * operation. Read more

`impl Mul<f32> for Bivec3`[src]

`type Output = Self`

The resulting type after applying the * operator.

`fn mul(self, rhs: f32) -> Self`[src]

Performs the * operation. Read more

`impl MulAssign<Bivec3> for Bivec3`[src]

`fn mul_assign(&mut self, rhs: Self)`[src]

Performs the *= operation. Read more

`impl MulAssign<f32> for Bivec3`[src]

`fn mul_assign(&mut self, rhs: f32)`[src]

Performs the *= operation. Read more

`impl Neg for Bivec3`[src]

`type Output = Self`

The resulting type after applying the - operator.

`fn neg(self) -> Self`[src]

Performs the unary - operation. Read more

`impl PartialEq<Bivec3> for Bivec3`[src]

`fn eq(&self, other: &Bivec3) -> bool`[src]

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

`fn ne(&self, other: &Bivec3) -> bool`[src]

This method tests for !=.

`impl Serialize for Bivec3`[src]

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

Serialize this value into the given Serde serializer. Read more

`impl Slerp<f32> for Bivec3`[src]

`fn slerp(&self, end: Self, t: f32) -> Self`[src]

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`[src]

`type Output = Self`

The resulting type after applying the - operator.

`fn sub(self, rhs: Bivec3) -> Self`[src]

Performs the - operation. Read more

`impl SubAssign<Bivec3> for Bivec3`[src]

`fn sub_assign(&mut self, rhs: Bivec3)`[src]

Performs the -= operation. Read more

`impl Zeroable for Bivec3`[src]

`fn zeroed() -> Self`[src]

Calls zeroed. Read more

`impl Copy for Bivec3`[src]

`impl Pod for Bivec3`[src]

`impl StructuralPartialEq for Bivec3`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Bivec3`

`impl Send for Bivec3`

`impl Sync for Bivec3`

`impl Unpin for Bivec3`

`impl UnwindSafe for Bivec3`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

Gets the TypeId of self. Read more

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

Performs the conversion.

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

Performs the conversion.

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

`pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

Performs the conversion.

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

Performs the conversion.

Struct ultraviolet::bivec::Bivec3[−][src]

Fields

Implementations

impl Bivec3[src]

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

pub fn zero() -> Self[src]

pub fn from_normalized_axis(v: Vec3) -> Self[src]

pub fn unit_xy() -> Self[src]

pub fn unit_xz() -> Self[src]

pub fn unit_yz() -> Self[src]

pub fn mag_sq(&self) -> f32[src]

pub fn mag(&self) -> f32[src]

pub fn normalize(&mut self)[src]

#[must_use = "Did you mean to use `.normalize()` to normalize `self` in place?"]pub fn normalized(&self) -> Self[src]

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

pub fn layout() -> Layout[src]

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

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

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

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

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

Safety

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

Safety

Trait Implementations

impl Add<Bivec3> for Bivec3[src]

type Output = Self

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

impl AddAssign<Bivec3> for Bivec3[src]

fn add_assign(&mut self, rhs: Bivec3)[src]

impl Clone for Bivec3[src]

fn clone(&self) -> Bivec3[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for Bivec3[src]

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

impl Default for Bivec3[src]

fn default() -> Bivec3[src]

impl<'de> Deserialize<'de> for Bivec3[src]

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

impl Div<Bivec3> for Bivec3[src]

type Output = Self

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

impl Div<f32> for Bivec3[src]

type Output = Bivec3

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

impl DivAssign<Bivec3> for Bivec3[src]

fn div_assign(&mut self, rhs: Bivec3)[src]

impl DivAssign<f32> for Bivec3[src]

fn div_assign(&mut self, rhs: f32)[src]

impl Lerp<f32> for Bivec3[src]

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

impl Mul<Bivec3> for Bivec3[src]

type Output = Self

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

impl Mul<f32> for Bivec3[src]

type Output = Self

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

impl MulAssign<Bivec3> for Bivec3[src]

fn mul_assign(&mut self, rhs: Self)[src]

impl MulAssign<f32> for Bivec3[src]

fn mul_assign(&mut self, rhs: f32)[src]

impl Neg for Bivec3[src]

type Output = Self

fn neg(self) -> Self[src]

impl PartialEq<Bivec3> for Bivec3[src]

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

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

impl Serialize for Bivec3[src]

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

impl Slerp<f32> for Bivec3[src]

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

impl Sub<Bivec3> for Bivec3[src]

type Output = Self

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

impl SubAssign<Bivec3> for Bivec3[src]

fn sub_assign(&mut self, rhs: Bivec3)[src]

impl Zeroable for Bivec3[src]

fn zeroed() -> Self[src]

impl Copy for Bivec3[src]

impl Pod for Bivec3[src]

`impl Bivec3`[src]

`pub const fn new(xy: f32, xz: f32, yz: f32) -> Self`[src]

`pub fn zero() -> Self`[src]

`pub fn from_normalized_axis(v: Vec3) -> Self`[src]

`pub fn unit_xy() -> Self`[src]

`pub fn unit_xz() -> Self`[src]

`pub fn unit_yz() -> Self`[src]

`pub fn mag_sq(&self) -> f32`[src]

`pub fn mag(&self) -> f32`[src]

`pub fn normalize(&mut self)`[src]

#[must_use = "Did you mean to use `.normalize()` to normalize `self` in place?"] pub fn normalized(&self) -> Self [src]

`pub fn dot(&self, rhs: Self) -> f32`[src]

`pub fn layout() -> Layout`[src]

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

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

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

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

`pub const fn as_ptr(&self) -> *const f32`[src]

`pub fn as_mut_ptr(&mut self) -> *mut f32`[src]

`impl Add<Bivec3> for Bivec3`[src]

`type Output = Self`

`fn add(self, rhs: Bivec3) -> Self`[src]

`impl AddAssign<Bivec3> for Bivec3`[src]

`fn add_assign(&mut self, rhs: Bivec3)`[src]

`impl Clone for Bivec3`[src]

`fn clone(&self) -> Bivec3`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0 [src]

`impl Debug for Bivec3`[src]

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

`impl Default for Bivec3`[src]

`fn default() -> Bivec3`[src]

`impl<'de> Deserialize<'de> for Bivec3`[src]

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

`impl Div<Bivec3> for Bivec3`[src]

`type Output = Self`

`fn div(self, rhs: Bivec3) -> Self`[src]

`impl Div<f32> for Bivec3`[src]

`type Output = Bivec3`

`fn div(self, rhs: f32) -> Bivec3`[src]

`impl DivAssign<Bivec3> for Bivec3`[src]

`fn div_assign(&mut self, rhs: Bivec3)`[src]

`impl DivAssign<f32> for Bivec3`[src]

`fn div_assign(&mut self, rhs: f32)`[src]

`impl Lerp<f32> for Bivec3`[src]

`fn lerp(&self, end: Self, t: f32) -> Self`[src]

`impl Mul<Bivec3> for Bivec3`[src]

`type Output = Self`

`fn mul(self, rhs: Bivec3) -> Self`[src]

`impl Mul<f32> for Bivec3`[src]

`type Output = Self`

`fn mul(self, rhs: f32) -> Self`[src]

`impl MulAssign<Bivec3> for Bivec3`[src]

`fn mul_assign(&mut self, rhs: Self)`[src]

`impl MulAssign<f32> for Bivec3`[src]

`fn mul_assign(&mut self, rhs: f32)`[src]

`impl Neg for Bivec3`[src]

`type Output = Self`

`fn neg(self) -> Self`[src]

`impl PartialEq<Bivec3> for Bivec3`[src]

`fn eq(&self, other: &Bivec3) -> bool`[src]

`fn ne(&self, other: &Bivec3) -> bool`[src]

`impl Serialize for Bivec3`[src]

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

`impl Slerp<f32> for Bivec3`[src]

`fn slerp(&self, end: Self, t: f32) -> Self`[src]

`impl Sub<Bivec3> for Bivec3`[src]

`type Output = Self`

`fn sub(self, rhs: Bivec3) -> Self`[src]

`impl SubAssign<Bivec3> for Bivec3`[src]

`fn sub_assign(&mut self, rhs: Bivec3)`[src]

`impl Zeroable for Bivec3`[src]

`fn zeroed() -> Self`[src]

`impl Copy for Bivec3`[src]

`impl Pod for Bivec3`[src]

`impl StructuralPartialEq for Bivec3`[src]

`impl RefUnwindSafe for Bivec3`

`impl Send for Bivec3`

`impl Sync for Bivec3`

`impl Unpin for Bivec3`

`impl UnwindSafe for Bivec3`