Struct hex_coordinates::DoubledCoordinates

pub struct DoubledCoordinates<const S: DoubledSystem> {
    pub col: Immutable<isize>,
    pub row: Immutable<isize>,
}

See DoubledSystem.

Fields

col: Immutable<isize>

row: Immutable<isize>

Implementations

impl<const S: DoubledSystem> DoubledCoordinates<S>

pub const fn new(col: isize, row: isize) -> Result<Self, &'static str>

Constructs new coordinate.

Errors

When (col + row) % 2 != 0.

impl DoubledCoordinates<{ DoubledSystem::Height }>

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

Returns the neighboring coordinates in a given direction.

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 DoubledCoordinates<{ DoubledSystem::Width }>

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

Returns the neighboring coordinates in a given direction.

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: DoubledSystem> Add<DoubledCoordinates<S>> for DoubledCoordinates<S>

type Output = DoubledCoordinates<S>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const S: DoubledSystem> AddAssign<DoubledCoordinates<S>> for DoubledCoordinates<S>

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

Performs the += operation.

impl<const S: DoubledSystem> Clone for DoubledCoordinates<S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const S: DoubledSystem> Debug for DoubledCoordinates<S>

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

Formats the value using the given formatter.

impl<const S: DoubledSystem> Default for DoubledCoordinates<S>

fn default() -> DoubledCoordinates<S>

Returns the “default value” for a type.

impl From<AxialCoordinates> for DoubledCoordinates<{ DoubledSystem::Height }>

const fn from(_: AxialCoordinates) -> Self

Converts to this type from the input type.

impl From<AxialCoordinates> for DoubledCoordinates<{ DoubledSystem::Width }>

const fn from(_: AxialCoordinates) -> Self

Converts to this type from the input type.

impl From<CubeCoordinates> for DoubledCoordinates<{ DoubledSystem::Height }>

const fn from(_: CubeCoordinates) -> Self

Converts to this type from the input type.

impl From<CubeCoordinates> for DoubledCoordinates<{ DoubledSystem::Width }>

const fn from(_: CubeCoordinates) -> Self

Converts to this type from the input type.

impl From<Direction> for DoubledCoordinates<{ DoubledSystem::Height }>

const fn from(direction: Direction) -> Self

Converts to this type from the input type.

impl From<Direction> for DoubledCoordinates<{ DoubledSystem::Width }>

const fn from(direction: Direction) -> Self

Converts to this type from the input type.

impl From<DoubledCoordinates<{ DoubledSystem::Height }>> for AxialCoordinates

const fn from(_: DoubledCoordinates<{ DoubledSystem::Height }>) -> Self

Converts to this type from the input type.

impl From<DoubledCoordinates<{ DoubledSystem::Height }>> for CubeCoordinates

const fn from(_: DoubledCoordinates<{ DoubledSystem::Height }>) -> Self

Converts to this type from the input type.

impl From<DoubledCoordinates<{ DoubledSystem::Width }>> for AxialCoordinates

const fn from(_: DoubledCoordinates<{ DoubledSystem::Width }>) -> Self

Converts to this type from the input type.

impl From<DoubledCoordinates<{ DoubledSystem::Width }>> for CubeCoordinates

const fn from(_: DoubledCoordinates<{ DoubledSystem::Width }>) -> Self

Converts to this type from the input type.

impl<const S: DoubledSystem> Mul<isize> for DoubledCoordinates<S>

type Output = DoubledCoordinates<S>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const S: DoubledSystem> MulAssign<isize> for DoubledCoordinates<S>

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

Performs the *= operation.

impl<const S: DoubledSystem> PartialEq<DoubledCoordinates<S>> for DoubledCoordinates<S>

fn eq(&self, other: &DoubledCoordinates<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: DoubledSystem> Sub<DoubledCoordinates<S>> for DoubledCoordinates<S>

type Output = DoubledCoordinates<S>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const S: DoubledSystem> SubAssign<DoubledCoordinates<S>> for DoubledCoordinates<S>

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

Performs the -= operation.

impl<const S: DoubledSystem> Copy for DoubledCoordinates<S>

impl<const S: DoubledSystem> Eq for DoubledCoordinates<S>

impl<const S: DoubledSystem> StructuralEq for DoubledCoordinates<S>

impl<const S: DoubledSystem> StructuralPartialEq for DoubledCoordinates<S>