Enum substrate::geometry::prelude::NamedOrientation

#[non_exhaustive]
pub enum NamedOrientation {
    R0,
    ReflectVert,
    ReflectHoriz,
    R90,
    R180,
    R270,
    R90Cw,
    R180Cw,
    R270Cw,
    FlipYx,
    FlipMinusYx,
}

A named orientation.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

R0

No rotations or reflections.

ReflectVert

Reflect vertically (ie. about the x-axis).

ReflectHoriz

Reflect horizontally (ie. about the y-axis).

R90

Rotate 90 degrees counter-clockwise.

R180

Rotate 180 degrees counter-clockwise.

R270

Rotate 270 degrees counter-clockwise.

R90Cw

Rotate 90 degrees clockwise.

R180Cw

Rotate 180 degrees clockwise.

R270Cw

Rotate 270 degrees clockwise.

FlipYx

Flip across the line y = x.

FlipMinusYx

Flip across the line y = -x.

Implementations

impl NamedOrientation

pub fn all_rectangular() -> [NamedOrientation; 8]

Returns a slice of all 8 possible named rectangular orientations.

Users should not rely upon the order of the orientations returned.

pub fn into_orientation(self) -> Orientation

Converts this named orientation into a regular Orientation.

pub fn from_orientation(orientation: Orientation) -> Option<NamedOrientation>

Attempts to convert the given orientation to a named orientation.

The conversion is based on approximate equality. If no named orientation is approximately equal to orientation, returns None.

Trait Implementations

impl Clone for NamedOrientation

fn clone(&self) -> NamedOrientation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NamedOrientation

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

Formats the value using the given formatter.

impl Default for NamedOrientation

fn default() -> NamedOrientation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NamedOrientation

fn deserialize<__D>( __deserializer: __D ) -> Result<NamedOrientation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<NamedOrientation> for Orientation

fn from(value: NamedOrientation) -> Orientation

Converts to this type from the input type.

impl Hash for NamedOrientation

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 NamedOrientation

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for NamedOrientation

impl Eq for NamedOrientation

impl StructuralPartialEq for NamedOrientation