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

#[repr(C)]pub struct DBivec2 {
    pub xy: f64,
}

Expand description

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

Implementations

`impl DBivec2`[src]

`pub const fn new(xy: f64) -> Self`[src]

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

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

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

`pub fn mag(&self) -> f64`[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) -> f64`[src]

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

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

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

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

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

`pub const fn as_ptr(&self) -> *const f64`[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 f64`[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<DBivec2> for DBivec2`[src]

`type Output = Self`

The resulting type after applying the + operator.

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

Performs the + operation. Read more

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

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

Performs the += operation. Read more

`impl Clone for DBivec2`[src]

`fn clone(&self) -> DBivec2`[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 DBivec2`[src]

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

Formats the value using the given formatter. Read more

`impl Default for DBivec2`[src]

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

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

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

`type Output = Self`

The resulting type after applying the / operator.

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

Performs the / operation. Read more

`impl Div<f64> for DBivec2`[src]

`type Output = DBivec2`

The resulting type after applying the / operator.

`fn div(self, rhs: f64) -> DBivec2`[src]

Performs the / operation. Read more

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

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

Performs the /= operation. Read more

`impl DivAssign<f64> for DBivec2`[src]

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

Performs the /= operation. Read more

`impl Lerp<f64> for DBivec2`[src]

`fn lerp(&self, end: Self, t: f64) -> 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<DBivec2> for DBivec2`[src]

`type Output = Self`

The resulting type after applying the * operator.

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

Performs the * operation. Read more

`impl Mul<f64> for DBivec2`[src]

`type Output = Self`

The resulting type after applying the * operator.

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

Performs the * operation. Read more

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

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

Performs the *= operation. Read more

`impl MulAssign<f64> for DBivec2`[src]

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

Performs the *= operation. Read more

`impl Neg for DBivec2`[src]

`type Output = Self`

The resulting type after applying the - operator.

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

Performs the unary - operation. Read more

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

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

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

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

This method tests for !=.

`impl Slerp<f64> for DBivec2`[src]

`fn slerp(&self, end: Self, t: f64) -> 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<DBivec2> for DBivec2`[src]

`type Output = Self`

The resulting type after applying the - operator.

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

Performs the - operation. Read more

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

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

Performs the -= operation. Read more

`impl Zeroable for DBivec2`[src]

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

Calls zeroed. Read more

`impl Copy for DBivec2`[src]

`impl Pod for DBivec2`[src]

`impl StructuralPartialEq for DBivec2`[src]

Auto Trait Implementations

`impl RefUnwindSafe for DBivec2`

`impl Send for DBivec2`

`impl Sync for DBivec2`

`impl Unpin for DBivec2`

`impl UnwindSafe for DBivec2`

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::DBivec2[−][src]

Fields

Implementations

impl DBivec2[src]

pub const fn new(xy: f64) -> Self[src]

pub fn zero() -> Self[src]

pub fn unit_xy() -> Self[src]

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

pub fn mag(&self) -> f64[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) -> f64[src]

pub fn layout() -> Layout[src]

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

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

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

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

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

Safety

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

Safety

Trait Implementations

impl Add<DBivec2> for DBivec2[src]

type Output = Self

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

impl AddAssign<DBivec2> for DBivec2[src]

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

impl Clone for DBivec2[src]

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

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

impl Debug for DBivec2[src]

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

impl Default for DBivec2[src]

fn default() -> DBivec2[src]

impl Div<DBivec2> for DBivec2[src]

type Output = Self

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

impl Div<f64> for DBivec2[src]

type Output = DBivec2

fn div(self, rhs: f64) -> DBivec2[src]

impl DivAssign<DBivec2> for DBivec2[src]

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

impl DivAssign<f64> for DBivec2[src]

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

impl Lerp<f64> for DBivec2[src]

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

impl Mul<DBivec2> for DBivec2[src]

type Output = Self

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

impl Mul<f64> for DBivec2[src]

type Output = Self

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

impl MulAssign<DBivec2> for DBivec2[src]

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

impl MulAssign<f64> for DBivec2[src]

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

impl Neg for DBivec2[src]

type Output = Self

fn neg(self) -> Self[src]

impl PartialEq<DBivec2> for DBivec2[src]

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

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

impl Slerp<f64> for DBivec2[src]

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

impl Sub<DBivec2> for DBivec2[src]

type Output = Self

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

impl SubAssign<DBivec2> for DBivec2[src]

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

impl Zeroable for DBivec2[src]

fn zeroed() -> Self[src]

impl Copy for DBivec2[src]

impl Pod for DBivec2[src]

impl StructuralPartialEq for DBivec2[src]

Auto Trait Implementations

impl RefUnwindSafe for DBivec2

impl Send for DBivec2

impl Sync for DBivec2

impl Unpin for DBivec2

impl UnwindSafe for DBivec2

`impl DBivec2`[src]

`pub const fn new(xy: f64) -> Self`[src]

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

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

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

`pub fn mag(&self) -> f64`[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) -> f64`[src]

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

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

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

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

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

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

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

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

`type Output = Self`

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

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

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

`impl Clone for DBivec2`[src]

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

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

`impl Debug for DBivec2`[src]

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

`impl Default for DBivec2`[src]

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

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

`type Output = Self`

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

`impl Div<f64> for DBivec2`[src]

`type Output = DBivec2`

`fn div(self, rhs: f64) -> DBivec2`[src]

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

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

`impl DivAssign<f64> for DBivec2`[src]

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

`impl Lerp<f64> for DBivec2`[src]

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

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

`type Output = Self`

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

`impl Mul<f64> for DBivec2`[src]

`type Output = Self`

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

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

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

`impl MulAssign<f64> for DBivec2`[src]

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

`impl Neg for DBivec2`[src]

`type Output = Self`

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

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

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

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

`impl Slerp<f64> for DBivec2`[src]

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

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

`type Output = Self`

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

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

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

`impl Zeroable for DBivec2`[src]

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

`impl Copy for DBivec2`[src]

`impl Pod for DBivec2`[src]

`impl StructuralPartialEq for DBivec2`[src]

`impl RefUnwindSafe for DBivec2`

`impl Send for DBivec2`

`impl Sync for DBivec2`

`impl Unpin for DBivec2`

`impl UnwindSafe for DBivec2`

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

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

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

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

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

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

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