Struct cat_box::vec2::Vec2Int

pub struct Vec2Int {
    pub x: i32,
    pub y: i32,
}

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

Fields

x: i32

The x component of the vector.

y: i32

The y component of the vector.

Implementations

impl Vec2Int

pub const fn new(x: i32, y: i32) -> Vec2Int

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

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

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 to_f32(self) -> Vec2

Casts this vector to a Vec2.

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

Trait Implementations

impl Add<Direction> for Vec2Int

type Output = Vec2Int

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Vec2Int> for Vec2Int

type Output = Vec2Int

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for Vec2Int where
    Vec2Int: Add<T, Output = Self>, 

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl Clone for Vec2Int

fn clone(&self) -> Vec2Int

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vec2Int

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

Formats the value using the given formatter.

impl Default for Vec2Int

fn default() -> Vec2Int

Returns the “default value” for a type.

impl Div<i32> for Vec2Int

type Output = Vec2Int

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<i32> for Vec2Int

fn div_assign(&mut self, rhs: i32)

Performs the /= operation.

impl From<(i32, i32)> for Vec2Int

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

Converts to this type from the input type.

impl From<Direction> for Vec2Int

fn from(v: Direction) -> Self

Converts to this type from the input type.

impl From<Point> for Vec2Int

fn from(p: Point) -> Self

Converts to this type from the input type.

impl From<Vec2Int> for (i32, i32)

fn from(v: Vec2Int) -> Self

Converts to this type from the input type.

impl Hash for Vec2Int

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, 

Feeds a slice of this type into the given Hasher.

impl Mul<i32> for Vec2Int

type Output = Vec2Int

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i32> for Vec2Int

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl Neg for Vec2Int

type Output = Vec2Int

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq<(i32, i32)> for Vec2Int

fn eq(&self, other: &(i32, i32)) -> 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 PartialEq<Vec2Int> for Vec2Int

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

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

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

This method tests for !=.

impl<T> Sub<T> for Vec2Int where
    Vec2Int: Add<T, Output = Self>, 

type Output = Vec2Int

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for Vec2Int where
    Vec2Int: Sub<T, Output = Self>, 

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl Copy for Vec2Int

impl Eq for Vec2Int

impl StructuralEq for Vec2Int

impl StructuralPartialEq for Vec2Int