Struct aglet::CoordVec

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

Signed-int coordinates

Fields

x: i32

y: i32

Implementations

impl CoordVec

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

Create a new ICoord

pub fn quadrant(self) -> u32

Return the quadrant this coordinate is in.

• 1: +X, +Y
• 2: -X, +Y
• 3: -X, -Y
• 4: +X, -Y

Zeroes are treated as positive.

pub fn to_coord(self) -> Option<Coord>

Try to convert this to a Coord. Returns None in case any part is negative.

pub fn neighbors4(self) -> [CoordVec; 4]

Get a list of this coordinate’s orthagonal neighbors. They are given in clockwise order starting with the neighbor to the north, as if each of Direction4::DIRECTIONS had been added to them.

pub fn neighbors8(self) -> [CoordVec; 8]

Get a list of this coordinate’s orthagonal and diagonal neighbors. They are given in clockwise order starting with the neighbor to the north, as if each of Direction8::DIRECTIONS had been added to them.

pub fn point9(self) -> Direction9

Turn this into the closest Direction9 it is pointing in.

This uses the convention that north is positive Y.

Trait Implementations

impl Add<CoordVec> for CoordVec

type Output = CoordVec

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Direction4> for CoordVec

type Output = CoordVec

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Direction8> for CoordVec

type Output = CoordVec

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<CoordVec> for CoordVec

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<Direction4> for CoordVec

fn add_assign(&mut self, rhs: Direction4)

Performs the += operation.

impl AddAssign<Direction8> for CoordVec

fn add_assign(&mut self, rhs: Direction8)

Performs the += operation.

impl Clone for CoordVec

fn clone(&self) -> CoordVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CoordVec

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

Formats the value using the given formatter.

impl Display for CoordVec

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

Formats the value using the given formatter.

impl From<Coord> for CoordVec

fn from(value: Coord) -> Self

Converts to this type from the input type.

impl Hash for CoordVec

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 CoordVec

type Output = CoordVec

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<i32> for CoordVec

fn mul_assign(&mut self, rhs: i32)

Performs the *= operation.

impl PartialEq<CoordVec> for CoordVec

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

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

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

This method tests for !=.

impl Sub<CoordVec> for CoordVec

type Output = CoordVec

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<CoordVec> for CoordVec

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<CoordVec> for Coord

Try to convert an ICoord to a Coord. Will return Error if the ICoord has any negatives in it.

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: CoordVec) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for CoordVec

impl Eq for CoordVec

impl StructuralEq for CoordVec

impl StructuralPartialEq for CoordVec