Enum Direction 

pub enum Direction {
    Down,
    Up,
    North,
    South,
    West,
    East,
}

The six cardinal directions / face directions.

Variants

Down

Up

North

South

West

East

Implementations

impl Direction

pub const ALL: [Direction; 6]

All six directions in order.

pub fn offset(&self) -> (i32, i32, i32)

Get the offset for this direction.

pub fn normal(&self) -> [f32; 3]

Get the normal vector for this direction.

pub fn opposite(&self) -> Direction

Get the opposite direction.

pub fn axis(&self) -> Axis

Get the axis this direction is on.

pub fn from_str(s: &str) -> Option<Self>

Parse from string (case-insensitive).

pub fn rotate_x(self, degrees: i32) -> Direction

Rotate this direction by X rotation (around X axis, in 90-degree increments). Looking from +X towards origin, positive rotation goes Up -> North -> Down -> South.

pub fn rotate_y(self, degrees: i32) -> Direction

Rotate this direction by Y rotation (around Y axis, in 90-degree increments). Looking from +Y (above), positive rotation goes North -> East -> South -> West.

pub fn rotate_by_transform(self, x_rot: i32, y_rot: i32) -> Direction

Rotate this direction by a block transform (X then Y rotation).

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

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Direction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Direction

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

Formats the value using the given formatter.

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction