Struct nannou::geom::vector::Vector4[][src]

#[repr(C)]
pub struct Vector4<S = Default> { pub x: S, pub y: S, pub z: S, pub w: S, }

A 4-dimensional vector.

Fields

x: Sy: Sz: Sw: S

Implementations

impl<S> Vector4<S>[src]

pub fn new(x: S, y: S, z: S, w: S) -> Vector4<S>[src]

Construct a new vector, using the provided values.

pub fn from_value(scalar: S) -> Vector4<S> where
    S: Clone
[src]

Construct a vector using the given value for each field.

pub fn len(&self) -> usize[src]

The number of dimensions in the vector.

pub fn map<U, F>(self, f: F) -> Vector4<U> where
    F: FnMut(S) -> U, 
[src]

Perform the given operation on each field in the vector, returning a new vector constructed from the operations.

pub fn zip_map<T, U, F>(self, other: Vector4<T>, f: F) -> Vector4<U> where
    F: FnMut(S, T) -> U, 
[src]

Perform the given operation on each each field on both vectors, returning a new vector constructed from the operations.

pub fn is_finite(&self) -> bool where
    S: BaseFloat
[src]

Test whether or not the vector is infinite.

pub fn cast<T>(&self) -> Option<Vector4<T>> where
    S: NumCast + Clone,
    T: NumCast
[src]

Component-wise casting to another type.

pub fn zero() -> Vector4<S> where
    S: Zero
[src]

A zeroed vector.

pub fn is_zero(&self) -> bool where
    S: PartialEq + Zero
[src]

Whether or not the vector is zeroed.

pub fn one() -> Vector4<S> where
    S: One
[src]

A vector with 1 for each element.

pub fn is_one(&self) -> bool where
    S: PartialEq + One
[src]

Whether or not each element in the vector is equal to 1.

pub fn is_nan(&self) -> bool where
    S: BaseFloat
[src]

Tests whether or not any of the vector’s elements is NaN.

pub fn sum(self) -> S where
    S: Add<Output = S> + Copy
[src]

Sum the fields of the vector.

pub fn product(self) -> S where
    S: Mul<Output = S> + Copy
[src]

The product of the fields of the vector.

pub fn limit_magnitude(self, limit: S) -> Self where
    S: BaseFloat
[src]

Return a vector whose magnitude is limited to the given value.

pub fn with_magnitude(self, magnitude: S) -> Self where
    S: BaseFloat
[src]

Return a vector with the given magnitude.

pub fn normalize(self) -> Self where
    S: BaseFloat
[src]

Return a normalized vector.

If self is_zero, this returns self.

pub fn magnitude(self) -> S where
    S: BaseFloat
[src]

The magnitude of the vector.

The magnitude represents the distance from the origin to the point described by the vector.

Note: This is equivalent to .magnitude2().sqrt(). As a result, it can be quite a bit more computationally efficient to use .magnitude2() directly when feasible.

Example

let a = vec2(5.0, 0.0);
let b = vec2(0.0, 5.0);
assert_eq!(a.magnitude(), 5.0);
assert_eq!(b.magnitude(), 5.0);

pub fn magnitude2(self) -> S where
    S: BaseFloat
[src]

The square of the magnitude.

See the magnitude docs for details.

pub fn dot(self, other: Vector4<S>) -> S where
    S: BaseFloat
[src]

The dot product of self and the given vector.

impl<S> Vector4<S>[src]

pub fn unit_x() -> Vector4<S> where
    S: Zero + One
[src]

A unit vector in the x direction.

pub fn unit_y() -> Vector4<S> where
    S: Zero + One
[src]

A unit vector in the y direction.

pub fn unit_z() -> Vector4<S> where
    S: Zero + One
[src]

A unit vector in the z direction.

pub fn unit_w() -> Vector4<S> where
    S: Zero + One
[src]

A unit vector in the w direction.

pub fn truncate(self) -> Vector3<S>[src]

Create a Vector3, dropping the w value.

pub fn truncate_n(&self, n: isize) -> Vector3<S> where
    S: Copy
[src]

Create a Vector3, dropping the nth element.

Methods from Deref<Target = [S; 4]>

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

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

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

Returns a slice containing the entire array. Equivalent to &s[..].

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

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

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

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N][src]

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

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods, array_map)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N][src]

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

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

Trait Implementations

impl<S> AbsDiffEq<Vector4<S>> for Vector4<S> where
    S: AbsDiffEq,
    S::Epsilon: Copy
[src]

type Epsilon = S::Epsilon

Used for specifying relative comparisons.

impl<S> Add<Vector4<S>> for Vector4<S> where
    S: Add<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the + operator.

impl<S> AddAssign<Vector4<S>> for Vector4<S> where
    S: AddAssign
[src]

impl<S> Array for Vector4<S> where
    S: Copy
[src]

type Element = S

impl<S> AsMut<[S; 4]> for Vector4<S>[src]

impl<S> AsRef<[S; 4]> for Vector4<S>[src]

impl<S> Bounded for Vector4<S> where
    S: Bounded
[src]

impl<S: Clone> Clone for Vector4<S>[src]

impl<S: Copy> Copy for Vector4<S>[src]

impl<S: Debug> Debug for Vector4<S>[src]

impl<S: Default> Default for Vector4<S>[src]

impl<S> Deref for Vector4<S>[src]

type Target = [S; 4]

The resulting type after dereferencing.

impl<S> DerefMut for Vector4<S>[src]

impl<'de, S> Deserialize<'de> for Vector4<S> where
    S: Deserialize<'de>, 
[src]

impl<S> Distribution<Vector4<S>> for Standard where
    Standard: Distribution<S>, 
[src]

impl<S> Div<S> for Vector4<S> where
    S: Copy + Div<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the / operator.

impl<S> Div<Vector4<S>> for Vector4<S> where
    S: Div<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the / operator.

impl<S> DivAssign<S> for Vector4<S> where
    S: Copy + DivAssign
[src]

impl<S> DivAssign<Vector4<S>> for Vector4<S> where
    S: Copy + DivAssign
[src]

impl<S> ElementWise<S> for Vector4<S> where
    S: BaseNum
[src]

impl<S> ElementWise<Vector4<S>> for Vector4<S> where
    S: BaseFloat
[src]

impl<S: Eq> Eq for Vector4<S>[src]

impl<S> EuclideanSpace for Vector4<S> where
    S: BaseNum
[src]

type Scalar = S

The associated scalar over which the space is defined. Read more

type Diff = Vector4<S>

The associated space of displacement vectors.

impl<S> From<[S; 2]> for Vector4<S> where
    S: Zero
[src]

impl<S> From<[S; 3]> for Vector4<S> where
    S: Zero
[src]

impl<S> From<[S; 4]> for Vector4<S> where
    S: Copy
[src]

impl<S> From<(S, S, S, S)> for Vector4<S>[src]

impl<S> From<(S, S, S)> for Vector4<S> where
    S: Zero
[src]

impl<S> From<(S, S)> for Vector4<S> where
    S: Zero
[src]

impl<S> From<Point2D<f32, UnknownUnit>> for Vector4<S> where
    S: From<f32> + Zero
[src]

impl<S> From<Point2D<f64, UnknownUnit>> for Vector4<S> where
    S: From<f64> + Zero
[src]

impl<S> From<Size2D<f32, UnknownUnit>> for Vector4<S> where
    S: From<f32> + Zero
[src]

impl<S> From<Vector2<S>> for Vector4<S> where
    S: Zero
[src]

impl<S> From<Vector2D<f32, UnknownUnit>> for Vector4<S> where
    S: From<f32> + Zero
[src]

impl<S> From<Vector3<S>> for Vector4<S> where
    S: Zero
[src]

impl<S> From<Vector4<S>> for Vector4<S>[src]

impl<S: Hash> Hash for Vector4<S>[src]

impl<S> Index<Range<usize>> for Vector4<S>[src]

type Output = [S]

The returned type after indexing.

impl<S> Index<RangeFrom<usize>> for Vector4<S>[src]

type Output = [S]

The returned type after indexing.

impl<S> Index<RangeFull> for Vector4<S>[src]

type Output = [S]

The returned type after indexing.

impl<S> Index<RangeTo<usize>> for Vector4<S>[src]

type Output = [S]

The returned type after indexing.

impl<S> Index<usize> for Vector4<S>[src]

type Output = S

The returned type after indexing.

impl<S> IndexMut<Range<usize>> for Vector4<S>[src]

impl<S> IndexMut<RangeFrom<usize>> for Vector4<S>[src]

impl<S> IndexMut<RangeFull> for Vector4<S>[src]

impl<S> IndexMut<RangeTo<usize>> for Vector4<S>[src]

impl<S> IndexMut<usize> for Vector4<S>[src]

impl<S> InnerSpace for Vector4<S> where
    S: BaseFloat
[src]

impl<S> Into<[S; 4]> for Vector4<S>[src]

impl<S> Into<(S, S, S, S)> for Vector4<S>[src]

impl Into<Point2D<f32, UnknownUnit>> for Vector4[src]

impl<S> Into<Point2D<f64, UnknownUnit>> for Vector4<S> where
    S: Into<f64>, 
[src]

impl Into<Size2D<f32, UnknownUnit>> for Vector4[src]

impl Into<Vector2D<f32, UnknownUnit>> for Vector4[src]

impl<S> Into<Vector4<S>> for Vector4<S>[src]

impl<S> MetricSpace for Vector4<S> where
    S: BaseFloat
[src]

type Metric = S

The metric to be returned by the distance function.

impl<S> Mul<S> for Vector4<S> where
    S: Copy + Mul<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the * operator.

impl<S> Mul<Vector4<S>> for Vector4<S> where
    S: Mul<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the * operator.

impl<S> MulAssign<S> for Vector4<S> where
    S: Copy + MulAssign
[src]

impl<S> MulAssign<Vector4<S>> for Vector4<S> where
    S: Copy + MulAssign
[src]

impl<S> Neg for Vector4<S> where
    S: Neg<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the - operator.

impl<S: PartialEq> PartialEq<Vector4<S>> for Vector4<S>[src]

impl<S> RelativeEq<Vector4<S>> for Vector4<S> where
    S: RelativeEq,
    S::Epsilon: Copy
[src]

impl<S> Rem<S> for Vector4<S> where
    S: Copy + Rem<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the % operator.

impl<S> Rem<Vector4<S>> for Vector4<S> where
    S: Rem<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the % operator.

impl<S> RemAssign<S> for Vector4<S> where
    S: Copy + RemAssign
[src]

impl<S> RemAssign<Vector4<S>> for Vector4<S> where
    S: Copy + RemAssign
[src]

impl<S> Serialize for Vector4<S> where
    S: Serialize
[src]

impl<S> StructuralEq for Vector4<S>[src]

impl<S> StructuralPartialEq for Vector4<S>[src]

impl<S> Sub<Vector4<S>> for Vector4<S> where
    S: Sub<Output = S>, 
[src]

type Output = Vector4<S>

The resulting type after applying the - operator.

impl<S> SubAssign<Vector4<S>> for Vector4<S> where
    S: SubAssign
[src]

impl<'a, S: 'a> Sum<&'a Vector4<S>> for Vector4<S> where
    S: 'a + Clone + Zero + Add<Output = S>, 
[src]

impl<S> Sum<Vector4<S>> for Vector4<S> where
    S: Zero + Add<Output = S>, 
[src]

impl<S> UlpsEq<Vector4<S>> for Vector4<S> where
    S: UlpsEq,
    S::Epsilon: Copy
[src]

impl<S> VectorSpace for Vector4<S> where
    S: BaseNum
[src]

type Scalar = S

The associated scalar.

impl<S> Zero for Vector4<S> where
    S: PartialEq + Zero
[src]

Auto Trait Implementations

impl<S> RefUnwindSafe for Vector4<S> where
    S: RefUnwindSafe

impl<S> Send for Vector4<S> where
    S: Send

impl<S> Sync for Vector4<S> where
    S: Sync

impl<S> Unpin for Vector4<S> where
    S: Unpin

impl<S> UnwindSafe for Vector4<S> where
    S: UnwindSafe

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    T: Component + Float,
    D: AdaptFrom<S, Swp, Dwp, T>,
    Swp: WhitePoint,
    Dwp: WhitePoint
[src]

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

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

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

impl<T> CallHasher for T where
    T: Hash

impl<T, U> ConvertInto<U> for T where
    U: ConvertFrom<T>, 
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> Downcast<T> for T

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]

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

impl<T> Instrument for T[src]

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

impl<T> NodeId for T where
    T: 'static + Copy + Clone + PartialEq<T> + Eq + Hash + Send
[src]

impl<T, Rhs> NumAssignOps<Rhs> for T where
    T: AddAssign<Rhs> + SubAssign<Rhs> + MulAssign<Rhs> + DivAssign<Rhs> + RemAssign<Rhs>, 
[src]

impl<T, Rhs, Output> NumOps<Rhs, Output> for T where
    T: Sub<Rhs, Output = Output> + Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Add<Rhs, Output = Output> + Rem<Rhs, Output = Output>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

impl<T> SetParameter for T

impl<T> Style for T where
    T: Any + Debug + PartialEq<T>, 
[src]

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

type Owned = T

The resulting type after obtaining ownership.

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.

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.

impl<T> Upcast<T> for T

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

impl<T> Zero for T where
    T: Zero