Struct sark_grids::pivot::PivotedPoint

pub struct PivotedPoint {
    pub point: IVec2,
    pub pivot: Pivot,
}

A 2d point on a rect aligned to a certain Pivot.

Fields

point: IVec2

pivot: Pivot

Trait Implementations

impl Clone for PivotedPoint

fn clone(&self) -> PivotedPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PivotedPoint

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

Formats the value using the given formatter.

impl GridPoint for PivotedPoint

fn x(&self) -> i32

fn y(&self) -> i32

fn get_pivot(self) -> Option<Pivot>

Retrieve the pivot-aligned point on the grid.

fn width(&self) -> i32

fn height(&self) -> i32

fn len(&self) -> usize

fn as_ivec2(&self) -> IVec2

fn as_uvec2(&self) -> UVec2

fn as_vec2(&self) -> Vec2

fn as_array(&self) -> [i32; 2]

fn as_index(&self, grid_width: usize) -> usize

Get the grid point’s corresponding 1d index.

fn pivot(&self, pivot: Pivot) -> PivotedPoint

Return a PivotedPoint.

fn up(&self, amount: i32) -> IVec2

Returns the grid point the given number of spaces above this one.

fn down(&self, amount: i32) -> IVec2

Returns the grid point the given number of spaces below this one.

fn right(&self, amount: i32) -> IVec2

Returns the grid point the given number of spaces to the right of this one.

fn left(&self, amount: i32) -> IVec2

Returns the grid point the given number of spaces to the left of this one.

fn offset(&self, xy: impl GridPoint) -> IVec2

Returns the grid point offset by the given amount.

fn taxi_dist(self, other: impl GridPoint) -> usize

The taxicab distance between two grid points.

fn lerp(self, other: impl GridPoint, t: f32) -> IVec2

Linearly interpolate between points a and b by the amount t.

fn adj_8(&self) -> AdjIterator<'_>

Returns an iterator over the 8 points adjacent to this one.

fn adj_4(&self) -> AdjIterator<'_>

Returns an iterator over the 4 points adjacent to this one.

impl PartialEq for PivotedPoint

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

impl Eq for PivotedPoint

impl StructuralPartialEq for PivotedPoint