Struct euclid::Vector2D

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

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() -> Self where
    T: Zero, 

Constructor, setting all components to zero.

pub const fn new(x: T, y: T) -> Self

Constructor taking scalar values directly.

pub fn from_angle_and_length(angle: Angle<T>, length: T) -> Self where
    T: Trig + Mul<Output = T> + Copy, 

Constructor taking angle and length

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

Constructor taking properly Lengths instead of scalar values.

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

Tag a unit-less value with units.

pub fn abs(&self) -> Self 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: Self) -> T where
    T: Add<Output = T> + Mul<Output = T>, 

Dot product.

pub fn cross(self, other: Self) -> 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].

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

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) -> Self

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().

#[must_use]pub fn round(&self) -> Self 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))

#[must_use]pub fn ceil(&self) -> Self 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))

#[must_use]pub fn floor(&self) -> Self 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<T, Output = T> + Add<T, Output = T>, 

pub fn square_length(&self) -> T

Returns the vector's length squared.

pub fn project_onto_vector(&self, onto: Self) -> Self where
    T: Sub<T, Output = T> + Div<T, 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: Self) -> 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: Float, U> Vector2D<T, U>

pub fn length(&self) -> T

Returns the vector length.

#[must_use]pub fn normalize(self) -> Self

Returns the vector with length of one unit.

#[must_use]pub fn try_normalize(self) -> Option<Self>

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.

#[must_use]pub fn robust_normalize(self) -> Self

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

pub fn with_max_length(&self, max_length: T) -> Self

Return this vector capped to a maximum length.

pub fn with_min_length(&self, min_length: T) -> Self

Return this vector with a minimum length applied.

pub fn clamp_length(&self, min: T, max: T) -> Self

Return this vector with minimum and maximum lengths applied.

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

pub fn lerp(&self, other: Self, t: T) -> Self

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: Self) -> Self

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

impl<T: PartialOrd, U> Vector2D<T, U>

pub fn min(self, other: Self) -> Self

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

pub fn max(self, other: Self) -> Self

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

pub fn clamp(&self, start: Self, end: Self) -> Self 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: Self) -> BoolVector2D

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

pub fn lower_than(&self, other: Self) -> BoolVector2D

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

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

pub fn equal(&self, other: Self) -> BoolVector2D

Returns vector with results of "equal" operation on each component.

pub fn not_equal(&self, other: Self) -> BoolVector2D

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

impl<T: NumCast + Copy, U> Vector2D<T, U>

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

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: NumCast>(&self) -> Option<Vector2D<NewT, U>>

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: Add, U> Add<Vector2D<T, U>> for Point2D<T, U>

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

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector2D<T, U>> for Point2D<T, U>

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

Performs the += operation.

impl<T: Copy + Add<T, Output = T>, U> AddAssign<Vector2D<T, U>> for Vector2D<T, U>

fn add_assign(&mut self, other: Self)

Performs the += operation.

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

fn approx_epsilon() -> Self

Default epsilon value

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

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

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

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

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

fn ceil(self) -> Self

See Vector2D::ceil()

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the "default value" for a type.

impl<T: Display, U> Display for Vector2D<T, U>

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

Formats the value using the given formatter.

impl<T: Clone + Div, U1, U2> Div<Scale<T, U1, U2>> for Vector2D<T, U2>

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

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Clone + Div, U> Div<T> for Vector2D<T, U>

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

The resulting type after applying the / operator.

fn div(self, scale: T) -> Self::Output

Performs the / operation.

impl<T: Clone + DivAssign, U> DivAssign<Scale<T, U, U>> for Vector2D<T, U>

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

Performs the /= operation.

impl<T: Copy + Div<T, Output = T>, U> DivAssign<T> for Vector2D<T, U>

fn div_assign(&mut self, scale: T)

Performs the /= operation.

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

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

fn floor(self) -> Self

See Vector2D::floor()

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

fn from([x, y]: [T; 2]) -> Self

Performs the conversion.

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

fn from(tuple: (T, T)) -> Self

Performs the conversion.

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

fn from(size: Size2D<T, U>) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

fn hash<H: Hasher>(&self, h: &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<T, U> Into<[T; 2]> for Vector2D<T, U>

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

Performs the conversion.

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

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

Performs the conversion.

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

fn into(self) -> Vector2D<T, Src>

Performs the conversion.

impl<T: Clone + Mul, U1, U2> Mul<Scale<T, U1, U2>> for Vector2D<T, U1>

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

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Clone + Mul, U> Mul<T> for Vector2D<T, U>

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

The resulting type after applying the * operator.

fn mul(self, scale: T) -> Self::Output

Performs the * operation.

impl<T: Clone + MulAssign, U> MulAssign<Scale<T, U, U>> for Vector2D<T, U>

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

Performs the *= operation.

impl<T: Copy + Mul<T, Output = T>, U> MulAssign<T> for Vector2D<T, U>

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

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

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

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

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

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

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

fn round(self) -> Self

See Vector2D::round()

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

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

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector2D<T, U>> for Point2D<T, U>

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

Performs the -= operation.

impl<T: Copy + Sub<T, Output = T>, U> SubAssign<Vector2D<T, U>> for Vector2D<T, U>

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

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

fn zero() -> Self

Constructor, setting all components to zero.