Enum wlambda::nvec::NVec

source · [−]

pub enum NVec<N: NVecNum> {
    Vec2(N, N),
    Vec3(N, N, N),
    Vec4(N, N, N, N),
}

Expand description

WLambda supports Integer and Float vectors in two, three, and four dimensions. See also VVal::nvec and functions like VVal::ivec2, VVal::fvec2, …

Variants

`Vec2(N, N)`

`Vec3(N, N, N)`

`Vec4(N, N, N, N)`

Implementations

source

impl<N: NVecNum> NVec<N>

source

pub fn x(&self) -> VVal

The x component of the number vector as VVal.

source

pub fn x_raw(&self) -> N

The x component of the number vector as faw integer/float type.

source

pub fn y(&self) -> VVal

The y component of the number vector as VVal.

source

pub fn y_raw(&self) -> N

The y component of the number vector as faw integer/float type.

source

pub fn z(&self) -> Option<VVal>

The z component of the number vector as VVal.

source

pub fn z_raw(&self) -> Option<N>

The z component of the number vector as faw integer/float type.

source

pub fn w(&self) -> Option<VVal>

The w component of the number vector as VVal.

source

pub fn w_raw(&self) -> Option<N>

The w component of the number vector as faw integer/float type.

source

pub fn dims(&self) -> NVecDim

Returns the dimensionality of this number vector.

source

pub fn into_tpl(self) -> (N, N, Option<N>, Option<N>)

Convert this numeric vector into a tuple of raw integer/float types. All vectors contain x and y components. The z and w components are optional.

source

pub fn into_zero_tpl(self) -> (N, N, N, N)

A tuple of four elements representing the components of this vector. If a component wasn’t available, a 0 takes its place.

source

pub fn into_vval_tpl(self) -> (VVal, VVal, Option<VVal>, Option<VVal>)

Convert this numeric vector into a tuple of VVal. All vectors contain x and y components. The z and w components are optional.

source

pub fn from_tpl(tpl: (N, N, Option<N>, Option<N>)) -> Option<Self>

Convert a tuple of raw integer/float types into an NVec.

source

pub fn from_vval_tpl<W: AsRef<VVal>>(
(x, y, z, w): (W, W, Option<W>, Option<W>)
) -> Option<Self>

Convert a tuple of VVal into an NVec.

source

pub fn s(&self) -> String

Returns a string representation of this numeric vector.

source

pub fn vec2(self) -> Self

Converts this vector into one with three dimensions, discarding the unnecessary values.

source

pub fn vec3(self) -> Self

Converts this vector into one with three dimensions, discarding the unnecessary values and filling in the missing values with 0s if necessary.

source

pub fn vec4(self) -> Self

Converts this vector into one with four dimensions, filling in the missing values with 0s if necessary.

source

pub fn mag2(&self) -> f64

Returns the squared magnitude of this vector like x^2 + y^2. See also NVec::mag.

source

pub fn mag(&self) -> f64

Returns the magnitude of this vector also known as the mathematical length of the vector: sqrt(x^2 + y^2) for instance for a 2 dimensional vector.

source

pub fn norm(self) -> Self

Convert this NVec into a normalized (unit length) vector.

source

pub fn dot(self, o: NVec<N>) -> N

Calculates the dot product of two numerical vectors.

source

pub fn cross(self, o: NVec<N>) -> Self

Calculates the cross product of two numerical vectors.

source

pub fn lerp(self, o: NVec<N>, t: f64) -> Self

Linear interpolation from this vector to the given vector \a o. The parameter \a t should be between 0.0 and 1.0.

source

pub fn vec2rad(self) -> f64

Turns the first two components of this vector into an angle in radians.

source

pub fn rad2vec(f: f64) -> Self

Produces a Vec2 based on the radians provided to this function as a float.

source

pub fn slerp(self, o: NVec<N>, t: f64) -> Self

The resulting NVec will almost always have a length of 1, except for in cases where o and self are collinear opposites. To work around this, the resulting vector may be normalized.

Panics

Panics if input vectors aren’t unit vectors.

Trait Implementations

source

impl<N: NVecNum> Add<NVec<N>> for NVec<N>

type Output = Self

The resulting type after applying the + operator.

source

fn add(self, o: NVec<N>) -> NVec<N>

Performs the + operation. Read more

source

impl<N: Clone + NVecNum> Clone for NVec<N>

source

fn clone(&self) -> NVec<N>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<N: Debug + NVecNum> Debug for NVec<N>

source

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

Formats the value using the given formatter. Read more

source

impl<N: NVecNum> Div<N> for NVec<N>

type Output = Self

The resulting type after applying the / operator.

source

fn div(self, o: N) -> NVec<N>

Performs the / operation. Read more

source

impl<N: NVecNum> Mul<N> for NVec<N>

type Output = Self

The resulting type after applying the * operator.

source

fn mul(self, o: N) -> NVec<N>

Performs the * operation. Read more

source

impl<N: NVecNum> Neg for NVec<N>

type Output = NVec<N>

The resulting type after applying the - operator.

source

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

source

impl<N: PartialEq + NVecNum> PartialEq<NVec<N>> for NVec<N>

source

fn eq(&self, other: &NVec<N>) -> bool

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

source

fn ne(&self, other: &NVec<N>) -> bool

This method tests for !=.

source

impl<N: NVecNum> Sub<NVec<N>> for NVec<N>

type Output = Self

The resulting type after applying the - operator.

source

fn sub(self, o: NVec<N>) -> NVec<N>

Performs the - operation. Read more

source

impl<N: Copy + NVecNum> Copy for NVec<N>

source

impl<N: NVecNum> StructuralPartialEq for NVec<N>

Auto Trait Implementations

impl<N> RefUnwindSafe for NVec<N> where
N: RefUnwindSafe,

impl<N> Send for NVec<N> where
N: Send,

impl<N> Sync for NVec<N> where
N: Sync,

impl<N> Unpin for NVec<N> where
N: Unpin,

impl<N> UnwindSafe for NVec<N> where
N: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

fn clone_into(&self, target: &mut T)

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

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum wlambda::nvec::NVec

Variants

Vec2(N, N)

Vec3(N, N, N)

Vec4(N, N, N, N)

Implementations

impl<N: NVecNum> NVec<N>

pub fn x(&self) -> VVal

pub fn x_raw(&self) -> N

pub fn y(&self) -> VVal

pub fn y_raw(&self) -> N

pub fn z(&self) -> Option<VVal>

pub fn z_raw(&self) -> Option<N>

pub fn w(&self) -> Option<VVal>

pub fn w_raw(&self) -> Option<N>

pub fn dims(&self) -> NVecDim

pub fn into_tpl(self) -> (N, N, Option<N>, Option<N>)

pub fn into_zero_tpl(self) -> (N, N, N, N)

pub fn into_vval_tpl(self) -> (VVal, VVal, Option<VVal>, Option<VVal>)

pub fn from_tpl(tpl: (N, N, Option<N>, Option<N>)) -> Option<Self>

pub fn from_vval_tpl<W: AsRef<VVal>>( (x, y, z, w): (W, W, Option<W>, Option<W>)) -> Option<Self>

pub fn s(&self) -> String

pub fn vec2(self) -> Self

pub fn vec3(self) -> Self

pub fn vec4(self) -> Self

pub fn mag2(&self) -> f64

pub fn mag(&self) -> f64

pub fn norm(self) -> Self

pub fn dot(self, o: NVec<N>) -> N

pub fn cross(self, o: NVec<N>) -> Self

pub fn lerp(self, o: NVec<N>, t: f64) -> Self

pub fn vec2rad(self) -> f64

pub fn rad2vec(f: f64) -> Self

pub fn slerp(self, o: NVec<N>, t: f64) -> Self

Trait Implementations

impl<N: NVecNum> Add<NVec<N>> for NVec<N>

type Output = Self

fn add(self, o: NVec<N>) -> NVec<N>

impl<N: Clone + NVecNum> Clone for NVec<N>

fn clone(&self) -> NVec<N>

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

impl<N: Debug + NVecNum> Debug for NVec<N>

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

impl<N: NVecNum> Div<N> for NVec<N>

type Output = Self

fn div(self, o: N) -> NVec<N>

impl<N: NVecNum> Mul<N> for NVec<N>

type Output = Self

fn mul(self, o: N) -> NVec<N>

impl<N: NVecNum> Neg for NVec<N>

type Output = NVec<N>

fn neg(self) -> Self::Output

impl<N: PartialEq + NVecNum> PartialEq<NVec<N>> for NVec<N>

fn eq(&self, other: &NVec<N>) -> bool

fn ne(&self, other: &NVec<N>) -> bool

impl<N: NVecNum> Sub<NVec<N>> for NVec<N>

type Output = Self

fn sub(self, o: NVec<N>) -> NVec<N>

impl<N: Copy + NVecNum> Copy for NVec<N>

impl<N: NVecNum> StructuralPartialEq for NVec<N>

Auto Trait Implementations

impl<N> RefUnwindSafe for NVec<N> where N: RefUnwindSafe,

impl<N> Send for NVec<N> where N: Send,

impl<N> Sync for NVec<N> where N: Sync,

impl<N> Unpin for NVec<N> where N: Unpin,

impl<N> UnwindSafe for NVec<N> where N: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

`Vec2(N, N)`

`Vec3(N, N, N)`

`Vec4(N, N, N, N)`

pub fn from_vval_tpl<W: AsRef<VVal>>(
(x, y, z, w): (W, W, Option<W>, Option<W>)
) -> Option<Self>

impl<N> RefUnwindSafe for NVec<N> where
N: RefUnwindSafe,

impl<N> Send for NVec<N> where
N: Send,

impl<N> Sync for NVec<N> where
N: Sync,

impl<N> Unpin for NVec<N> where
N: Unpin,

impl<N> UnwindSafe for NVec<N> where
N: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,