Enum Axis 

#[repr(u8)]
pub enum Axis {
    X = 0,
    Y = 1,
    Z = 2,
}

Enumeration of the axes of three-dimensional space.

Can be used to infallibly index 3-component arrays and vectors.

See also:

• Face6 specifies an axis and a direction on the axis.

Variants

X = 0

Y = 1

Z = 2

Implementations

impl Axis

pub const ALL: [Self; 3]

All three axes in the standard order, [X, Y, Z].

pub fn color(self) -> Rgb01

Returns a standard color to denote this axis among the three axes. All colors have equal luminance.

• X = red
• Y = green
• Z = blue

pub fn positive_face(self) -> Face6

Returns the Face6 value which corresponds to the positive direction on this axis.

pub fn negative_face(self) -> Face6

Returns the Face6 value which corresponds to the negative direction on this axis.

pub const fn index(self) -> usize

Convert the axis to a number for indexing 3-element arrays.

pub const fn increment(self) -> Self

Maps X to Y, Y to Z, and Z to X.

pub const fn decrement(self) -> Self

Maps X to Z, Y to X, and Z to Y.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Axis

impl Debug for Axis

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

Formats the value using the given formatter.

impl Eq for Axis

impl Exhaust for Axis

type Iter = ExhaustAxisIter

Iterator type returned by Self::exhaust_factories(). See the trait documentation for what properties this iterator should have.

type Factory = ExhaustAxisFactory

Data which can be used to construct Self.

fn exhaust_factories() -> Self::Iter

Returns an iterator over factories for all values of this type.

fn from_factory(factory: Self::Factory) -> Self

Construct a concrete value of this type from a Self::Factory value produced by its Self::Iter.

fn exhaust() -> Iter<Self>

Returns an iterator over all values of this type.

impl From<Axis> for u8

fn from(value: Axis) -> Self

Converts to this type from the input type.

impl From<Axis> for usize

fn from(value: Axis) -> Self

Converts to this type from the input type.

impl Hash for Axis

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<T> Index<Axis> for [T; 3]

type Output = T

The returned type after indexing.

fn index(&self, index: Axis) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, U> Index<Axis> for Vector3D<T, U>

type Output = T

The returned type after indexing.

fn index(&self, index: Axis) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, U> Index<Axis> for Point3D<T, U>

type Output = T

The returned type after indexing.

fn index(&self, index: Axis) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, U> Index<Axis> for Size3D<T, U>

type Output = T

The returned type after indexing.

fn index(&self, index: Axis) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Axis> for Cube

type Output = i32

The returned type after indexing.

fn index(&self, index: Axis) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Axis> for [T; 3]

fn index_mut(&mut self, index: Axis) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T, U> IndexMut<Axis> for Vector3D<T, U>

fn index_mut(&mut self, index: Axis) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T, U> IndexMut<Axis> for Point3D<T, U>

fn index_mut(&mut self, index: Axis) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T, U> IndexMut<Axis> for Size3D<T, U>

fn index_mut(&mut self, index: Axis) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Axis> for Cube

fn index_mut(&mut self, index: Axis) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl LowerHex for Axis

Format the axis as one of the strings “x”, “y”, or “z” (lowercase).

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

Formats the value using the given formatter.

impl PartialEq for Axis

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

impl UpperHex for Axis

Format the axis as one of the strings “X”, “Y”, or “Z” (uppercase).

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

Formats the value using the given formatter.