Struct TileRect 

pub struct TileRect {
    pub position: Vector2<i32>,
    pub size: Vector2<i32>,
}

This is a variation of Rect that is specifically designed for use with TileMap. While the y-axis of Rect points downward to match the y-axis of UI, the y-axis of TileRect points upward to match the y-axis of TileMap, TileSet, and TileMapBrush.

Unlike Rect, TileRect is designed to contain a WxH region of tiles, which means that position + size is not considered to be a point contained in the rect. A point is only contained in the rect if its entire 1x1 area is contained in the rect, so the left-top corner of the rect is position + size - (1,1).

Fields

position: Vector2<i32>

The left-bottom corner of the rect.

size: Vector2<i32>

The width and height of the rect.

Implementations

impl TileRect

pub fn new(x: i32, y: i32, w: i32, h: i32) -> Self

Creates a new rectangle from X, Y, width, height.

pub fn iter(&self) -> RectIter

Iterate over the cells contained within this rect.

pub fn from_points(p0: Vector2<i32>, p1: Vector2<i32>) -> Self

Create a new rectangle from two diagonally opposite corner points. In other words, create the smallest rectangle containing both given points.

pub fn with_position(self, position: Vector2<i32>) -> Self

Sets the new position of the rectangle.

pub fn with_size(self, size: Vector2<i32>) -> Self

Sets the new size of the rectangle.

pub fn inflate(&self, dw: i32, dh: i32) -> Self

Inflates the rectangle by the given amounts. It offsets the rectangle by (-dw, -dh) and increases its size by (2 * dw, 2 * dh).

pub fn deflate(&self, dw: i32, dh: i32) -> OptionTileRect

Deflates the rectangle by the given amounts. It offsets the rectangle by (dw, dh) and decreases its size by (2 * dw, 2 * dh).

pub fn contains(&self, pt: Vector2<i32>) -> bool

Checks if the given point lies within the bounds of the rectangle.

pub fn center(&self) -> Vector2<i32>

Returns center point of the rectangle.

pub fn push(&mut self, p: Vector2<i32>)

Extends the rectangle to contain the given point.

pub fn clip_by(&self, other: TileRect) -> OptionTileRect

Clips the rectangle by some other rectangle and returns a new rectangle that corresponds to the intersection of both rectangles. If the rectangles does not intersects, the method returns none.

pub fn intersects(&self, other: TileRect) -> bool

Checks if the rectangle intersects with some other rectangle.

pub fn translate(&self, translation: Vector2<i32>) -> Self

Offsets the given rectangle and returns a new rectangle.

pub fn extend_to_contain(&mut self, other: TileRect)

Extends the rectangle so it will contain the other rectangle.

pub fn left_top_corner(&self) -> Vector2<i32>

Returns the top left corner of the rectangle.

pub fn right_top_corner(&self) -> Vector2<i32>

Returns the top right corner of the rectangle.

pub fn right_bottom_corner(&self) -> Vector2<i32>

Returns the bottom right corner of the rectangle.

pub fn left_bottom_corner(&self) -> Vector2<i32>

Returns the bottom left corner of the rectangle.

pub fn w(&self) -> i32

Returns width of the rectangle.

pub fn h(&self) -> i32

Returns height of the rectangle.

pub fn x(&self) -> i32

Returns horizontal position of the rectangle.

pub fn y(&self) -> i32

Returns vertical position of the rectangle.

Trait Implementations

impl Clone for TileRect

fn clone(&self) -> TileRect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TileRect

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

Formats the value using the given formatter.

impl From<TileRect> for OptionTileRect

fn from(source: TileRect) -> Self

Converts to this type from the input type.

impl IntoIterator for TileRect

type Item = Matrix<i32, Const<2>, Const<1>, ArrayStorage<i32, 2, 1>>

The type of the elements being iterated over.

type IntoIter = RectIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for TileRect

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

impl Eq for TileRect

impl StructuralPartialEq for TileRect