Enum beehive::Direction

#[repr(u8)]pub enum Direction {
    YZ,
    XZ,
    XY,
    ZY,
    ZX,
    YX,
    UP,
    DOWN,
}

All hex directions in sequential order.

• Starting from North-east in clockwise order in in pointy grids where +X = East and +Y = North-east.
• Starting from North in clockwise order in in flat grids where +X = North-east and +Y = North.

Variants

YZ

XZ

XY

ZY

ZX

YX

UP

DOWN

Methods

impl Direction

pub fn clockwise(self) -> Direction

Returns the direction rotated "clockwise" around the W axis. UP and DOWN are returned unchanged.

pub fn counter_clockwise(self) -> Direction

Returns the direction rotated "counter-clockwise" around the W axis. UP and DOWN are returned unchanged.

pub fn iter() -> Directions

Returns an iterator through all Directions, including UP and DOWN.

pub fn iter_planar() -> PlanarDirections

Returns an iterator through planar Directions, excluding UP and DOWN.

Trait Implementations

impl<T> Add<Direction> for Point<T> where
    T: Zero + One + Add + Neg<Output = T>, 

type Output = Point<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<Direction> for PointAxial<T> where
    T: Zero + One + Add + Neg<Output = T>, 

type Output = PointAxial<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<Direction> for Vector<T> where
    T: Zero + One + Add + Neg<Output = T>, 

type Output = Vector<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add<Direction> for VectorAxial<T> where
    T: Zero + One + Add + Neg<Output = T>, 

type Output = VectorAxial<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<Direction> for Point<T> where
    T: Zero + One + AddAssign<T> + Neg<Output = T>, 

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl<T> AddAssign<Direction> for PointAxial<T> where
    T: Zero + One + AddAssign<T> + Neg<Output = T>, 

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl<T> AddAssign<Direction> for Vector<T> where
    T: Zero + One + AddAssign<T> + Neg<Output = T>, 

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

impl<T> AddAssign<Direction> for VectorAxial<T> where
    T: Zero + One + AddAssign<T> + Neg<Output = T>, 

fn add_assign(&mut self, rhs: Direction)

Performs the += operation.

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 Copy for Direction

impl Debug for Direction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Direction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Direction

impl Hash for Direction

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<T> Index<Direction> for DirectionMap<T>

type Output = T

The returned type after indexing.

fn index(&self, d: Direction) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Direction> for DirectionMap<T>

fn index_mut(&mut self, d: Direction) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl Neg for Direction

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Direction

Performs the unary - operation.

impl PartialEq<Direction> for Direction

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Direction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Direction

impl StructuralPartialEq for Direction

impl<T> Sub<Direction> for Point<T> where
    T: Zero + One + Sub<Output = T> + Neg<Output = T>, 

type Output = Point<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<Direction> for PointAxial<T> where
    T: Zero + One + Sub<Output = T> + Neg<Output = T>, 

type Output = PointAxial<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<Direction> for Vector<T> where
    T: Zero + One + Sub<Output = T> + Neg<Output = T>, 

type Output = Vector<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> Sub<Direction> for VectorAxial<T> where
    T: Zero + One + Sub<Output = T> + Neg<Output = T>, 

type Output = VectorAxial<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<Direction> for Point<T> where
    T: Zero + One + SubAssign<T> + Neg<Output = T>, 

fn sub_assign(&mut self, rhs: Direction)

Performs the -= operation.

impl<T> SubAssign<Direction> for PointAxial<T> where
    T: Zero + One + SubAssign<T> + Neg<Output = T>, 

fn sub_assign(&mut self, rhs: Direction)

Performs the -= operation.

impl<T> SubAssign<Direction> for Vector<T> where
    T: Zero + One + SubAssign<T> + Neg<Output = T>, 

fn sub_assign(&mut self, rhs: Direction)

Performs the -= operation.

impl<T> SubAssign<Direction> for VectorAxial<T> where
    T: Zero + One + SubAssign<T> + Neg<Output = T>, 

fn sub_assign(&mut self, rhs: Direction)

Performs the -= operation.

impl TryFrom<u8> for Direction

type Error = NotDirection

The type returned in the event of a conversion error.

fn try_from(num: u8) -> Result<Self, NotDirection>

Performs the conversion.