Struct hex_coordinates::CubeCoordinates

pub struct CubeCoordinates {
    pub q: Immutable<isize>,
    pub r: Immutable<isize>,
    pub s: Immutable<isize>,
}

 _____
╱ r, s╲
╲__q__╱

        _____
  _____╱+1,-1╲_____
 ╱ 0,+1╲__0__╱-1, 0╲
 ╲_-1__╱ 0, 0╲_+1__╱
 ╱+1, 0╲__0__╱ 0,-1╲
 ╲_-1__╱+1,-1╲_+1__╱
       ╲__0__╱

  +s  -r
    ╲ ╱
-q ──╳── +q
    ╱ ╲
  +r  -s

Fields

q: Immutable<isize>

r: Immutable<isize>

s: Immutable<isize>

Implementations

impl CubeCoordinates

pub const fn new(q: isize, r: isize, s: isize) -> Result<Self, &'static str>

Constructs new coordinate.

Errors

When q + r + s != 0.

pub const fn neighbor(&self, direction: Direction) -> Self

Returns the neighboring coordinates in a given direction.

pub const fn manhattan_distance(&self, other: Self) -> isize

Returns the manhattan distance between 2 coordinates.

Trait Implementations

impl Add<CubeCoordinates> for CubeCoordinates

type Output = CubeCoordinates

The resulting type after applying the + operator.

const fn add(self, other: Self) -> Self

Performs the + operation.

impl Clone for CubeCoordinates

fn clone(&self) -> CubeCoordinates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CubeCoordinates

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

Formats the value using the given formatter.

impl From<AxialCoordinates> for CubeCoordinates

const fn from(_: AxialCoordinates) -> Self

Converts to this type from the input type.

impl From<CubeCoordinates> for AxialCoordinates

const fn from(_: CubeCoordinates) -> Self

Converts to this type from the input type.

impl From<Direction> for CubeCoordinates

const fn from(direction: Direction) -> Self

Converts to this type from the input type.

impl Sub<CubeCoordinates> for CubeCoordinates

type Output = CubeCoordinates

The resulting type after applying the - operator.

const fn sub(self, other: Self) -> Self

Performs the - operation.

impl Copy for CubeCoordinates