Enum Pivot 

pub enum Pivot {
    TopLeft,
    TopCenter,
    TopRight,
    LeftCenter,
    RightCenter,
    BottomLeft,
    BottomCenter,
    BottomRight,
    Center,
}

A pivot on a 2d sized grid. Can be used to set positions relative to a given pivot. Each pivot has it’s own coordinate space it uses to calculate the final adjusted position.

Variants

TopLeft

Coordinate space: X increases to the right, Y increases downwards.

TopCenter

Coordinate space: X increases to the right, Y increases downwards.

TopRight

Coordinate space: X increases to the left, Y increases downwards.

LeftCenter

Coordinate space: X increases to the right, Y increases upwards.

RightCenter

Coordinate space: X increases to the left, Y increases upwards.

BottomLeft

Coordinate space: X increases to the right, Y increases upwards.

BottomCenter

Coordinate space: X increases to the right, Y increases upwards.

BottomRight

Coordinate space: X increases to the left, Y increases upwards.

Center

Coordinate space: X increases to the right, Y increases upwards.

Implementations

impl Pivot

pub fn axis(&self) -> IVec2

Coordinate axis for each pivot, used when transforming a point into the pivot’s coordinate space.

pub fn normalized(&self) -> Vec2

The normalized value of this pivot in default coordinate space where [0.0, 0.0] is the bottom left and [1.0, 1.0] is the top right.

pub fn transform_point(&self, grid_point: impl GridPoint) -> IVec2

Transform a point into the pivot’s coordinate space.

pub fn pivot_position(&self, grid_size: impl GridSize) -> IVec2

Calculate the position of a pivot on a sized grid.

Trait Implementations

impl Clone for Pivot

fn clone(&self) -> Pivot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pivot

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

Formats the value using the given formatter.

impl Ordinalize for Pivot

const VARIANT_COUNT: usize = 9usize

The count of variants.

const VARIANTS: &'static [Self]

List of this enum’s variants.

const VALUES: &'static [i8]

List of values for all variants of this enum.

type VariantType = i8

The type of the values of the variants.

fn ordinal(&self) -> i8

Retrieve the integer number of this variant.

unsafe fn from_ordinal_unsafe(number: i8) -> Self

Obtain a variant based on an integer number.

fn from_ordinal(number: i8) -> Option<Self>

Obtain a variant based on an integer number.

impl PartialEq for Pivot

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

impl Eq for Pivot

impl StructuralPartialEq for Pivot