squidpony.squidgrid.mapping

Class Rectangle.Utils

java.lang.Object

squidpony.squidgrid.mapping.Rectangle.Utils

Enclosing interface:

Rectangle

public static class Rectangle.Utils
extends java.lang.Object

Utilities pertaining to Rectangle

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Comparator<Rectangle>	SIZE_COMPARATOR A comparator that uses size(Rectangle) as the measure.

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static java.util.Iterator<Coord>	cells(Rectangle r) Use cellsList(Rectangle) if you want them all.
static java.util.List<Coord>	cellsList(Rectangle r) Use cells(Rectangle) if you may stop before the end of the list, you'll save some memory.
static Coord	center(Rectangle r)
static boolean	contains(java.lang.Iterable<? extends Rectangle> rs, Coord c)
static boolean	contains(Rectangle r, Coord c)
static boolean	contains(Rectangle r, int x, int y)
static boolean	containsAny(Rectangle r, java.util.Collection<Coord> cs)
static Rectangle	extend(Rectangle r, Direction d)
static Coord[]	getAll4Corners(Rectangle r, Coord[] buf)
static java.util.List<Coord>	getBorder(Rectangle r, Direction cardinal, java.util.List<Coord> buf)
static Coord	getCorner(Rectangle r, Direction dir)
static Rectangle	shrink(Rectangle r) Creates a new Rectangle that is smaller than r by 1 cell from each of r's edges, to a minimum of a 1x1 cell.
static int	size(Rectangle r)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SIZE_COMPARATOR

public static final java.util.Comparator<Rectangle> SIZE_COMPARATOR

A comparator that uses size(Rectangle) as the measure.

Constructor Detail

Utils

public Utils()

Method Detail

contains

public static boolean contains(Rectangle r,
                               Coord c)

Parameters:

r - a Rectangle

c - a Coord to check against r for presence

Returns:

Whether r contains c.

contains

public static boolean contains(Rectangle r,
                               int x,
                               int y)

Parameters:

r - a Rectangle

x - x-coordinate of a point to check against r

y - y-coordinate of a point to check against r

Returns:

Whether r contains c.

containsAny

public static boolean containsAny(Rectangle r,
                                  java.util.Collection<Coord> cs)

Parameters:

r - a Rectangle

cs - a Collection of Coord to check against r; returns true if r contains any items in cs

Returns:

true if r contains a member of cs.

contains

public static boolean contains(java.lang.Iterable<? extends Rectangle> rs,
                               Coord c)

Parameters:

rs - an Iterable of Rectangle items to check against c

c - a Coord to try to find in any of the Rectangles in rs

Returns:

true if a member of rs contains c.

size

public static int size(Rectangle r)

Parameters:

r - a Rectangle

Returns:

The number of cells that r covers.

center

public static Coord center(Rectangle r)

Parameters:

r - a Rectangle

Returns:

The center of r.

cells

public static java.util.Iterator<Coord> cells(Rectangle r)

Use cellsList(Rectangle) if you want them all.

Parameters:

r - a Rectangle

Returns:

The cells that r contains, from bottom left to top right; lazily computed.

cellsList

public static java.util.List<Coord> cellsList(Rectangle r)

Use cells(Rectangle) if you may stop before the end of the list, you'll save some memory.

Parameters:

r -

Returns:

The cells that r contains, from bottom left to top right.

extend

public static Rectangle extend(Rectangle r,
                               Direction d)

Parameters:

d - A direction.

Returns:

r extended to d by one row and/or column.

getCorner

public static Coord getCorner(Rectangle r,
                              Direction dir)

Parameters:

r -

dir -

Returns:

The coord at the corner identified by dir in r.

getAll4Corners

public static Coord[] getAll4Corners(Rectangle r,
                                     Coord[] buf)

Parameters:

r -

buf - An array of (at least) size 4, to hold the 4 corners. It is returned, except if null or too small, in which case a fresh array is returned.

Returns:

buf, if it had length of at least 4, or a new 4-element array; it contains this Rectangle's 4 corners

shrink

public static Rectangle shrink(Rectangle r)

Creates a new Rectangle that is smaller than r by 1 cell from each of r's edges, to a minimum of a 1x1 cell.

Parameters:

r - a Rectangle to shrink

Returns:

the shrunken Rectangle, newly-allocated

getBorder

public static java.util.List<Coord> getBorder(Rectangle r,
                                              Direction cardinal,
                                              java.util.List<Coord> buf)

Parameters:

r -

cardinal -

buf - The buffer to fill or null to let this method allocate.

Returns:

The border of r at the position cardinal, i.e. the lowest line if r is Direction.DOWN, the highest line if r is Direction.UP, the leftest column if r is Direction.LEFT, and the rightest column if r is Direction.RIGHT.