Struct HexLayout

pub struct HexLayout {
    pub orientation: HexOrientation,
    pub origin: Vec2,
    pub hex_size: Vec2,
    pub invert_x: bool,
    pub invert_y: bool,
}

Hexagonal layout. This type is the bridge between your world/pixel coordinate system and the hexagonal coordinate system.

Axis

By default, the Hex y axis is pointing down and the x axis is pointing right but you have the option to invert them using invert_x and invert_y This may be useful depending on the coordinate system of your display.

Example

let layout = HexLayout {
    // We want flat topped hexagons
    orientation: HexOrientation::Flat,
    // We define the world space origin equivalent of `Hex::ZERO` in hex space
    origin: Vec2::new(1.0, 2.0),
    // We define the world space size of the hexagons
    hex_size: Vec2::new(1.0, 1.0),
    // We invert the y axis
    invert_y: true,
    // But not the x axis
    invert_x: false,
};
// You can now find the world positon (center) of any given hexagon
let world_pos = layout.hex_to_world_pos(Hex::ZERO);
// You can also find which hexagon is at a given world/screen position
let hex_pos = layout.world_pos_to_hex(Vec2::new(1.23, 45.678));

Fields

orientation: HexOrientation

The hexagonal orientation of the layout (usually “flat” or “pointy”)

origin: Vec2

The origin of the hexagonal representation in world/pixel space, usually Vec2::ZERO

hex_size: Vec2

The size of individual hexagons in world/pixel space. The size can be irregular

invert_x: bool

If set to true, the Hex x axis will be inverted

invert_y: bool

If set to true, the Hex y axis will be inverted

Implementations

impl HexLayout

pub fn hex_to_world_pos(&self, hex: Hex) -> Vec2

Computes hexagonal coordinates hex into world/pixel coordinates

pub fn fract_hex_to_world_pos(&self, hex: Vec2) -> Vec2

Computes fractional hexagonal coordinates hex into world/pixel coordinates

pub fn world_pos_to_hex(&self, pos: Vec2) -> Hex

Computes world/pixel coordinates pos into hexagonal coordinates

pub fn world_pos_to_fract_hex(&self, pos: Vec2) -> Vec2

Computes world/pixel coordinates pos into fractional hexagonal coordinates

pub fn hex_corners(&self, hex: Hex) -> [Vec2; 6]

Retrieves all 6 corner coordinates of the given hexagonal coordinates hex

pub fn rect_size(&self) -> Vec2

Returns the size of the bounding box/rect of an hexagon This uses both the hex_size and orientation of the layout.

impl HexLayout

pub fn edge_coordinates(&self, edge: GridEdge) -> [Vec2; 2]

Returns the world coordinate of the two edge vertices in clockwise order

pub fn all_edge_coordinates(&self, coord: Hex) -> [[Vec2; 2]; 6]

Returns the world coordinate of all edge vertex pairs in clockwise order

pub fn vertex_coordinates(&self, vertex: GridVertex) -> Vec2

Returns the world coordinate of the vertex

Trait Implementations

impl Clone for HexLayout

fn clone(&self) -> HexLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HexLayout

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

Formats the value using the given formatter.

impl Default for HexLayout

fn default() -> HexLayout

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HexLayout

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HexLayout

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.