Struct me3_framework::overlay::Align2

pub struct Align2(pub [Align; 2]);

Two-dimension alignment, e.g. Align2::LEFT_TOP.

Tuple Fields

0: [Align; 2]

Implementations

impl Align2

pub const LEFT_BOTTOM: Align2 = Align2([Align::Min, Align::Max])

pub const LEFT_CENTER: Align2 = Align2([Align::Min, Align::Center])

pub const LEFT_TOP: Align2 = Align2([Align::Min, Align::Min])

pub const CENTER_BOTTOM: Align2 = Align2([Align::Center, Align::Max])

pub const CENTER_CENTER: Align2 = Align2([Align::Center, Align::Center])

pub const CENTER_TOP: Align2 = Align2([Align::Center, Align::Min])

pub const RIGHT_BOTTOM: Align2 = Align2([Align::Max, Align::Max])

pub const RIGHT_CENTER: Align2 = Align2([Align::Max, Align::Center])

pub const RIGHT_TOP: Align2 = Align2([Align::Max, Align::Min])

impl Align2

pub fn x(self) -> Align

Returns an alignment by the X (horizontal) axis

pub fn y(self) -> Align

Returns an alignment by the Y (vertical) axis

pub fn to_sign(self) -> Vec2

-1, 0, or +1 for each axis

pub fn anchor_rect(self, rect: Rect) -> Rect

Used e.g. to anchor a piece of text to a part of the rectangle. Give a position within the rect, specified by the aligns

pub fn align_size_within_rect(self, size: Vec2, frame: Rect) -> Rect

e.g. center a size within a given frame

pub fn pos_in_rect(self, frame: &Rect) -> Pos2

Returns the point on the rect’s frame or in the center of a rect according to the alignments of this object.

(*)-----------+------(*)------+-----------(*)--> X
 |            |               |            |
 |  Min, Min  |  Center, Min  |  Max, Min  |
 |            |               |            |
 +------------+---------------+------------+
 |            |               |            |
(*)Min, Center|Center(*)Center|Max, Center(*)
 |            |               |            |
 +------------+---------------+------------+
 |            |               |            |
 |  Min, Max  | Center, Max   |  Max, Max  |
 |            |               |            |
(*)-----------+------(*)------+-----------(*)
 |
 Y

Trait Implementations

impl Clone for Align2

fn clone(&self) -> Align2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Align2

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

Formats the value using the given formatter.

impl Hash for Align2

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,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for Align2

type Output = Align

The returned type after indexing.

fn index(&self, index: usize) -> &Align

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Align2

fn index_mut(&mut self, index: usize) -> &mut Align

Performs the mutable indexing (container[index]) operation.

impl PartialEq<Align2> for Align2

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

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

const 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 Copy for Align2

impl Eq for Align2

impl StructuralEq for Align2

impl StructuralPartialEq for Align2