Struct Vector2D

#[repr(C)]
pub struct Vector2D<T, U> {
    pub x: T,
    pub y: T,
    /* private fields */
}

A 2d Vector tagged with a unit.

Fields

x: T

The x (traditionally, horizontal) coordinate.

y: T

The y (traditionally, vertical) coordinate.

Implementations

impl<T, U> Vector2D<T, U>

pub fn zero() -> Vector2D<T, U>

where T: Zero,

Constructor, setting all components to zero.

pub fn one() -> Vector2D<T, U>

where T: One,

Constructor, setting all components to one.

pub const fn new(x: T, y: T) -> Vector2D<T, U>

Constructor taking scalar values directly.

pub fn splat(v: T) -> Vector2D<T, U>

where T: Clone,

Constructor setting all components to the same value.

pub fn from_angle_and_length(angle: Angle<T>, length: T) -> Vector2D<T, U>

where T: Trig + Mul<Output = T> + Copy,

Constructor taking angle and length

pub fn from_lengths(x: Length<T, U>, y: Length<T, U>) -> Vector2D<T, U>

Constructor taking properly Lengths instead of scalar values.

pub fn from_untyped(p: Vector2D<T, UnknownUnit>) -> Vector2D<T, U>

Tag a unit-less value with units.

pub fn map<V, F>(self, f: F) -> Vector2D<V, U>

where F: FnMut(T) -> V,

Apply the function f to each component of this vector.

Example

This may be used to perform unusual arithmetic which is not already offered as methods.

use euclid::default::Vector2D;

let p = Vector2D::<u32>::new(5, 11);
assert_eq!(p.map(|coord| coord.saturating_sub(10)), Vector2D::new(0, 1));

pub fn zip<V, F>(self, rhs: Vector2D<T, U>, f: F) -> Vector2D<V, U>

where F: FnMut(T, T) -> V,

Apply the function f to each pair of components of this point and rhs.

Example

This may be used to perform unusual arithmetic which is not already offered as methods.

use euclid::default::Vector2D;

let a: Vector2D<u8> = Vector2D::new(50, 200);
let b: Vector2D<u8> = Vector2D::new(100, 100);
assert_eq!(a.zip(b, u8::saturating_add), Vector2D::new(150, 255));

pub fn abs(self) -> Vector2D<T, U>

where T: Signed,

Computes the vector with absolute values of each component.

Example

enum U {}

assert_eq!(vec2::<_, U>(-1, 2).abs(), vec2(1, 2));

let vec = vec2::<_, U>(f32::NAN, -f32::MAX).abs();
assert!(vec.x.is_nan());
assert_eq!(vec.y, f32::MAX);

Panics

The behavior for each component follows the scalar type’s implementation of num_traits::Signed::abs.

pub fn dot(self, other: Vector2D<T, U>) -> T

where T: Add<Output = T> + Mul<Output = T>,

Dot product.

pub fn cross(self, other: Vector2D<T, U>) -> T

where T: Sub<Output = T> + Mul<Output = T>,

Returns the norm of the cross product [self.x, self.y, 0] x [other.x, other.y, 0].

pub fn component_mul(self, other: Vector2D<T, U>) -> Vector2D<T, U>

where T: Mul<Output = T>,

Returns the component-wise multiplication of the two vectors.

pub fn component_div(self, other: Vector2D<T, U>) -> Vector2D<T, U>

where T: Div<Output = T>,

Returns the component-wise division of the two vectors.

impl<T, U> Vector2D<T, U>

where T: Copy,

pub fn extend(self, z: T) -> Vector3D<T, U>

Create a 3d vector from this one, using the specified z value.

pub fn to_point(self) -> Point2D<T, U>

Cast this vector into a point.

Equivalent to adding this vector to the origin.

pub fn yx(self) -> Vector2D<T, U>

Swap x and y.

pub fn to_size(self) -> Size2D<T, U>

Cast this vector into a size.

pub fn to_untyped(self) -> Vector2D<T, UnknownUnit>

Drop the units, preserving only the numeric value.

pub fn cast_unit<V>(self) -> Vector2D<T, V>

Cast the unit.

pub fn to_array(self) -> [T; 2]

Cast into an array with x and y.

pub fn to_tuple(self) -> (T, T)

Cast into a tuple with x and y.

pub fn to_3d(self) -> Vector3D<T, U>

where T: Zero,

Convert into a 3d vector with z coordinate equals to T::zero().

pub fn round(self) -> Vector2D<T, U>

where T: Round,

Rounds each component to the nearest integer value.

This behavior is preserved for negative values (unlike the basic cast).

enum Mm {}

assert_eq!(vec2::<_, Mm>(-0.1, -0.8).round(), vec2::<_, Mm>(0.0, -1.0))

pub fn ceil(self) -> Vector2D<T, U>

where T: Ceil,

Rounds each component to the smallest integer equal or greater than the original value.

This behavior is preserved for negative values (unlike the basic cast).

enum Mm {}

assert_eq!(vec2::<_, Mm>(-0.1, -0.8).ceil(), vec2::<_, Mm>(0.0, 0.0))

pub fn floor(self) -> Vector2D<T, U>

where T: Floor,

Rounds each component to the biggest integer equal or lower than the original value.

This behavior is preserved for negative values (unlike the basic cast).

enum Mm {}

assert_eq!(vec2::<_, Mm>(-0.1, -0.8).floor(), vec2::<_, Mm>(-1.0, -1.0))

pub fn angle_from_x_axis(self) -> Angle<T>

where T: Trig,

Returns the signed angle between this vector and the x axis. Positive values counted counterclockwise, where 0 is +x axis, PI/2 is +y axis.

The returned angle is between -PI and PI.

pub fn to_transform(self) -> Transform2D<T, U, U>

where T: Zero + One,

Creates translation by this vector in vector units.

impl<T, U> Vector2D<T, U>

where T: Copy + Mul<Output = T> + Add<Output = T>,

pub fn square_length(self) -> T

Returns the vector’s length squared.

pub fn project_onto_vector(self, onto: Vector2D<T, U>) -> Vector2D<T, U>

where T: Sub<Output = T> + Div<Output = T>,

Returns this vector projected onto another one.

Projecting onto a nil vector will cause a division by zero.

pub fn angle_to(self, other: Vector2D<T, U>) -> Angle<T>

where T: Sub<Output = T> + Trig,

Returns the signed angle between this vector and another vector.

The returned angle is between -PI and PI.

impl<T, U> Vector2D<T, U>

where T: Float,

pub fn robust_normalize(self) -> Vector2D<T, U>

Return the normalized vector even if the length is larger than the max value of Float.

pub fn is_finite(self) -> bool

Returns true if all members are finite.

impl<T, U> Vector2D<T, U>

where T: Real,

pub fn length(self) -> T

Returns the vector length.

pub fn normalize(self) -> Vector2D<T, U>

Returns the vector with length of one unit.

pub fn try_normalize(self) -> Option<Vector2D<T, U>>

Returns the vector with length of one unit.

Unlike Vector2D::normalize, this returns None in the case that the length of the vector is zero.

pub fn with_length(self, length: T) -> Vector2D<T, U>

Return this vector scaled to fit the provided length.

pub fn with_max_length(self, max_length: T) -> Vector2D<T, U>

Return this vector capped to a maximum length.

pub fn with_min_length(self, min_length: T) -> Vector2D<T, U>

Return this vector with a minimum length applied.

pub fn clamp_length(self, min: T, max: T) -> Vector2D<T, U>

Return this vector with minimum and maximum lengths applied.

impl<T, U> Vector2D<T, U>

where T: One + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Copy,

pub fn lerp(self, other: Vector2D<T, U>, t: T) -> Vector2D<T, U>

Linearly interpolate each component between this vector and another vector.

Example

use euclid::vec2;
use euclid::default::Vector2D;

let from: Vector2D<_> = vec2(0.0, 10.0);
let to:  Vector2D<_> = vec2(8.0, -4.0);

assert_eq!(from.lerp(to, -1.0), vec2(-8.0,  24.0));
assert_eq!(from.lerp(to,  0.0), vec2( 0.0,  10.0));
assert_eq!(from.lerp(to,  0.5), vec2( 4.0,   3.0));
assert_eq!(from.lerp(to,  1.0), vec2( 8.0,  -4.0));
assert_eq!(from.lerp(to,  2.0), vec2(16.0, -18.0));

pub fn reflect(self, normal: Vector2D<T, U>) -> Vector2D<T, U>

Returns a reflection vector using an incident ray and a surface normal.

impl<T, U> Vector2D<T, U>

where T: PartialOrd,

pub fn min(self, other: Vector2D<T, U>) -> Vector2D<T, U>

Returns the vector each component of which are minimum of this vector and another.

pub fn max(self, other: Vector2D<T, U>) -> Vector2D<T, U>

Returns the vector each component of which are maximum of this vector and another.

pub fn clamp(self, start: Vector2D<T, U>, end: Vector2D<T, U>) -> Vector2D<T, U>

where T: Copy,

Returns the vector each component of which is clamped by corresponding components of start and end.

Shortcut for self.max(start).min(end).

pub fn greater_than(self, other: Vector2D<T, U>) -> BoolVector2D

Returns vector with results of “greater than” operation on each component.

pub fn lower_than(self, other: Vector2D<T, U>) -> BoolVector2D

Returns vector with results of “lower than” operation on each component.

impl<T, U> Vector2D<T, U>

where T: PartialEq,

pub fn equal(self, other: Vector2D<T, U>) -> BoolVector2D

Returns vector with results of “equal” operation on each component.

pub fn not_equal(self, other: Vector2D<T, U>) -> BoolVector2D

Returns vector with results of “not equal” operation on each component.

impl<T, U> Vector2D<T, U>

where T: NumCast + Copy,

pub fn cast<NewT>(self) -> Vector2D<NewT, U>

where NewT: NumCast,

Cast from one numeric representation to another, preserving the units.

When casting from floating vector to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn try_cast<NewT>(self) -> Option<Vector2D<NewT, U>>

where NewT: NumCast,

Fallible cast from one numeric representation to another, preserving the units.

When casting from floating vector to integer coordinates, the decimals are truncated as one would expect from a simple cast, but this behavior does not always make sense geometrically. Consider using round(), ceil() or floor() before casting.

pub fn to_f32(self) -> Vector2D<f32, U>

Cast into an f32 vector.

pub fn to_f64(self) -> Vector2D<f64, U>

Cast into an f64 vector.

pub fn to_usize(self) -> Vector2D<usize, U>

Cast into an usize vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_u32(self) -> Vector2D<u32, U>

Cast into an u32 vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i32(self) -> Vector2D<i32, U>

Cast into an i32 vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

pub fn to_i64(self) -> Vector2D<i64, U>

Cast into an i64 vector, truncating decimals if any.

When casting from floating vector vectors, it is worth considering whether to round(), ceil() or floor() before the cast in order to obtain the desired conversion behavior.

Trait Implementations

impl<T, U> Add<&Vector2D<T, U>> for Vector2D<T, U>

where T: Add + Copy,

type Output = Vector2D<<T as Add>::Output, U>

The resulting type after applying the + operator.

fn add( self, other: &Vector2D<T, U>, ) -> <Vector2D<T, U> as Add<&Vector2D<T, U>>>::Output

Performs the + operation.

impl<T, U> Add<Vector2D<T, U>> for Point2D<T, U>

where T: Add,

type Output = Point2D<<T as Add>::Output, U>

The resulting type after applying the + operator.

fn add( self, other: Vector2D<T, U>, ) -> <Point2D<T, U> as Add<Vector2D<T, U>>>::Output

Performs the + operation.

impl<T, U> Add for Vector2D<T, U>

where T: Add,

type Output = Vector2D<<T as Add>::Output, U>

The resulting type after applying the + operator.

fn add(self, other: Vector2D<T, U>) -> <Vector2D<T, U> as Add>::Output

Performs the + operation.

impl<T, U> AddAssign<Vector2D<T, U>> for Point2D<T, U>

where T: Copy + Add<Output = T>,

fn add_assign(&mut self, other: Vector2D<T, U>)

Performs the += operation.

impl<T, U> AddAssign for Vector2D<T, U>

where T: Copy + Add<Output = T>,

fn add_assign(&mut self, other: Vector2D<T, U>)

Performs the += operation.

impl<T, U> ApproxEq<Vector2D<T, U>> for Vector2D<T, U>

where T: ApproxEq<T>,

fn approx_epsilon() -> Vector2D<T, U>

Default epsilon value

fn approx_eq_eps(&self, other: &Vector2D<T, U>, eps: &Vector2D<T, U>) -> bool

Returns true if this object is approximately equal to the other one, using a provided epsilon value.

fn approx_eq(&self, other: &Self) -> bool

Returns true if this object is approximately equal to the other one, using the approx_epsilon epsilon value.

impl<T, U> Ceil for Vector2D<T, U>

where T: Ceil,

fn ceil(self) -> Vector2D<T, U>

See Vector2D::ceil.

impl<T, U> Clone for Vector2D<T, U>

where T: Clone,

fn clone(&self) -> Vector2D<T, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U> Debug for Vector2D<T, U>

where T: Debug,

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

Formats the value using the given formatter.

impl<T, U> Default for Vector2D<T, U>

where T: Default,

fn default() -> Vector2D<T, U>

Returns the “default value” for a type.

impl<T, U1, U2> Div<Scale<T, U1, U2>> for Vector2D<T, U2>

where T: Copy + Div,

type Output = Vector2D<<T as Div>::Output, U1>

The resulting type after applying the / operator.

fn div( self, scale: Scale<T, U1, U2>, ) -> <Vector2D<T, U2> as Div<Scale<T, U1, U2>>>::Output

Performs the / operation.

impl<T, U> Div<T> for Vector2D<T, U>

where T: Copy + Div,

type Output = Vector2D<<T as Div>::Output, U>

The resulting type after applying the / operator.

fn div(self, scale: T) -> <Vector2D<T, U> as Div<T>>::Output

Performs the / operation.

impl<T, U> DivAssign<Scale<T, U, U>> for Vector2D<T, U>

where T: Copy + DivAssign,

fn div_assign(&mut self, scale: Scale<T, U, U>)

Performs the /= operation.

impl<T, U> DivAssign<T> for Vector2D<T, U>

where T: Copy + Div<Output = T>,

fn div_assign(&mut self, scale: T)

Performs the /= operation.

impl<T, U> Floor for Vector2D<T, U>

where T: Floor,

fn floor(self) -> Vector2D<T, U>

See Vector2D::floor.

impl<T, U> From<[T; 2]> for Vector2D<T, U>

fn from(_: [T; 2]) -> Vector2D<T, U>

Converts to this type from the input type.

impl<T, U> From<(T, T)> for Vector2D<T, U>

fn from(tuple: (T, T)) -> Vector2D<T, U>

Converts to this type from the input type.

impl<T, U> From<Size2D<T, U>> for Vector2D<T, U>

fn from(s: Size2D<T, U>) -> Vector2D<T, U>

Converts to this type from the input type.

impl<T, Src, Dst> From<Translation2D<T, Src, Dst>> for Vector2D<T, Src>

fn from(t: Translation2D<T, Src, Dst>) -> Vector2D<T, Src>

Converts to this type from the input type.

impl<T, Src, Dst> From<Vector2D<T, Src>> for Translation2D<T, Src, Dst>

fn from(v: Vector2D<T, Src>) -> Translation2D<T, Src, Dst>

Converts to this type from the input type.

impl<T, U> From<Vector2D<T, U>> for HomogeneousVector<T, U>

where T: Zero,

fn from(v: Vector2D<T, U>) -> HomogeneousVector<T, U>

Converts to this type from the input type.

impl<T, U> From<Vector2D<T, U>> for Size2D<T, U>

fn from(v: Vector2D<T, U>) -> Size2D<T, U>

Converts to this type from the input type.

impl<T, U> Hash for Vector2D<T, U>

where T: Hash,

fn hash<H>(&self, h: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, U1, U2> Mul<Scale<T, U1, U2>> for Vector2D<T, U1>

where T: Copy + Mul,

type Output = Vector2D<<T as Mul>::Output, U2>

The resulting type after applying the * operator.

fn mul( self, scale: Scale<T, U1, U2>, ) -> <Vector2D<T, U1> as Mul<Scale<T, U1, U2>>>::Output

Performs the * operation.

impl<T, U> Mul<T> for Vector2D<T, U>

where T: Copy + Mul,

type Output = Vector2D<<T as Mul>::Output, U>

The resulting type after applying the * operator.

fn mul(self, scale: T) -> <Vector2D<T, U> as Mul<T>>::Output

Performs the * operation.

impl<T, U> MulAssign<Scale<T, U, U>> for Vector2D<T, U>

where T: Copy + MulAssign,

fn mul_assign(&mut self, scale: Scale<T, U, U>)

Performs the *= operation.

impl<T, U> MulAssign<T> for Vector2D<T, U>

where T: Copy + Mul<Output = T>,

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

impl<T, U> Neg for Vector2D<T, U>

where T: Neg,

type Output = Vector2D<<T as Neg>::Output, U>

The resulting type after applying the - operator.

fn neg(self) -> <Vector2D<T, U> as Neg>::Output

Performs the unary - operation.

impl<T, U> PartialEq for Vector2D<T, U>

where T: PartialEq,

fn eq(&self, other: &Vector2D<T, U>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, U> Round for Vector2D<T, U>

where T: Round,

fn round(self) -> Vector2D<T, U>

See Vector2D::round.

impl<T, U> Sub<Vector2D<T, U>> for Point2D<T, U>

where T: Sub,

type Output = Point2D<<T as Sub>::Output, U>

The resulting type after applying the - operator.

fn sub( self, other: Vector2D<T, U>, ) -> <Point2D<T, U> as Sub<Vector2D<T, U>>>::Output

Performs the - operation.

impl<T, U> Sub for Vector2D<T, U>

where T: Sub,

type Output = Vector2D<<T as Sub>::Output, U>

The resulting type after applying the - operator.

fn sub(self, other: Vector2D<T, U>) -> <Vector2D<T, U> as Sub>::Output

Performs the - operation.

impl<T, U> SubAssign<Vector2D<T, U>> for Point2D<T, U>

where T: Copy + Sub<Output = T>,

fn sub_assign(&mut self, other: Vector2D<T, U>)

Performs the -= operation.

impl<T, U> SubAssign for Vector2D<T, U>

where T: Copy + Sub<Output = T>,

fn sub_assign(&mut self, other: Vector2D<T, U>)

Performs the -= operation.

impl<'a, T, U> Sum<&'a Vector2D<T, U>> for Vector2D<T, U>

where T: 'a + Add<Output = T> + Copy + Zero, U: 'a,

fn sum<I>(iter: I) -> Vector2D<T, U>

where I: Iterator<Item = &'a Vector2D<T, U>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T, U> Sum for Vector2D<T, U>

where T: Add<Output = T> + Zero,

fn sum<I>(iter: I) -> Vector2D<T, U>

where I: Iterator<Item = Vector2D<T, U>>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T, U> Zero for Vector2D<T, U>

where T: Zero,

fn zero() -> Vector2D<T, U>

Constructor, setting all components to zero.

impl<T, U> Copy for Vector2D<T, U>

where T: Copy,

impl<T, U> Eq for Vector2D<T, U>

where T: Eq,