Struct hex_coordinates::OffsetCoordinates

pub struct OffsetCoordinates<const S: OffsetSystem> {
    pub col: isize,
    pub row: isize,
}

See OffsetSystem.

Fields

col: isize

row: isize

Implementations

impl<const S: OffsetSystem> OffsetCoordinates<S>

pub const fn new(col: isize, row: isize) -> Self

Constructs new coordinate.

impl OffsetCoordinates<{ OffsetSystem::OddR }>

pub const fn neighbor(&self, direction: Direction) -> Self

pub const fn manhattan_distance(&self, other: Self) -> usize

Returns the manhattan distance between 2 coordinates.

pub fn coordinate_range(&self, range: usize) -> Vec<Self>

Returns all coordinates steps steps from self where { -range <= steps <= range }.

Panics

When isize::try_from(range).is_err().

pub const fn rotate(&self, center: Self, rotation: Rotation) -> Self

Returns coordinates resulting from rotating self about center by Rotation.

pub const fn reflect(&self, axis: CubeAxis) -> Self

Reflects across a CubeAxis.

impl OffsetCoordinates<{ OffsetSystem::EvenR }>

pub const fn neighbor(&self, direction: Direction) -> Self

pub const fn manhattan_distance(&self, other: Self) -> usize

Returns the manhattan distance between 2 coordinates.

pub fn coordinate_range(&self, range: usize) -> Vec<Self>

Returns all coordinates steps steps from self where { -range <= steps <= range }.

Panics

When isize::try_from(range).is_err().

pub const fn rotate(&self, center: Self, rotation: Rotation) -> Self

Returns coordinates resulting from rotating self about center by Rotation.

pub const fn reflect(&self, axis: CubeAxis) -> Self

Reflects across a CubeAxis.

impl OffsetCoordinates<{ OffsetSystem::OddQ }>

pub const fn neighbor(&self, direction: Direction) -> Self

pub const fn manhattan_distance(&self, other: Self) -> usize

Returns the manhattan distance between 2 coordinates.

pub fn coordinate_range(&self, range: usize) -> Vec<Self>

Returns all coordinates steps steps from self where { -range <= steps <= range }.

Panics

When isize::try_from(range).is_err().

pub const fn rotate(&self, center: Self, rotation: Rotation) -> Self

Returns coordinates resulting from rotating self about center by Rotation.

pub const fn reflect(&self, axis: CubeAxis) -> Self

Reflects across a CubeAxis.

impl OffsetCoordinates<{ OffsetSystem::EvenQ }>

pub const fn neighbor(&self, direction: Direction) -> Self

pub const fn manhattan_distance(&self, other: Self) -> usize

Returns the manhattan distance between 2 coordinates.

pub fn coordinate_range(&self, range: usize) -> Vec<Self>

Returns all coordinates steps steps from self where { -range <= steps <= range }.

Panics

When isize::try_from(range).is_err().

pub const fn rotate(&self, center: Self, rotation: Rotation) -> Self

Returns coordinates resulting from rotating self about center by Rotation.

pub const fn reflect(&self, axis: CubeAxis) -> Self

Reflects across a CubeAxis.

Trait Implementations

impl<const S: OffsetSystem> Add<OffsetCoordinates<S>> for OffsetCoordinates<S>

type Output = OffsetCoordinates<S>

The resulting type after applying the + operator.

const fn add(self, other: Self) -> Self

Performs the + operation.

impl<const S: OffsetSystem> AddAssign<OffsetCoordinates<S>> for OffsetCoordinates<S>

const fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<const S: OffsetSystem> Clone for OffsetCoordinates<S>

fn clone(&self) -> OffsetCoordinates<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const S: OffsetSystem> Debug for OffsetCoordinates<S>

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

Formats the value using the given formatter.

impl<const S: OffsetSystem> Default for OffsetCoordinates<S>

fn default() -> OffsetCoordinates<S>

Returns the “default value” for a type.

impl<const S: OffsetSystem> Div<isize> for OffsetCoordinates<S>

type Output = OffsetCoordinates<S>

The resulting type after applying the / operator.

const fn div(self, rhs: isize) -> Self

Performs the / operation.

impl<const S: OffsetSystem> DivAssign<isize> for OffsetCoordinates<S>

const fn div_assign(&mut self, rhs: isize)

Performs the /= operation.

impl From<(Col, Direction)> for OffsetCoordinates<{ OffsetSystem::EvenQ }>

const fn from((col, direction): (Col, Direction)) -> Self

Converts to this type from the input type.

impl From<(Col, Direction)> for OffsetCoordinates<{ OffsetSystem::OddQ }>

const fn from((col, direction): (Col, Direction)) -> Self

Converts to this type from the input type.

impl From<(Row, Direction)> for OffsetCoordinates<{ OffsetSystem::EvenR }>

const fn from((row, direction): (Row, Direction)) -> Self

Converts to this type from the input type.

impl From<(Row, Direction)> for OffsetCoordinates<{ OffsetSystem::OddR }>

const fn from((row, direction): (Row, Direction)) -> Self

Converts to this type from the input type.

impl From<AxialCoordinates> for OffsetCoordinates<{ OffsetSystem::EvenQ }>

const fn from(_: AxialCoordinates) -> Self

Converts to this type from the input type.

impl From<AxialCoordinates> for OffsetCoordinates<{ OffsetSystem::EvenR }>

const fn from(_: AxialCoordinates) -> Self

Converts to this type from the input type.

impl From<AxialCoordinates> for OffsetCoordinates<{ OffsetSystem::OddQ }>

const fn from(_: AxialCoordinates) -> Self

Converts to this type from the input type.

impl From<AxialCoordinates> for OffsetCoordinates<{ OffsetSystem::OddR }>

const fn from(_: AxialCoordinates) -> Self

Converts to this type from the input type.

impl From<CubeCoordinates> for OffsetCoordinates<{ OffsetSystem::EvenQ }>

const fn from(_: CubeCoordinates) -> Self

Converts to this type from the input type.

impl From<CubeCoordinates> for OffsetCoordinates<{ OffsetSystem::EvenR }>

const fn from(_: CubeCoordinates) -> Self

Converts to this type from the input type.

impl From<CubeCoordinates> for OffsetCoordinates<{ OffsetSystem::OddQ }>

const fn from(_: CubeCoordinates) -> Self

Converts to this type from the input type.

impl From<CubeCoordinates> for OffsetCoordinates<{ OffsetSystem::OddR }>

const fn from(_: CubeCoordinates) -> Self

Converts to this type from the input type.

impl<const S: OffsetSystem> From<OffsetCoordinates<S>> for Col

const fn from(_: OffsetCoordinates<S>) -> Self

Converts to this type from the input type.

impl<const S: OffsetSystem> From<OffsetCoordinates<S>> for Row

const fn from(_: OffsetCoordinates<S>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::EvenQ }>> for AxialCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::EvenQ }>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::EvenQ }>> for CubeCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::EvenQ }>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::EvenR }>> for AxialCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::EvenR }>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::EvenR }>> for CubeCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::EvenR }>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::OddQ }>> for AxialCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::OddQ }>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::OddQ }>> for CubeCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::OddQ }>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::OddR }>> for AxialCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::OddR }>) -> Self

Converts to this type from the input type.

impl From<OffsetCoordinates<{ OffsetSystem::OddR }>> for CubeCoordinates

const fn from(_: OffsetCoordinates<{ OffsetSystem::OddR }>) -> Self

Converts to this type from the input type.

impl<const S: OffsetSystem> Mul<isize> for OffsetCoordinates<S>

type Output = OffsetCoordinates<S>

The resulting type after applying the * operator.

const fn mul(self, rhs: isize) -> Self

Performs the * operation.

impl<const S: OffsetSystem> MulAssign<isize> for OffsetCoordinates<S>

const fn mul_assign(&mut self, rhs: isize)

Performs the *= operation.

impl<const S: OffsetSystem> PartialEq<OffsetCoordinates<S>> for OffsetCoordinates<S>

fn eq(&self, other: &OffsetCoordinates<S>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const S: OffsetSystem> Sub<OffsetCoordinates<S>> for OffsetCoordinates<S>

type Output = OffsetCoordinates<S>

The resulting type after applying the - operator.

const fn sub(self, other: Self) -> Self

Performs the - operation.

impl<const S: OffsetSystem> SubAssign<OffsetCoordinates<S>> for OffsetCoordinates<S>

const fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<const S: OffsetSystem> Copy for OffsetCoordinates<S>

impl<const S: OffsetSystem> Eq for OffsetCoordinates<S>

impl<const S: OffsetSystem> StructuralEq for OffsetCoordinates<S>

impl<const S: OffsetSystem> StructuralPartialEq for OffsetCoordinates<S>