Struct chickenwire::coordinate::offset::Offset

pub struct Offset {
    pub col: i32,
    pub row: i32,
}

Offset coordinates treat the HexGrid as a square grid with offsetting indentations on the rows/columns.

Fields

col: i32

row: i32

Methods

impl Offset

pub const ORIGIN: Offset

Offset coordinate origin of (0, 0).

pub fn from_coords(col: i32, row: i32) -> Self

Create an Offset from two i32 values.

Examples

use chickenwire::coordinate::offset::Offset;

assert_eq!(
    Offset::from_coords(1, 2),
    Offset { col: 1, row: 2 }
);

pub fn oflat_to_cube(self) -> Cube

Converts an Offset to a Cube, assuming the HexGrid has Parity::Odd and Tilt::Flat parameters.

pub fn eflat_to_cube(self) -> Cube

Converts an Offset to a Cube, assuming the HexGrid has Parity::Even and Tilt::Flat parameters.

pub fn osharp_to_cube(self) -> Cube

Converts an Offset to a Cube, assuming the HexGrid has Parity::Odd and Tilt::Sharp parameters.

pub fn esharp_to_cube(self) -> Cube

Converts an Offset to a Cube, assuming the HexGrid has Parity::Even and Tilt::Sharp parameters.

pub fn oflat_neighbors(self) -> Vec<Self>

Calculates the Offset coordinates of the hexes surrounding the calling instance, in the context of a HexGrid with Parity::Odd and Tilt::Flat parameters.

pub fn eflat_neighbors(self) -> Vec<Self>

Calculates the Offset coordinates of the hexes surrounding the calling instance, in the context of a HexGrid with Parity::Even and Tilt::Flat parameters.

pub fn osharp_neighbors(self) -> Vec<Self>

Calculates the Offset coordinates of the hexes surrounding the calling instance, in the context of a HexGrid with Parity::Odd and Tilt::Sharp parameters.

pub fn esharp_neighbors(self) -> Vec<Self>

Calculates the Offset coordinates of the hexes surrounding the calling instance, in the context of a HexGrid with Parity::Even and Tilt::Sharp parameters.

pub fn dist(self, other: Self) -> i32

Calculates the distance between two Offset coordinates.

Trait Implementations

impl From<(i32, i32)> for Offset

Create an Offset from an (i32, i32).

fn from((col, row): (i32, i32)) -> Self

Performs the conversion.

impl From<MultiCoord> for Offset

Create an Offset from a MultiCoord.

Panics

Panics when given a non-Offset MultiCoord.

fn from(coord: MultiCoord) -> Self

Performs the conversion.

impl From<Offset> for CoordSys

Creates a CoordSys::Offset from an Offset.

fn from(_: Offset) -> Self

Performs the conversion.

impl From<Offset> for MultiCoord

Creates a MultiCoord from an Offset.

fn from(coord: Offset) -> Self

Performs the conversion.

impl Ord for Offset

fn cmp(&self, other: &Offset) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<Offset> for Offset

fn partial_cmp(&self, other: &Offset) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl PartialEq<Offset> for Offset

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

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

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

This method tests for !=.

impl Default for Offset

fn default() -> Offset

Returns the "default value" for a type.

impl Clone for Offset

fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Offset

impl Copy for Offset

impl Debug for Offset

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

Formats the value using the given formatter.

impl Hash for Offset

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].