Struct GridRectangle 

pub struct GridRectangle { /* private fields */ }

represents a rectangle of regions defined by the lower left (minimum coordinates) and upper right (maximum coordinates) corners in GridCoordinates

Implementations

impl GridRectangle

pub fn new(corner1: GridCoordinates, corner2: GridCoordinates) -> Self

creates a new GridRectangle given any two corners

pub fn expanded_west(&self, by: u16) -> Self

returns a new GridRectangle extended by by regions on the west (-x) side

Saturates at the western edge of the grid (x = 0).

pub fn expanded_east(&self, by: u16) -> Self

returns a new GridRectangle extended by by regions on the east (+x) side

Saturates at the eastern edge of the grid (x = u16::MAX).

pub fn expanded_south(&self, by: u16) -> Self

returns a new GridRectangle extended by by regions on the south (-y) side

Saturates at the southern edge of the grid (y = 0).

pub fn expanded_north(&self, by: u16) -> Self

returns a new GridRectangle extended by by regions on the north (+y) side

Saturates at the northern edge of the grid (y = u16::MAX).

Trait Implementations

impl Clone for GridRectangle

fn clone(&self) -> GridRectangle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GridRectangle

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

Formats the value using the given formatter.

impl Eq for GridRectangle

impl GridRectangleLike for GridRectangle

fn grid_rectangle(&self) -> GridRectangle

the GridRectangle represented by this map like image

fn lower_left_corner(&self) -> GridCoordinates

returns the lower left corner of the rectangle

fn upper_right_corner(&self) -> GridCoordinates

returns the upper right corner of the rectangle

fn size_x(&self) -> u16

the size of the map like image in regions in the x direction (width)

fn size_y(&self) -> u16

the size of the map like image in regions in the y direction (width)

fn x_range(&self) -> RangeInclusive<u16>

returns a range for the region x coordinates of this rectangle

fn y_range(&self) -> RangeInclusive<u16>

returns a range for the region y coordinates of this rectangle

fn lower_right_corner(&self) -> GridCoordinates

returns the lower right corner of the rectangle

fn upper_left_corner(&self) -> GridCoordinates

returns the upper left corner of the rectangle

fn contains(&self, grid_coordinates: &GridCoordinates) -> bool

checks if a given set of GridCoordinates is within this GridRectangle

fn intersect<O>(&self, other: &O) -> Option<GridRectangle>

where O: GridRectangleLike,

returns a new GridRectangle which is the area where this GridRectangle and another intersect each other or None if there is no intersection

fn pps_hud_config(&self) -> String

returns a PPS HUD description string for this GridRectangle

impl PartialEq for GridRectangle

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