Constructor, setting all components to zero.

Constructor taking scalar values directly.

Constructor taking properly Lengths instead of scalar values.

Tag a unit-less value with units.

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.

Dot product.

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

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

Cast this vector into a point.

Equivalent to adding this vector to the origin.

Swap x and y.

Cast this vector into a size.

Drop the units, preserving only the numeric value.

Cast the unit.

Cast into an array with x and y.

Cast into a tuple with x and y.

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

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

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

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

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.

Creates translation by this vector in vector units.

Returns the vector's length squared.

Returns this vector projected onto another one.

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

Returns the signed angle between this vector and another vector.

The returned angle is between -PI and PI.

Returns the vector length.

Returns the vector with length of one unit.

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.

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

Return this vector capped to a maximum length.

Return this vector with a minimum length applied.

Return this vector with minimum and maximum lengths applied.

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

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

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

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

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

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

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

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

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

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

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.

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.

Cast into an f32 vector.

Cast into an f64 vector.

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.

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.

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.

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.