Struct substrate::geometry::orientation::Orientation

pub struct Orientation { /* private fields */ }

An orientation of a geometric object.

Captures reflection and rotation, but not position or scaling.

Implementations

impl Orientation

pub fn from_reflect_and_angle(reflect_vert: bool, angle: f64) -> Orientation

Creates a new orientation with the given reflection and angle settings.

pub fn identity() -> Orientation

Returns the identity orientation with reflect_vert = false and angle = 0..

pub fn apply(self, o: impl Into<Orientation>) -> Orientation

Applies the reflection and rotation specified in Orientation o to this orientation.

pub fn reflected_vert(self) -> Orientation

Reflects the orientation vertically.

pub fn reflected_horiz(self) -> Orientation

Reflects the orientation horizontally.

pub fn r90(self) -> Orientation

Rotates the orientation 90 degrees counter-clockwise.

pub fn r180(self) -> Orientation

Rotates the orientation 180 degrees.

pub fn r270(self) -> Orientation

Rotates the orientation 180 degrees counter-clockwise.

pub fn r90cw(self) -> Orientation

Rotates the orientation 90 degrees clockwise.

pub fn r180cw(self) -> Orientation

Rotates the orientation 180 degrees clockwise.

pub fn r270cw(self) -> Orientation

Rotates the orientation 270 degrees clockwise.

pub fn flip_yx(self) -> Orientation

Flips the orientation around the line y = x.

pub fn flip_minus_yx(self) -> Orientation

Flips the orientation around the line y = -x.

pub fn reflect_vert(&self) -> bool

Returns whether the orientation is reflected vertically.

pub fn angle(&self) -> f64

Returns the angle associated with this orientation.

pub fn approx_eq(&self, other: &Orientation) -> bool

Compares the two orientations for approximate equality.

pub fn from_transformation(value: Transformation) -> Orientation

Returns the orientation represented by the given transformation.

Captures the rotation and reflection encoded by the Transformation, discarding the transformation’s translation.

Example

let tf = Transformation::identity();
assert_eq!(Orientation::from_transformation(tf), NamedOrientation::R0.into());

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

Returns a slice of all 8 possible rectangular orientations.

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

Trait Implementations

impl Clone for Orientation

fn clone(&self) -> Orientation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Orientation

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

Formats the value using the given formatter.

impl Default for Orientation

fn default() -> Orientation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Orientation

fn deserialize<__D>( __deserializer: __D ) -> Result<Orientation, <__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 From<Orientation> for OrientationBytes

fn from(value: Orientation) -> OrientationBytes

Converts to this type from the input type.

impl PartialEq for Orientation

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

fn partial_cmp(&self, other: &Orientation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Orientation

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 Orientation

impl StructuralPartialEq for Orientation