Struct nannou::geom::vector::Vector2

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

A 2-dimensional vector.

Fields

x: S

y: S

Methods

impl<S> Vector2<S>

pub fn new(x: S, y: S) -> Vector2<S>

Construct a new vector, using the provided values.

pub fn from_value(scalar: S) -> Vector2<S> where
    S: Clone, 

Construct a vector using the given value for each field.

pub fn len(&self) -> usize

The number of dimensions in the vector.

pub fn map<U, F>(self, f: F) -> Vector2<U> where
    F: FnMut(S) -> U, 

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: Vector2<T>, f: F) -> Vector2<U> where
    F: FnMut(S, T) -> U, 

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, 

Test whether or not the vector is infinite.

pub fn cast<T>(&self) -> Option<Vector2<T>> where
    S: NumCast + Clone,
    T: NumCast, 

Component-wise casting to another type.

pub fn zero() -> Vector2<S> where
    S: Zero, 

A zeroed vector.

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

Whether or not the vector is zeroed.

pub fn one() -> Vector2<S> where
    S: One, 

A vector with 1 for each element.

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

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

pub fn is_nan(&self) -> bool where
    S: BaseFloat, 

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

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

Sum the fields of the vector.

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

The product of the fields of the vector.

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

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

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

Return a vector with the given magnitude.

pub fn normalize(self) -> Self where
    S: BaseFloat, 

Return a normalized vector.

If self is_zero, this returns self.

pub fn magnitude(self) -> S where
    S: BaseFloat, 

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, 

The square of the magnitude.

See the magnitude docs for details.

pub fn dot(self, other: Vector2<S>) -> S where
    S: BaseFloat, 

The dot product of self and the given vector.

impl<S> Vector2<S>

pub fn unit_x() -> Vector2<S> where
    S: Zero + One, 

A unit vector in the x direction.

pub fn unit_y() -> Vector2<S> where
    S: Zero + One, 

A unit vector in the y direction.

pub fn perp_dot(self, other: Vector2<S>) -> S where
    S: Sub<Output = S> + Mul<Output = S>, 

The perpendicular dot product of the vector and other.

pub fn extend(self, z: S) -> Vector3<S>

Create a Vector3, using the x and y values from this vector, and the provided z.

pub fn from_angle(radians: S) -> Self where
    S: BaseFloat, 

Construct a normalised (aka "unit") vector from the given angle in radians.

Examples

assert_eq!(Vector2::from_angle(0.0), vec2(1.0, 0.0));
// Keep an eye out for accumulating floating point error.
assert_eq!(Vector2::from_angle(PI * 0.5), vec2(-0.00000004371139, 1.0));
assert_eq!(Vector2::from_angle(PI), vec2(-1.0, -0.00000008742278));
assert_eq!(Vector2::from_angle(PI * 1.5), vec2(0.000000011924881, -1.0));
assert_eq!(Vector2::from_angle(TAU), vec2(1.0, 0.00000017484555));

pub fn angle(self) -> S where
    S: BaseFloat, 

Returns the angle of the vector in radians.

Examples

let v = vec2(-0.5, 0.5);
let radians = v.angle();
draw.quad()
    .rotate(radians);
assert_eq!(radians, 2.356194490192345);

pub fn angle_between(self, other: Self) -> S where
    S: BaseFloat, 

Returns the angle of the vector between self and other in radians.

The result is between 0 and PI. Note: Nannou's implementation is commutative (v1.angle_between(v2) == v2.angle_between(v1)).

Example

let right = vec2(2.0, 0.0);
let up = vec2(0.0, 3.0);
let down = vec2(0.0, -100.0);
assert_eq!(right.angle_between(up), PI/2.0);
assert_eq!(right.angle_between(down), PI/2.0);

pub fn rotate(self, radians: S) -> Self where
    S: BaseFloat, 

Rotate the vector around the origin (0.0, 0.0) by the given radians.

Examples

let v = vec2(100.0, 0.0);
assert_eq!(v.rotate(PI).x, -v.x);
assert_eq!(v.rotate(TAU).x, v.x);

Trait Implementations

impl<S> AbsDiffEq<Vector2<S>> for Vector2<S> where
    S: AbsDiffEq,
    S::Epsilon: Copy, 

type Epsilon = S::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> S::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of ApproxEq::abs_diff_eq.

impl<S> Add<Vector2<S>> for Vector2<S> where
    S: Add<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl<S> AddAssign<Vector2<S>> for Vector2<S> where
    S: AddAssign, 

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<S> Array for Vector2<S> where
    S: Copy, 

type Element = S

fn len() -> usize

Get the number of elements in the array type

fn from_value(scalar: S) -> Vector2<S>

Construct a vector from a single value, replicating it.

fn sum(self) -> S where
    S: Add<Output = S>, 

The sum of the elements of the array.

fn product(self) -> S where
    S: Mul<Output = S>, 

The product of the elements of the array.

fn is_finite(&self) -> bool where
    S: BaseFloat, 

Whether all elements of the array are finite

fn as_ptr(&self) -> *const Self::Element

Get the pointer to the first element of the array.

fn as_mut_ptr(&mut self) -> *mut Self::Element

Get a mutable pointer to the first element of the array.

fn swap_elements(&mut self, i: usize, j: usize)

Swap the elements at indices i and j in-place.

impl<S> AsMut<[S; 2]> for Vector2<S>

fn as_mut(&mut self) -> &mut [S; 2]

Performs the conversion.

impl<S> AsRef<[S; 2]> for Vector2<S>

fn as_ref(&self) -> &[S; 2]

Performs the conversion.

impl<S> Bounded for Vector2<S> where
    S: Bounded, 

fn min_value() -> Vector2<S>

returns the smallest finite number this type can represent

fn max_value() -> Vector2<S>

returns the largest finite number this type can represent

impl<S: Clone> Clone for Vector2<S>

fn clone(&self) -> Vector2<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for Vector2<S>

impl<S: Debug> Debug for Vector2<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Vector2<S>

fn default() -> Vector2<S>

Returns the "default value" for a type.

impl<S> Deref for Vector2<S>

type Target = [S; 2]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S> DerefMut for Vector2<S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, S> Deserialize<'de> for Vector2<S> where
    S: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<S> Distribution<Vector2<S>> for Standard where
    Standard: Distribution<S>, 

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Vector2<S>

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

impl<S> Div<S> for Vector2<S> where
    S: Copy + Div<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the / operator.

fn div(self, scalar: S) -> Self

Performs the / operation.

impl<S> Div<Vector2<S>> for Vector2<S> where
    S: Div<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl<S> DivAssign<S> for Vector2<S> where
    S: Copy + DivAssign, 

fn div_assign(&mut self, scalar: S)

Performs the /= operation.

impl<S> DivAssign<Vector2<S>> for Vector2<S> where
    S: Copy + DivAssign, 

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<S> ElementWise<S> for Vector2<S> where
    S: BaseNum, 

fn add_element_wise(self, rhs: S) -> Vector2<S>

fn sub_element_wise(self, rhs: S) -> Vector2<S>

fn mul_element_wise(self, rhs: S) -> Vector2<S>

fn div_element_wise(self, rhs: S) -> Vector2<S>

fn rem_element_wise(self, rhs: S) -> Vector2<S>

fn add_assign_element_wise(&mut self, rhs: S)

fn sub_assign_element_wise(&mut self, rhs: S)

fn mul_assign_element_wise(&mut self, rhs: S)

fn div_assign_element_wise(&mut self, rhs: S)

fn rem_assign_element_wise(&mut self, rhs: S)

impl<S> ElementWise<Vector2<S>> for Vector2<S> where
    S: BaseFloat, 

fn add_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn sub_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn mul_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn div_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn rem_element_wise(self, rhs: Vector2<S>) -> Vector2<S>

fn add_assign_element_wise(&mut self, rhs: Vector2<S>)

fn sub_assign_element_wise(&mut self, rhs: Vector2<S>)

fn mul_assign_element_wise(&mut self, rhs: Vector2<S>)

fn div_assign_element_wise(&mut self, rhs: Vector2<S>)

fn rem_assign_element_wise(&mut self, rhs: Vector2<S>)

impl<S: Eq> Eq for Vector2<S>

impl<S> EuclideanSpace for Vector2<S> where
    S: BaseNum, 

type Scalar = S

The associated scalar over which the space is defined.

type Diff = Vector2<S>

The associated space of displacement vectors.

fn origin() -> Self

The point at the origin of the Euclidean space.

fn from_vec(v: Vector2<S>) -> Self

Convert a displacement vector to a point.

fn to_vec(self) -> Vector2<S>

Convert a point to a displacement vector.

fn dot(self, other: Vector2<S>) -> S

This is a weird one, but its useful for plane calculations.

fn midpoint(self, other: Self) -> Self

Returns the middle point between two other points.

fn centroid(points: &[Self]) -> Self

Returns the average position of all points in the slice.

impl<S> From<[S; 2]> for Vector2<S> where
    S: Copy, 

fn from(v: [S; 2]) -> Self

Performs the conversion.

impl<S> From<(S, S)> for Vector2<S>

fn from((x, y): (S, S)) -> Self

Performs the conversion.

impl<S> From<Point2<S>> for Vector2<S>

fn from(v: Point2<S>) -> Self

Performs the conversion.

impl<S> From<Point2D<f32, UnknownUnit>> for Vector2<S> where
    S: From<f32>, 

fn from(p: Point) -> Self

Performs the conversion.

impl<S> From<Point2D<f64, UnknownUnit>> for Vector2<S> where
    S: From<f64>, 

fn from(p: F64Point) -> Self

Performs the conversion.

impl<S> From<Size2D<f32, UnknownUnit>> for Vector2<S> where
    S: From<f32>, 

fn from(p: Size) -> Self

Performs the conversion.

impl<S> From<Vector2<S>> for Vector2<S>

fn from(v: Vector2<S>) -> Self

Performs the conversion.

impl<S> From<Vector2<S>> for Vector3<S> where
    S: Zero, 

fn from(Vector2 { x: x, y: y }: Vector2<S>) -> Self

Performs the conversion.

impl<S> From<Vector2<S>> for Vector4<S> where
    S: Zero, 

fn from(Vector2 { x: x, y: y }: Vector2<S>) -> Self

Performs the conversion.

impl<S> From<Vector2D<f32, UnknownUnit>> for Vector2<S> where
    S: From<f32>, 

fn from(v: Vector) -> Self

Performs the conversion.

impl<S: Hash> Hash for Vector2<S>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<S> Index<Range<usize>> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index<'a>(&'a self, i: Range<usize>) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<RangeFrom<usize>> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index<'a>(&'a self, i: RangeFrom<usize>) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<RangeFull> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index<'a>(&'a self, i: RangeFull) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<RangeTo<usize>> for Vector2<S>

type Output = [S]

The returned type after indexing.

fn index<'a>(&'a self, i: RangeTo<usize>) -> &'a [S]

Performs the indexing (container[index]) operation.

impl<S> Index<usize> for Vector2<S>

type Output = S

The returned type after indexing.

fn index<'a>(&'a self, i: usize) -> &'a S

Performs the indexing (container[index]) operation.

impl<S> IndexMut<Range<usize>> for Vector2<S>

fn index_mut<'a>(&'a mut self, i: Range<usize>) -> &'a mut [S]

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

impl<S> IndexMut<RangeFrom<usize>> for Vector2<S>

fn index_mut<'a>(&'a mut self, i: RangeFrom<usize>) -> &'a mut [S]

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

impl<S> IndexMut<RangeFull> for Vector2<S>

fn index_mut<'a>(&'a mut self, i: RangeFull) -> &'a mut [S]

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

impl<S> IndexMut<RangeTo<usize>> for Vector2<S>

fn index_mut<'a>(&'a mut self, i: RangeTo<usize>) -> &'a mut [S]

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

impl<S> IndexMut<usize> for Vector2<S>

fn index_mut<'a>(&'a mut self, i: usize) -> &'a mut S

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

impl<S> InnerSpace for Vector2<S> where
    S: BaseFloat, 

fn dot(self, other: Vector2<S>) -> S

Vector dot (or inner) product.

fn angle(self, other: Vector2<S>) -> Rad<S>

Returns the angle between two vectors in radians.

fn is_perpendicular(self, other: Self) -> bool

Returns true if the vector is perpendicular (at right angles) to the other vector.

fn magnitude2(self) -> Self::Scalar

Returns the squared magnitude.

fn magnitude(self) -> Self::Scalar

The distance from the tail to the tip of the vector.

fn normalize(self) -> Self

Returns a vector with the same direction, but with a magnitude of 1.

fn normalize_to(self, magnitude: Self::Scalar) -> Self

Returns a vector with the same direction and a given magnitude.

fn project_on(self, other: Self) -> Self

Returns the vector projection of the current inner space projected onto the supplied argument.

impl<S> Into<[S; 2]> for Vector2<S>

fn into(self) -> [S; 2]

Performs the conversion.

impl<S> Into<(S, S)> for Vector2<S>

fn into(self) -> (S, S)

Performs the conversion.

impl<S> Into<Point2<S>> for Vector2<S>

fn into(self) -> Point2<S>

Performs the conversion.

impl Into<Point2D<f32, UnknownUnit>> for Vector2

fn into(self) -> Point

Performs the conversion.

impl<S> Into<Point2D<f64, UnknownUnit>> for Vector2<S> where
    S: Into<f64>, 

fn into(self) -> F64Point

Performs the conversion.

impl Into<Size2D<f32, UnknownUnit>> for Vector2

fn into(self) -> Size

Performs the conversion.

impl<S> Into<Vector2<S>> for Vector2<S>

fn into(self) -> Vector2<S>

Performs the conversion.

impl Into<Vector2D<f32, UnknownUnit>> for Vector2

fn into(self) -> Vector

Performs the conversion.

impl<S> MetricSpace for Vector2<S> where
    S: BaseFloat, 

type Metric = S

The metric to be returned by the distance function.

fn distance2(self, other: Self) -> S

Returns the squared distance.

fn distance(self, other: Self) -> Self::Metric

The distance between two values.

impl<S> Mul<S> for Vector2<S> where
    S: Copy + Mul<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, scalar: S) -> Self

Performs the * operation.

impl<S> Mul<Vector2<S>> for Vector2<S> where
    S: Mul<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl<S> MulAssign<S> for Vector2<S> where
    S: Copy + MulAssign, 

fn mul_assign(&mut self, scalar: S)

Performs the *= operation.

impl<S> MulAssign<Vector2<S>> for Vector2<S> where
    S: Copy + MulAssign, 

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<S> Neg for Vector2<S> where
    S: Neg<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the - operator.

fn neg(self) -> Vector2<S>

Performs the unary - operation.

impl<S: PartialEq> PartialEq<Vector2<S>> for Vector2<S>

fn eq(&self, other: &Vector2<S>) -> bool

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

fn ne(&self, other: &Vector2<S>) -> bool

This method tests for !=.

impl<S> RelativeEq<Vector2<S>> for Vector2<S> where
    S: RelativeEq,
    S::Epsilon: Copy, 

fn default_max_relative() -> S::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne(
    &self,
    other: &Rhs,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool

The inverse of ApproxEq::relative_eq.

impl<S> Rem<S> for Vector2<S> where
    S: Copy + Rem<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the % operator.

fn rem(self, scalar: S) -> Self

Performs the % operation.

impl<S> Rem<Vector2<S>> for Vector2<S> where
    S: Rem<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self

Performs the % operation.

impl<S> RemAssign<S> for Vector2<S> where
    S: Copy + RemAssign, 

fn rem_assign(&mut self, scalar: S)

Performs the %= operation.

impl<S> RemAssign<Vector2<S>> for Vector2<S> where
    S: Copy + RemAssign, 

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<S> Serialize for Vector2<S> where
    S: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<S> StructuralEq for Vector2<S>

impl<S> StructuralPartialEq for Vector2<S>

impl<S> Sub<Vector2<S>> for Vector2<S> where
    S: Sub<Output = S>, 

type Output = Vector2<S>

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl<S> SubAssign<Vector2<S>> for Vector2<S> where
    S: SubAssign, 

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<'a, S: 'a> Sum<&'a Vector2<S>> for Vector2<S> where
    S: 'a + Clone + Zero + Add<Output = S>, 

fn sum<I>(iter: I) -> Vector2<S> where
    I: Iterator<Item = &'a Vector2<S>>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl<S> Sum<Vector2<S>> for Vector2<S> where
    S: Zero + Add<Output = S>, 

fn sum<I>(iter: I) -> Vector2<S> where
    I: Iterator<Item = Vector2<S>>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.

impl<S> UlpsEq<Vector2<S>> for Vector2<S> where
    S: UlpsEq,
    S::Epsilon: Copy, 

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of ApproxEq::ulps_eq.

impl<S> VectorSpace for Vector2<S> where
    S: BaseNum, 

type Scalar = S

The associated scalar.

fn lerp(self, other: Self, amount: Self::Scalar) -> Self

Returns the result of linearly interpolating the vector towards other by the specified amount.

impl<S> Zero for Vector2<S> where
    S: PartialEq + Zero, 

fn zero() -> Vector2<S>

Returns the additive identity element of Self, 0. # Purity

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.