Enum NeighborDirection 

pub enum NeighborDirection {
    NotNeighbors = 0,
    XMinus = 1,
    XPlus = 2,
    YMinus = 3,
    YPlus = 4,
    ZMinus = 5,
    ZPlus = 6,
}

Represents the direction of a neighboring cell relative to a given cell in a 3D grid.

This enum is used to indicate the spatial relationship between cells in a grid

Variants

NotNeighbors = 0

Indicates that the cells are not neighbors.

XMinus = 1

Indicates the neighbor is in the negative X direction.

XPlus = 2

Indicates the neighbor is in the positive X direction.

YMinus = 3

Indicates the neighbor is in the negative Y direction.

YPlus = 4

Indicates the neighbor is in the positive Y direction.

ZMinus = 5

Indicates the neighbor is in the negative Z direction.

ZPlus = 6

Indicates the neighbor is in the positive Z direction.

Implementations

impl NeighborDirection

pub const fn is_positive(self) -> bool

Checks if the direction is positive.

Returns true if the direction is positive (XPlus, YPlus, ZPlus), otherwise returns false.

pub const fn is_negative(self) -> bool

Checks if the direction is negative.

Returns true if the direction is negative (XMinus, YMinus, ZMinus), otherwise returns false.

pub fn ordered_pair<T: Copy>(self, a: T, b: T) -> (T, T)

Returns an ordered pair of values based on the direction’s positivity.

If the direction is positive, returns (a, b). Otherwise, returns (b, a).

pub fn to_coord_index(&self) -> Option<usize>

Converts the direction into a coordinate index.

Returns Some(usize) representing the index of the coordinate (0 for X axis, 1 for Y axis, 2 for Z axis), or None if the variant is NotNeighbors.

Trait Implementations

impl Clone for NeighborDirection

fn clone(&self) -> NeighborDirection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NeighborDirection

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

Formats the value using the given formatter.

impl PartialEq for NeighborDirection

fn eq(&self, other: &NeighborDirection) -> 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 Copy for NeighborDirection

impl StructuralPartialEq for NeighborDirection