Struct Hex 

pub struct Hex(IVec2);

Hexagonal grid coordinate in axial (cube) coordinate system.

Tuple Fields

0: IVec2

Implementations

impl Hex

pub const HEX_DIRECTIONS: [Self; 6]

Hexagon neighbor coordinates array, following HexOrientation::POINTY_EDGE or HexOrientation::FLAT_EDGE order.

These 6 direction vectors represent the offset from a hex to each of its neighbors. The order corresponds to clockwise directions starting from East (for pointy-top) or NorthEast (for flat-top).

Direction Mapping

Index	Pointy-Top	Flat-Top	Vector (Hex)
0	East	NE	(1, 0)
1	SE	SE	(1, -1)
2	SW	South	(0, -1)
3	West	SW	(-1, 0)
4	NW	NW	(-1, 1)
5	NE	North	(0, 1)

pub const fn new(x: i32, y: i32) -> Self

pub const fn from_offset( offset_coordinate: OffsetCoordinate, orientation: HexOrientation, offset: Offset, ) -> Self

Creates a new Hex from an OffsetCoordinate.

pub const fn x(self) -> i32

pub const fn y(self) -> i32

pub const fn z(self) -> i32

pub const fn into_inner(self) -> IVec2

pub fn to_offset( self, orientation: HexOrientation, offset: Offset, ) -> OffsetCoordinate

Converts a hex coordinate to an offset coordinate.

pub fn neighbor(self, orientation: HexOrientation, direction: Direction) -> Hex

Get the hex at the given direction from self, according to the given orientation is HexOrientation::Pointy or HexOrientation::Flat.

pub const fn length(self) -> i32

Computes coordinates length as a signed integer. The length of a Hex coordinate is equal to its distance from the origin.

pub fn distance_to(self, rhs: Self) -> i32

Computes the distance from self to rhs in hexagonal space as a signed integer.

pub fn hexes_at_distance(self, distance: u32) -> Vec<Hex>

Return a Vec<Hex> containing all Hex which are exactly at a given distance from self. If distance = 0 the Vec<Hex> will be empty.
The number of returned hexes is equal to 6 * distance.

pub fn hexes_in_distance(self, distance: u32) -> Vec<Hex>

Return a Vec<Hex> containing all Hex around self in a given distance, including self.
The number of returned hexes is equal to 3 * distance * (distance + 1) + 1.

pub fn round(fractional_hex: Vec2) -> Self

Rounds floating point coordinates to Hex.

Trait Implementations

impl Add for Hex

type Output = Hex

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Hex

fn clone(&self) -> Hex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Hex

impl Debug for Hex

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

Formats the value using the given formatter.

impl Eq for Hex

impl From<[i32; 2]> for Hex

fn from(a: [i32; 2]) -> Self

Converts to this type from the input type.

impl PartialEq for Hex

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Hex

impl Sub for Hex

type Output = Hex

The resulting type after applying the - operator.

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

Performs the - operation.