Struct GridEdge

pub struct GridEdge {
    pub origin: Hex,
    pub direction: EdgeDirection,
}

Hexagonal grid orientated edge representation

Fields

origin: Hex

The coordinate of the edge

direction: EdgeDirection

The direction the edge points towards

Implementations

impl GridEdge

pub fn equivalent(&self, other: &GridEdge) -> bool

Edges are equivalent if they have identical or flipped origin or direction

pub const fn destination(&self) -> Hex

Returns the coordinate the edge id pointing to

pub const fn vertices(&self) -> [GridVertex; 2]

Returns the two vertices making this edge in clockwise order

pub const fn flipped(self) -> GridEdge

Flips the edge, changing its origin to be the destination and inverting its direction

pub const fn const_neg(self) -> GridEdge

Inverts the edge, now facing the opposite direction

pub const fn clockwise(self) -> GridEdge

Returns the next edge in clockwise order

pub const fn counter_clockwise(self) -> GridEdge

Returns the next edge in counter clockwise order

pub const fn rotate_cw(self, offset: u8) -> GridEdge

Rotates self clockwise by offset amount.

pub const fn rotate_ccw(self, offset: u8) -> GridEdge

Rotates self counter clockwise by offset amount.

Trait Implementations

impl Clone for GridEdge

fn clone(&self) -> GridEdge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridEdge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GridEdge

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<EdgeDirection> for GridEdge

fn from(direction: EdgeDirection) -> GridEdge

Converts to this type from the input type.

impl Hash for GridEdge

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Neg for GridEdge

type Output = GridEdge

The resulting type after applying the - operator.

fn neg(self) -> <GridEdge as Neg>::Output

Performs the unary - operation.

impl PartialEq for GridEdge

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for GridEdge

impl Eq for GridEdge

impl StructuralPartialEq for GridEdge