[go: up one dir, main page]

Struct ultraviolet::vec::DVec3x2[][src]

#[repr(C)]
pub struct DVec3x2 { pub x: f64x2, pub y: f64x2, pub z: f64x2, }
Expand description

A set of three coordinates which may be interpreted as a point or vector in 3d space, or as a homogeneous 2d vector or point.

Generally this distinction between a point and vector is more of a pain than it is worth to distinguish on a type level, however when converting to and from homogeneous coordinates it is quite important.

Fields

x: f64x2y: f64x2z: f64x2

Implementations

impl DVec3x2[src]

pub const fn new(x: f64x2, y: f64x2, z: f64x2) -> Self[src]

pub const fn broadcast(val: f64x2) -> Self[src]

pub fn unit_x() -> Self[src]

pub fn unit_y() -> Self[src]

pub fn unit_z() -> Self[src]

pub fn into_homogeneous_point(self) -> DVec4x2[src]

Create a homogeneous 3d point from this vector interpreted as a point, meaning the homogeneous component will start with a value of 1.0.

pub fn into_homogeneous_vector(self) -> DVec4x2[src]

Create a homogeneous 3d vector from this vector, meaning the homogeneous component will always have a value of 0.0.

pub fn from_homogeneous_point(v: DVec4x2) -> Self[src]

Create a 3d point from a homogeneous 3d point, performing division by the homogeneous component. This should not be used for homogeneous 3d vectors, which will have 0 as their homogeneous component.

pub fn from_homogeneous_vector(v: DVec4x2) -> Self[src]

Create a 3d vector from homogeneous 2d vector, which simply discards the homogeneous component.

pub fn dot(&self, other: DVec3x2) -> f64x2[src]

pub fn wedge(&self, other: DVec3x2) -> DBivec3x2[src]

The wedge (aka exterior) product of two vectors.

This operation results in a bivector, which represents the plane parallel to the two vectors, and which has a ‘oriented area’ equal to the parallelogram created by extending the two vectors, oriented such that the positive direction is the one which would move self closer to other.

pub fn geom(&self, other: DVec3x2) -> DRotor3x2[src]

The geometric product of this and another vector, which is defined as the sum of the dot product and the wedge product.

This operation results in a ‘rotor’, named as such as it may define a rotation. The rotor which results from the geometric product will rotate in the plane parallel to the two vectors, by twice the angle between them and in the opposite direction (i.e. it will rotate in the direction that would bring other towards self, and rotate in that direction by twice the angle between them).

pub fn rotate_by(&mut self, rotor: DRotor3x2)[src]

pub fn rotated_by(self, rotor: DRotor3x2) -> Self[src]

pub fn cross(&self, other: DVec3x2) -> Self[src]

pub fn reflect(&mut self, normal: DVec3x2)[src]

pub fn reflected(&self, normal: DVec3x2) -> Self[src]

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

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

Normalize self in-place by interpreting it as a homogeneous point, i.e. scaling the vector to ensure the homogeneous component has length 1.

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

Normalize self by interpreting it as a homogeneous point, i.e. scaling the vector to ensure the homogeneous component has length 1.

pub fn truncated(&self) -> DVec2x2[src]

Convert self into a Vec2 by simply removing its z component.

pub fn mul_add(&self, mul: DVec3x2, add: DVec3x2) -> Self[src]

pub fn abs(&self) -> Self[src]

pub fn clamp(&mut self, min: Self, max: Self)[src]

pub fn clamped(self, min: Self, max: Self) -> Self[src]

pub fn map<F>(&self, f: F) -> Self where
    F: Fn(f64x2) -> f64x2
[src]

pub fn apply<F>(&mut self, f: F) where
    F: Fn(f64x2) -> f64x2
[src]

pub fn max_by_component(self, other: Self) -> Self[src]

pub fn min_by_component(self, other: Self) -> Self[src]

pub fn component_max(&self) -> f64x2[src]

pub fn component_min(&self) -> f64x2[src]

pub fn zero() -> Self[src]

pub fn one() -> Self[src]

pub const fn xy(&self) -> DVec2x2[src]

pub fn xyzw(&self) -> DVec4x2[src]

pub fn layout() -> Layout[src]

pub fn as_array(&self) -> &[f64x2; 3][src]

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

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

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

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

pub const fn as_ptr(&self) -> *const f64x2[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 f64x2[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.

impl DVec3x2[src]

pub fn new_splat(x: f64, y: f64, z: f64) -> Self[src]

pub fn splat(vec: DVec3) -> Self[src]

pub fn blend(mask: m64x2, tru: Self, fals: Self) -> Self[src]

Blend two vectors together lanewise using mask as a mask.

This is essentially a bitwise blend operation, such that any point where there is a 1 bit in mask, the output will put the bit from tru, while where there is a 0 bit in mask, the output will put the bit from fals

pub fn refract(&mut self, normal: Self, eta: f64x2)[src]

pub fn refracted(&self, normal: Self, eta: f64x2) -> Self[src]

Trait Implementations

impl Add<DVec3x2> for DVec3x2[src]

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl AddAssign<DVec3x2> for DVec3x2[src]

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

Performs the += operation. Read more

impl Clone for DVec3x2[src]

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

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

Formats the value using the given formatter. Read more

impl Default for DVec3x2[src]

fn default() -> DVec3x2[src]

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

impl Div<DVec3x2> for DVec3x2[src]

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl Div<f64x2> for DVec3x2[src]

type Output = DVec3x2

The resulting type after applying the / operator.

fn div(self, rhs: f64x2) -> DVec3x2[src]

Performs the / operation. Read more

impl DivAssign<DVec3x2> for DVec3x2[src]

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

Performs the /= operation. Read more

impl DivAssign<f64x2> for DVec3x2[src]

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

Performs the /= operation. Read more

impl From<&'_ [f64x2; 3]> for DVec3x2[src]

fn from(comps: &[f64x2; 3]) -> Self[src]

Performs the conversion.

impl From<&'_ (f64x2, f64x2, f64x2)> for DVec3x2[src]

fn from(comps: &(f64x2, f64x2, f64x2)) -> Self[src]

Performs the conversion.

impl From<&'_ mut [f64x2; 3]> for DVec3x2[src]

fn from(comps: &mut [f64x2; 3]) -> Self[src]

Performs the conversion.

impl From<[DVec3; 2]> for DVec3x2[src]

fn from(vecs: [DVec3; 2]) -> Self[src]

Performs the conversion.

impl From<[f64x2; 3]> for DVec3x2[src]

fn from(comps: [f64x2; 3]) -> Self[src]

Performs the conversion.

impl From<(f64x2, f64x2, f64x2)> for DVec3x2[src]

fn from(comps: (f64x2, f64x2, f64x2)) -> Self[src]

Performs the conversion.

impl From<DVec2x2> for DVec3x2[src]

fn from(vec: DVec2x2) -> Self[src]

Performs the conversion.

impl From<DVec3x2> for DVec2x2[src]

fn from(vec: DVec3x2) -> Self[src]

Performs the conversion.

impl From<DVec3x2> for DVec4x2[src]

fn from(vec: DVec3x2) -> Self[src]

Performs the conversion.

impl From<DVec4x2> for DVec3x2[src]

fn from(vec: DVec4x2) -> Self[src]

Performs the conversion.

impl Index<usize> for DVec3x2[src]

type Output = f64x2

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output[src]

Performs the indexing (container[index]) operation. Read more

impl IndexMut<usize> for DVec3x2[src]

fn index_mut(&mut self, index: usize) -> &mut Self::Output[src]

Performs the mutable indexing (container[index]) operation. Read more

impl Lerp<f64x2> for DVec3x2[src]

fn lerp(&self, end: Self, t: f64x2) -> 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<DVec3x2> for DMat3x2[src]

type Output = DVec3x2

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<DVec3x2> for DRotor3x2[src]

type Output = DVec3x2

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<DVec3x2> for DIsometry3x2[src]

type Output = DVec3x2

The resulting type after applying the * operator.

fn mul(self, vec: DVec3x2) -> DVec3x2[src]

Performs the * operation. Read more

impl Mul<DVec3x2> for DSimilarity3x2[src]

type Output = DVec3x2

The resulting type after applying the * operator.

fn mul(self, vec: DVec3x2) -> DVec3x2[src]

Performs the * operation. Read more

impl Mul<DVec3x2> for DVec3x2[src]

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<DVec3x2> for f64x2[src]

type Output = DVec3x2

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl Mul<f64x2> for DVec3x2[src]

type Output = DVec3x2

The resulting type after applying the * operator.

fn mul(self, rhs: f64x2) -> DVec3x2[src]

Performs the * operation. Read more

impl MulAssign<DVec3x2> for DVec3x2[src]

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

Performs the *= operation. Read more

impl MulAssign<f64x2> for DVec3x2[src]

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

Performs the *= operation. Read more

impl Neg for DVec3x2[src]

type Output = DVec3x2

The resulting type after applying the - operator.

fn neg(self) -> DVec3x2[src]

Performs the unary - operation. Read more

impl PartialEq<DVec3x2> for DVec3x2[src]

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

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

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

This method tests for !=.

impl Slerp<f64x2> for DVec3x2[src]

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

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl SubAssign<DVec3x2> for DVec3x2[src]

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

Performs the -= operation. Read more

impl Sum<DVec3x2> for DVec3x2[src]

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = Self>, 
[src]

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

impl Copy for DVec3x2[src]

impl StructuralPartialEq for DVec3x2[src]

Auto Trait Implementations

impl RefUnwindSafe for DVec3x2

impl Send for DVec3x2

impl Sync for DVec3x2

impl Unpin for DVec3x2

impl UnwindSafe for DVec3x2

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<U> 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<U> 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<U>>::Error>[src]

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.