Struct Vec2 

pub struct Vec2 {
    pub x: f32,
    pub y: f32,
}

A set of 2 f32s representing a location or direction in the 2d plane.

Fields

x: f32

The x component of the vector.

y: f32

The y component of the vector.

Implementations

impl Vec2

pub const fn new(x: f32, y: f32) -> Vec2

Creates a new Vec2 with the given x- and y-values.

It is often simpler, and preferred, to just write (x, y).into().

pub fn sq_magnitude(self) -> f32

Gets the squared magnitude of the vector.

Useful for comparisons as it is faster to calculate than magnitude.

pub fn magnitude(self) -> f32

Gets the magnitude of the vector.

pub fn sq_dist(self, rhs: Self) -> f32

Gets the squared distance from this vector to rhs.

Useful for comparisons as it is faster to calculate than dist.

pub fn dist(self, rhs: Self) -> f32

Gets the distance from this vector to rhs.

pub fn normalized(self) -> Self

Normalizes the vector, making its magnitude 1.

pub fn rounded(self) -> Vec2Int

Rounds the vector to a Vec2Int.

This uses as i32 under the hood, and as such comes with all the same unfortunate edge cases. Beware.

Trait Implementations

impl Add<Direction> for Vec2

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Vec2

type Output = Vec2

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for Vec2

where Vec2: Add<T, Output = Self>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Vec2

fn clone(&self) -> Vec2

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2

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

Formats the value using the given formatter.

impl Default for Vec2

fn default() -> Vec2

Returns the “default value” for a type.

impl Div<f32> for Vec2

type Output = Vec2

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Vec2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<(f32, f32)> for Vec2

fn from(v: (f32, f32)) -> Self

Converts to this type from the input type.

impl From<(i32, i32)> for Vec2

fn from(v: (i32, i32)) -> Self

Converts to this type from the input type.

impl From<Direction> for Vec2

fn from(v: Direction) -> Self

Converts to this type from the input type.

impl From<Point> for Vec2

fn from(p: Point) -> Self

Converts to this type from the input type.

impl From<Vec2> for (f32, f32)

fn from(v: Vec2) -> Self

Converts to this type from the input type.

impl Mul<f32> for Vec2

type Output = Vec2

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Vec2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Vec2

type Output = Vec2

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<(f32, f32)> for Vec2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<(i32, i32)> for Vec2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Vec2

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Sub<T> for Vec2

where Vec2: Add<T, Output = Self>,

type Output = Vec2

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for Vec2

where Vec2: Sub<T, Output = Self>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl Copy for Vec2

impl StructuralPartialEq for Vec2