Struct Coordinate 

pub struct Coordinate { /* private fields */ }

A hex coordinate using a cubic coordinate scheme.

See http://www.redblobgames.com/grids/hexagons/#coordinates for more detail.

All three coordinates must sum to zero.

Implementations

impl Coordinate

pub fn new() -> Result<Self, &'static str>

Create a new Coordinate at 0, 0, 0.

This returns a Result to match at, but always succeeds.

pub fn at(x: i64, y: i64, z: i64) -> Result<Self, &'static str>

Create a new Coordinate at the specified location, if that location is valid.

pub fn neighbors(&self) -> Vec<Coordinate>

Get the six neighbors of a given Coordinate.

pub fn neighbor(&self, direction: usize) -> Result<Coordinate, &'static str>

Get the neighbor in direction. Valid directions are in [0, 5].

pub fn distance_to(&self, other: Coordinate) -> i64

Get the distance between two coordinates, in grid tiles.

Trait Implementations

impl Add for Coordinate

type Output = Coordinate

The resulting type after applying the + operator.

fn add(self, other: Coordinate) -> Coordinate

Performs the + operation.

impl Clone for Coordinate

fn clone(&self) -> Coordinate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Coordinate

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

Formats the value using the given formatter.

impl PartialEq for Coordinate

fn eq(&self, other: &Coordinate) -> 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 PartialOrd for Coordinate

fn partial_cmp(&self, other: &Coordinate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Coordinate

type Output = Coordinate

The resulting type after applying the - operator.

fn sub(self, other: Coordinate) -> Coordinate

Performs the - operation.

impl Copy for Coordinate

impl StructuralPartialEq for Coordinate