Enum hex2d::Direction

pub enum Direction {
    YZ,
    XZ,
    XY,
    ZY,
    ZX,
    YX,
}

Direction on a hexagonal map

See Coordinate for graph with directions.

Naming convention: increasing coordinate for a given direction is first decreasing is second. The missing coordinate is unaffected by a move in a given direction.

Variants

YZ

+Y -Z

XZ

-Z +X

XY

+X -Y

ZY

-Y +Z

ZX

+Z -X

YX

-X +Y

Methods

impl Direction

fn all() -> &'static [Direction; 6]

Static array of all directions

use hex2d::Direction;

assert_eq!(Direction::all().len(), 6);

fn arc(&self, steps: u8) -> Vec<Direction>

Return a vector of an arc including Directions steps away from the original Direction both sides from left to right.

use hex2d::{Direction};
use hex2d::Angle::*;

for &d in Direction::all() {
    assert_eq!(d.arc(0), vec!(d));
    assert_eq!(d.arc(1), vec!(d + Left, d, d + Right));
    assert_eq!(d.arc(2), vec!(d + LeftBack, d + Left, d, d + Right, d + RightBack));
    assert_eq!(d.arc(3), vec!(d + LeftBack, d + Left, d, d + Right, d + RightBack, d + Back));
}

fn from_int<I: Integer>(i: I) -> Direction

Create Direction from integer in [0, 6) range

This should probably be internal

fn to_int<I: Integer>(&self) -> I

Convert to integer in [0, 6) range

This should probably be internal

Trait Implementations

impl Copy for Direction

impl Clone for Direction

fn clone(&self) -> Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Direction

impl PartialEq for Direction

fn eq(&self, __arg_0: &Direction) -> 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 Hash for Direction

fn hash<__H: Hasher>(&self, __arg_0: &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 Debug for Direction

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Ord for Direction

fn cmp(&self, __arg_0: &Direction) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl PartialOrd for Direction

fn partial_cmp(&self, __arg_0: &Direction) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Decodable for Direction

fn decode<__D: Decoder>(__arg_0: &mut __D) -> Result<Direction, __D::Error>

Deserialize a value using a Decoder.

impl ToDirection for Direction

fn to_direction(&self) -> Direction

Convert to Angle part of this data

impl<T: ToDirection> Sub<T> for Direction

type Output = Angle

The resulting type after applying the - operator.

fn sub(self, c: T) -> Angle

Performs the - operation.

impl<I: Integer> ToCoordinate<I> for Direction

fn to_coordinate(&self) -> Coordinate<I>

Convert to Coordinate part of this data

impl Neg for Direction

type Output = Direction

The resulting type after applying the - operator.

fn neg(self) -> Direction

Performs the unary - operation.

impl Add<Angle> for Direction

type Output = Direction

The resulting type after applying the + operator.

fn add(self, a: Angle) -> Direction

Performs the + operation.