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

std::ops::Div and std::ops::DivAssign are not implemented as the operation will not always produce valid coordinates. It is only valid when all components q, r and s are divisible by the given denominator. To highlight division here is done with a custom CubeCoordinates::try_div

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, InvalidCubeCoordinate>

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

Returns the manhattan distance between 2 coordinates.

pub fn coordinate_range(&self, range: usize) -> Vec<Self>

Returns all coordinates steps steps from self where { -range <= steps <= range }.

Panics

When isize::try_from(range).is_err().

pub const fn rotate(&self, center: Self, rotation: Rotation) -> Self

Returns coordinates resulting from rotating self about center by Rotation.

pub const fn try_div(&self, rhs: isize) -> Result<Self, InvalidCubeCoordinate>

Divides self by rhs.

Errors

When the division produces an invalid coordinate.

pub const fn try_div_assign(
    &mut self,
    rhs: isize
) -> Result<(), InvalidCubeCoordinate>

Divides self by rhs and assigns result to self.

Errors

When the division produces an invalid coordinate.

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 AddAssign<CubeCoordinates> for CubeCoordinates

const fn add_assign(&mut self, other: 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 Mul<isize> for CubeCoordinates

type Output = CubeCoordinates

The resulting type after applying the * operator.

const fn mul(self, rhs: isize) -> Self

Performs the * operation.

impl MulAssign<isize> for CubeCoordinates

const fn mul_assign(&mut self, rhs: isize)

Performs the *= operation.

impl PartialEq<CubeCoordinates> for CubeCoordinates

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

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

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

This method tests for !=.

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 SubAssign<CubeCoordinates> for CubeCoordinates

const fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for CubeCoordinates

impl Eq for CubeCoordinates

impl StructuralEq for CubeCoordinates

impl StructuralPartialEq for CubeCoordinates