Enum gridly::prelude::Rotation

pub enum Rotation {
    None = 0,
    Clockwise = 1,
    Flip = 2,
    Anticlockwise = 3,
}

The 4 cardinal rotations: None (no rotation), Flip, Clockwise, and Anticlockwise. These rotations support basic arithmetic operations with themselves (sums, multiplication by a factor, etc) and can be applied to Direction and Vector.

Variants

None = 0

No rotation (0°)

Clockwise = 1

Rotate 90° clockwise

Flip = 2

Rotate 180°

Anticlockwise = 3

Rotate 90° anticlockwise

Implementations

impl Rotation

pub fn is_turn(self) -> bool

Check if a rotation is a turn; that is, if it is Clockwise or Anticlockwise

Example

use gridly::rotation::*;

assert!(!Rotation::None.is_turn());
assert!(!Rotation::Flip.is_turn());
assert!(Clockwise.is_turn());
assert!(Anticlockwise.is_turn());

pub fn reverse(self) -> Self

Get the rotation in the opposite direction. Note that Rotation::None and Rotation::Flip are their own opposites.

Example

use gridly::rotation::*;

assert_eq!(Rotation::None.reverse(), Rotation::None);
assert_eq!(Rotation::Flip.reverse(), Rotation::Flip);
assert_eq!(Clockwise.reverse(), Anticlockwise);
assert_eq!(Anticlockwise.reverse(), Clockwise);

Trait Implementations

impl Add for Rotation

type Output = Rotation

The resulting type after applying the + operator.

fn add(self, rhs: Rotation) -> Rotation

Performs the + operation.

impl AddAssign for Rotation

fn add_assign(&mut self, rhs: Rotation)

Performs the += operation.

impl Clone for Rotation

fn clone(&self) -> Rotation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rotation

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

Formats the value using the given formatter.

impl Hash for Rotation

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 Mul<i16> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: i16) -> Rotation

Performs the * operation.

impl Mul<i32> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: i32) -> Rotation

Performs the * operation.

impl Mul<i64> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: i64) -> Rotation

Performs the * operation.

impl Mul<i8> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: i8) -> Rotation

Performs the * operation.

impl Mul<isize> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: isize) -> Rotation

Performs the * operation.

impl Mul<u16> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: u16) -> Rotation

Performs the * operation.

impl Mul<u32> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: u32) -> Rotation

Performs the * operation.

impl Mul<u64> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Rotation

Performs the * operation.

impl Mul<u8> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: u8) -> Rotation

Performs the * operation.

impl Mul<usize> for Rotation

type Output = Rotation

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> Rotation

Performs the * operation.

impl Neg for Rotation

type Output = Rotation

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Rotation

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Sub for Rotation

type Output = Rotation

The resulting type after applying the - operator.

fn sub(self, rhs: Rotation) -> Rotation

Performs the - operation.

impl SubAssign for Rotation

fn sub_assign(&mut self, rhs: Rotation)

Performs the -= operation.

impl<'a> Sum<&'a Rotation> for Rotation

fn sum<I: Iterator<Item = &'a Rotation>>(iter: I) -> Rotation

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Sum for Rotation

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for Rotation

impl Eq for Rotation

impl StructuralEq for Rotation

impl StructuralPartialEq for Rotation