Struct HexAxialShape

pub struct HexAxialShape<ShapeBase, Loop, H = usize, V = usize, HA = HexAxial> { /* private fields */ }

Shape for Axial based coordinates.

Implementations

impl<ShapeBase, Loop, H, V, HA> HexAxialShape<ShapeBase, Loop, H, V, HA>

pub fn new(h: H, v: V) -> Self

Create a new shape.

Trait Implementations

impl<ShapeBase: Clone, Loop: Clone, H: Clone, V: Clone, HA: Clone> Clone for HexAxialShape<ShapeBase, Loop, H, V, HA>

fn clone(&self) -> HexAxialShape<ShapeBase, Loop, H, V, HA>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ShapeBase: Debug, Loop: Debug, H: Debug, V: Debug, HA: Debug> Debug for HexAxialShape<ShapeBase, Loop, H, V, HA>

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

Formats the value using the given formatter.

impl<ShapeBase: Hash, Loop: Hash, H: Hash, V: Hash, HA: Hash> Hash for HexAxialShape<ShapeBase, Loop, H, V, HA>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<ShapeBase: Ord, Loop: Ord, H: Ord, V: Ord, HA: Ord> Ord for HexAxialShape<ShapeBase, Loop, H, V, HA>

fn cmp(&self, other: &HexAxialShape<ShapeBase, Loop, H, V, HA>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<ShapeBase: PartialEq, Loop: PartialEq, H: PartialEq, V: PartialEq, HA: PartialEq> PartialEq for HexAxialShape<ShapeBase, Loop, H, V, HA>

fn eq(&self, other: &HexAxialShape<ShapeBase, Loop, H, V, HA>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<ShapeBase: PartialOrd, Loop: PartialOrd, H: PartialOrd, V: PartialOrd, HA: PartialOrd> PartialOrd for HexAxialShape<ShapeBase, Loop, H, V, HA>

fn partial_cmp( &self, other: &HexAxialShape<ShapeBase, Loop, H, V, HA>, ) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<B, H, V, HA> Shape for HexAxialShape<B, (), H, V, HA>

where HA: AxialCoord, B: HexAxialShapeBase<HA>, H: Clone + Into<usize>, V: Clone + Into<usize>,

type Axis = <B as HexAxialShapeBase<HA>>::Axis

Axis of the lattice.

type Coordinate = HA

Coordinate of the lattice graph.

type OffsetConvertError = ()

Error to return when to_offset fails. Should set Infallible when the graph is looped and never to fail.

type CoordinateMoveError = ()

Error to return when move_coord fails. Should set Infallible when the graph is looped and never to fail.

fn horizontal(&self) -> usize

Horizontal node count.

fn vertical(&self) -> usize

Vertical node count.

fn to_offset( &self, coord: Self::Coordinate, ) -> Result<Offset, Self::OffsetConvertError>

Convert coordinate to Offset.

unsafe fn to_offset_unchecked(&self, coord: Self::Coordinate) -> Offset

Convert coordinate to Offset without a check.

fn from_offset(&self, offset: Offset) -> Self::Coordinate

Convert coordinate from Offset.

fn horizontal_edge_size(&self, _axis: Self::Axis) -> usize

👎Deprecated

Edge count of horizontal. May differ by the axis info.

fn vertical_edge_size(&self, _axis: Self::Axis) -> usize

👎Deprecated

Edge count of vertical. May differ by the axis info.

fn move_coord( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Result<Self::Coordinate, Self::CoordinateMoveError>

Move coordinates to the next coordinate in the direction. Coordinate should be a valid coordinate and should be checked before using move_coord. This is because the target coordinate might be valid even thought the souce coord is invalid, and some code validate the direction by moveing the coord.

unsafe fn move_coord_unchecked( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Self::Coordinate

Move coordinates to the next coordinate in the direction. Caller should be sure that the source and the target coord is valid coord.

fn node_count(&self) -> usize

Node count.

fn from_index(&self, index: usize) -> Self::Coordinate

Convert coordinate from index.

fn to_index(&self, coord: Self::Coordinate) -> Option<usize>

Covert coordinate to index.

fn index_to_offset(&self, index: usize) -> Offset

Convert index to offset.

fn offset_to_index(&self, o: Offset) -> usize

Covert offset to index.

fn is_neighbor(&self, a: Self::Coordinate, b: Self::Coordinate) -> bool

Check whether two coordinate is in neighbor.

fn get_direction( &self, source: Self::Coordinate, target: Self::Coordinate, ) -> Option<<Self::Axis as Axis>::Direction>

Get direction if two coordiante is in neighbor.

impl<B, H, V, HA> Shape for HexAxialShape<B, LoopEW, H, V, HA>

where HA: AxialCoord, B: HexAxialShapeBase<HA>, H: Clone + Into<usize>, V: Clone + Into<usize>,

type Axis = <B as HexAxialShapeBase<HA>>::Axis

Axis of the lattice.

type Coordinate = HA

Coordinate of the lattice graph.

type OffsetConvertError = ()

Error to return when to_offset fails. Should set Infallible when the graph is looped and never to fail.

type CoordinateMoveError = ()

Error to return when move_coord fails. Should set Infallible when the graph is looped and never to fail.

fn horizontal(&self) -> usize

Horizontal node count.

fn vertical(&self) -> usize

Vertical node count.

fn to_offset( &self, coord: Self::Coordinate, ) -> Result<Offset, Self::OffsetConvertError>

Convert coordinate to Offset.

unsafe fn to_offset_unchecked(&self, coord: Self::Coordinate) -> Offset

Convert coordinate to Offset without a check.

fn from_offset(&self, offset: Offset) -> Self::Coordinate

Convert coordinate from Offset.

fn horizontal_edge_size(&self, _axis: Self::Axis) -> usize

👎Deprecated

Edge count of horizontal. May differ by the axis info.

fn vertical_edge_size(&self, _axis: Self::Axis) -> usize

👎Deprecated

Edge count of vertical. May differ by the axis info.

fn move_coord( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Result<Self::Coordinate, Self::CoordinateMoveError>

Move coordinates to the next coordinate in the direction. Coordinate should be a valid coordinate and should be checked before using move_coord. This is because the target coordinate might be valid even thought the souce coord is invalid, and some code validate the direction by moveing the coord.

fn node_count(&self) -> usize

Node count.

fn from_index(&self, index: usize) -> Self::Coordinate

Convert coordinate from index.

fn to_index(&self, coord: Self::Coordinate) -> Option<usize>

Covert coordinate to index.

fn index_to_offset(&self, index: usize) -> Offset

Convert index to offset.

fn offset_to_index(&self, o: Offset) -> usize

Covert offset to index.

unsafe fn move_coord_unchecked( &self, coord: Self::Coordinate, dir: <Self::Axis as Axis>::Direction, ) -> Self::Coordinate

Move coordinates to the next coordinate in the direction. Caller should be sure that the source and the target coord is valid coord.

fn is_neighbor(&self, a: Self::Coordinate, b: Self::Coordinate) -> bool

Check whether two coordinate is in neighbor.

fn get_direction( &self, source: Self::Coordinate, target: Self::Coordinate, ) -> Option<<Self::Axis as Axis>::Direction>

Get direction if two coordiante is in neighbor.

impl<ShapeBase: Copy, Loop: Copy, H: Copy, V: Copy, HA: Copy> Copy for HexAxialShape<ShapeBase, Loop, H, V, HA>

impl<ShapeBase: Eq, Loop: Eq, H: Eq, V: Eq, HA: Eq> Eq for HexAxialShape<ShapeBase, Loop, H, V, HA>

impl<ShapeBase, Loop, H, V, HA> StructuralPartialEq for HexAxialShape<ShapeBase, Loop, H, V, HA>