Struct dx::foundation::Vector2D

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

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> Vector2D<T>

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

Constructor taking scalar values directly.

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

Constructor setting all components to the same value.

pub fn abs(self) -> Vector2D<T> 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.

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

Dot product.

pub fn cross(self, other: Vector2D<T>) -> T where
    T: Sub<T, Output = T> + Mul<T, 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>) -> Vector2D<T> where
    T: Mul<T, Output = T>, 

Returns the component-wise multiplication of the two vectors.

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

Returns the component-wise division of the two vectors.

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

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

Swap x and y.

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

Drop the units, preserving only the numeric value.

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.

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

pub fn square_length(self) -> T

Returns the vector’s length squared.

pub fn project_onto_vector(self, onto: Vector2D<T>) -> Vector2D<T> 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.

impl<T> Vector2D<T> where
    T: Float, 

pub fn length(self) -> T

Returns the vector length.

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

Returns the vector with length of one unit.

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

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 robust_normalize(self) -> Vector2D<T>

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

Return this vector capped to a maximum length.

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

Return this vector with a minimum length applied.

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

Return this vector with minimum and maximum lengths applied.

pub fn is_finite(self) -> bool

Returns true if all members are finite.

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

pub fn cast<NewT>(self) -> Vector2D<NewT> 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>> 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>

Cast into an f32 vector.

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

Cast into an f64 vector.

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.

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.

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.

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.

Trait Implementations

impl<'_, T> Add<&'_ Vector2D<T>> for Vector2D<T> where
    T: Add<T> + Copy, 

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

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

The resulting type after applying the + operator.

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

Performs the + operation.

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

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

Performs the += operation.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Vector2D<T>

Returns the “default value” for a type.

impl<T> Div<T> for Vector2D<T> where
    T: Copy + Div<T>, 

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

The resulting type after applying the / operator.

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

Performs the / operation.

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

fn div_assign(&mut self, scale: T)

Performs the /= operation.

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

fn from([T; 2]) -> Vector2D<T>

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<T> Hash for Vector2D<T> 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, 

Feeds a slice of this type into the given Hasher.

impl<T> Into<[T; 2]> for Vector2D<T>

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

Converts this type into the (usually inferred) input type.

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

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

Converts this type into the (usually inferred) input type.

impl<T> Mul<T> for Vector2D<T> where
    T: Copy + Mul<T>, 

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

The resulting type after applying the * operator.

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

Performs the * operation.

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

fn mul_assign(&mut self, scale: T)

Performs the *= operation.

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

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

The resulting type after applying the - operator.

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

Performs the unary - operation.

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

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

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

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

This method tests for !=.

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

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

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

Performs the -= operation.

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

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