Enum Direction 

pub enum Direction {
    XPLUS,
    XMINUS,
    YPLUS,
    YMINUS,
    ZPLUS,
    ZMINUS,
}

One of the six signed axis directions in 3D.

Parses from and displays as +X, -X, +Y, -Y, +Z, -Z.

Variants

XPLUS

Positive X direction.

XMINUS

Negative X direction.

YPLUS

Positive Y direction.

YMINUS

Negative Y direction.

ZPLUS

Positive Z direction.

ZMINUS

Negative Z direction.

Implementations

impl Direction

pub fn iter() -> impl Iterator<Item = Self>

Iterates over all six directions.

pub const fn index(self) -> usize

Returns a stable 0..6 index for this direction.

pub const fn to_ivec3(self) -> IVec3

Returns the unit axis vector pointing along this direction.

pub fn to_vec3(self) -> Vec3

Returns the unit axis vector as a floating-point [Vec3].

pub const fn is_spatial(self) -> bool

Returns true for the X/Y (spatial) directions.

pub const fn negate(self) -> Self

Returns the opposite direction along the same axis.

pub const fn as_udirection(self) -> UDirection

Drops the sign, returning the unsigned axis UDirection.

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Direction

impl Debug for Direction

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

Formats the value using the given formatter.

impl Default for Direction

fn default() -> Direction

Returns the “default value” for a type.

impl Display for Direction

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

Formats the value using the given formatter.

impl Eq for Direction

impl FromStr for Direction

type Err = DirectionParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Direction, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Direction

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 IntoEnumIterator for Direction

type Iterator = DirectionIter

fn iter() -> DirectionIter

impl PartialEq for Direction

fn eq(&self, other: &Direction) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Direction

impl TryFrom<&str> for Direction

type Error = DirectionParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Direction, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<IVec3> for Direction

type Error = DirectionParseError

The type returned in the event of a conversion error.

fn try_from(value: IVec3) -> Result<Self, Self::Error>

Performs the conversion.