Struct Vector2 

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

A vector containing two numeric values. This may represent a size or position.

Fields

x: T

The horizontal component of the vector.

y: T

The vertical component of the vector.

Implementations

impl<T> Vector2<T>

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

Instantiates a new Vector2 from the specified horizontal and vertical components.

impl<T: PrimitiveZero> Vector2<T>

pub const ZERO: Vector2<T>

A constant representing a vector of zero magnitude. Each component is set to zero.

pub fn new_x(x: T) -> Self

Instantiates a new Vector2 from the specified horizontal component, setting the vertical component to zero.

pub fn new_y(y: T) -> Self

Instantiates a new Vector2 from the specified vertical component, setting the horizontal component to zero.

impl<T> Vector2<T>

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

pub fn magnitude_squared(&self) -> T

Returns the magnitude of the vector, squared.

impl<T> Vector2<T>

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

pub fn magnitude(&self) -> f32

Returns the magnitude of the vector.

pub fn normalize(&self) -> Option<Vector2<T>>

Normalizes the vector so that the magnitude is 1.0. If the current magnitude of the vector is 0.0, then None is returned to avoid a division by zero.

impl<T: Neg<Output = T> + Copy> Vector2<T>

pub fn rotate_90_degrees_clockwise(&self) -> Vector2<T>

Rotates the vector by 90 degrees in the clockwise direction.

pub fn rotate_90_degrees_anticlockwise(&self) -> Vector2<T>

Rotates the vector by 90 degrees in the anti-clockwise direction.

impl<T: AsPrimitive<f32>> Vector2<T>

pub fn into_f32(self) -> Vec2

Returns a new vector with each element cast to f32, using the as operator.

impl<T: AsPrimitive<i32>> Vector2<T>

pub fn into_i32(self) -> IVec2

Returns a new vector with each element cast to i32, using the as operator.

impl<T: AsPrimitive<u32>> Vector2<T>

pub fn into_u32(self) -> UVec2

Returns a new vector with each element cast to u32, using the as operator.

impl<T: TryInto<i32>> Vector2<T>

pub fn try_into_i32(self) -> Result<IVec2, T::Error>

Attempts to convert each element of this vector to an i32, returning an error if this fails.

Trait Implementations

impl<T: Copy + Add<Output = T>, R: Into<Self>> Add<R> for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<T: Copy + Add<Output = T>, R: Into<Vector2<T>>> Add<R> for &Vector2<T>

type Output = Vector2<T>

The resulting type after applying the + operator.

fn add(self, rhs: R) -> Self::Output

Performs the + operation.

impl<T: Copy + AddAssign, R: Into<Vector2<T>>> AddAssign<R> for Vector2<T>

fn add_assign(&mut self, rhs: R)

Performs the += operation.

impl<T: Copy + AddAssign, R: Into<Vector2<T>>> AddAssign<R> for &mut Vector2<T>

fn add_assign(&mut self, rhs: R)

Performs the += operation.

impl<T: Clone> Clone for Vector2<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Vector2<T>

impl<T: Debug> Debug for Vector2<T>

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

Formats the value using the given formatter.

impl<T: Copy + Div<Output = T>> Div<T> for &Vector2<T>

type Output = Vector2<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Copy + Div<Output = T>> Div<T> for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Copy + DivAssign> DivAssign<T> for Vector2<T>

fn div_assign(&mut self, divisor: T)

Performs the /= operation.

impl<T: Copy + DivAssign> DivAssign<T> for &mut Vector2<T>

fn div_assign(&mut self, divisor: T)

Performs the /= operation.

impl<T: Eq> Eq for Vector2<T>

impl<T> From<&(T, T)> for Vector2<T>

where T: Copy,

fn from(value: &(T, T)) -> Self

Converts to this type from the input type.

impl<T> From<&Vector2<T>> for Vector2<T>

where T: Copy,

fn from(value: &Self) -> Self

Converts to this type from the input type.

impl<T> From<&mut Vector2<T>> for Vector2<T>

where T: Copy,

fn from(value: &mut Self) -> Self

Converts to this type from the input type.

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

where T: Copy,

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

Converts to this type from the input type.

impl<T> From<Point<T>> for Vector2<T>

fn from(point: Point<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Vector2<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

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: Copy + Mul<Output = T>> Mul<T> for &Vector2<T>

type Output = Vector2<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Copy + Mul<Output = T>> Mul<T> for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Copy + MulAssign> MulAssign<T> for Vector2<T>

fn mul_assign(&mut self, factor: T)

Performs the *= operation.

impl<T: Copy + MulAssign> MulAssign<T> for &mut Vector2<T>

fn mul_assign(&mut self, factor: T)

Performs the *= operation.

impl<T: PartialEq> PartialEq for Vector2<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: RoundFloat> RoundFloat for Vector2<T>

fn round(&self) -> Self

Round this value to the nearest integer. In the case of vectors or other types containing multiple elements, each element will be individually rounded.

impl<T: PartialEq> StructuralPartialEq for Vector2<T>

impl<T: Copy + Sub<Output = T>, R: Into<Self>> Sub<R> for Vector2<T>

type Output = Vector2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<T: Copy + Sub<Output = T>, R: Into<Vector2<T>>> Sub<R> for &Vector2<T>

type Output = Vector2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: R) -> Self::Output

Performs the - operation.

impl<T: Copy + SubAssign, R: Into<Vector2<T>>> SubAssign<R> for Vector2<T>

fn sub_assign(&mut self, rhs: R)

Performs the -= operation.

impl<T: Copy + SubAssign, R: Into<Vector2<T>>> SubAssign<R> for &mut Vector2<T>

fn sub_assign(&mut self, rhs: R)

Performs the -= operation.