Struct Vector2D

Source

#[repr(C)]pub struct Vector2D<T> {
    pub x: T,
    pub y: T,
}

Expand description

A 2d Vector tagged with a unit.

Fields§

§x: T

The x (traditionally, horizontal) coordinate.

§y: T

The y (traditionally, vertical) coordinate.

Implementations§

Source §

impl<T> Vector2D<T>

Source

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

Constructor taking scalar values directly.

Source

pub fn splat(v: T) -> Self
where T: Clone,

Constructor setting all components to the same value.

Source

pub fn abs(self) -> Self
where T: Signed,

Computes the vector with absolute values of each component.

§Example

enum U {}

assert_eq!(Vector2D::new(-1, 2).abs(), Vector2D::new(1, 2));

let vec = Vector2D::new(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.

Source

pub fn dot(self, other: Self) -> T
where T: Add<Output = T> + Mul<Output = T>,

Dot product.

Source

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].

Source

pub fn component_mul(self, other: Self) -> Self
where T: Mul<Output = T>,

Returns the component-wise multiplication of the two vectors.

Source

pub fn component_div(self, other: Self) -> Self
where T: Div<Output = T>,

Returns the component-wise division of the two vectors.

Source §

impl<T: Copy> Vector2D<T>

Source

pub fn yx(self) -> Self

Swap x and y.

Source

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

Drop the units, preserving only the numeric value.

Source

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

Cast into an array with x and y.

Source

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

Cast into a tuple with x and y.

Source §

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

Source

pub fn square_length(self) -> T

Returns the vector’s length squared.

Source

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.

Source §

impl<T: Float> Vector2D<T>

Source

pub fn length(self) -> T

Returns the vector length.

Source

pub fn normalize(self) -> Self

Returns the vector with length of one unit.

Source

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.

Source

pub fn robust_normalize(self) -> Self

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

Source

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

Return this vector capped to a maximum length.

Source

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

Return this vector with a minimum length applied.

Source

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

Return this vector with minimum and maximum lengths applied.

Source

pub fn is_finite(self) -> bool

Returns true if all members are finite.

Source §

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

Source

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

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.

Source

pub fn try_cast<NewT: NumCast>(self) -> Option<Vector2D<NewT>>

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.

Source

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

Cast into an f32 vector.

Source

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

Cast into an f64 vector.

Source

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

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.

Source

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

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.

Source

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

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.

Source

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

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.