Package squidpony.squidgrid.mapping

Class Rectangle.Impl

java.lang.Object

squidpony.squidgrid.zone.Zone.Skeleton

squidpony.squidgrid.mapping.Rectangle.Impl

All Implemented Interfaces:

Serializable, Iterable<Coord>, Rectangle, Zone

Enclosing interface:

Rectangle

public static class Rectangle.Impl
extends Zone.Skeleton
implements Rectangle

Author:

smelC

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface squidpony.squidgrid.mapping.Rectangle

Rectangle.Impl, Rectangle.Utils

Nested classes/interfaces inherited from interface squidpony.squidgrid.zone.Zone

Zone.Helper, Zone.Skeleton

Field Summary

Fields

Modifier and Type	Field	Description
protected Coord	bottomLeft
protected int	height
protected int	width

Constructor Summary

Constructors

Constructor	Description
Impl(Coord bottomLeft, int width, int height)

Method Summary

Modifier and Type	Method	Description
boolean	contains(int x, int y)
boolean	contains(Coord c)
boolean	equals(Object obj)
Rectangle	extend()	Gets a new Zone that contains all the Coords in this plus all neighboring Coords, which can be orthogonally or diagonally adjacent to any Coord this has in it.
List<Coord>	getAll()
Coord	getBottomLeft()
Coord	getCenter()
Collection<Coord>	getExternalBorder()	Gets a Collection of Coord values that are not in this Zone, but are adjacent to it, either orthogonally or diagonally.
int	getHeight()
List<Coord>	getInternalBorder()
int	getWidth()
int	hashCode()
boolean	isEmpty()
Iterator<Coord>	iterator()
int	size()
String	toString()
Zone	translate(int x, int y)
int	xBound(boolean smallestOrBiggest)
int	yBound(boolean smallestOrBiggest)

Methods inherited from class squidpony.squidgrid.zone.Zone.Skeleton

contains, getDiagonal, intersectsWith, translate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface squidpony.squidgrid.zone.Zone

contains, getDiagonal, intersectsWith, translate

Field Details

bottomLeft

protected final Coord bottomLeft

width

protected final int width

height

protected final int height

Constructor Details

Impl

public Impl(Coord bottomLeft, int width, int height)

Method Details

getBottomLeft

public Coord getBottomLeft()

Specified by:

getBottomLeft in interface Rectangle

Returns:

The bottom left coordinate of the room.

getWidth

public int getWidth()

Specified by:

getWidth in interface Rectangle

Specified by:

getWidth in interface Zone

Overrides:

getWidth in class Zone.Skeleton

Returns:

The distance between the leftmost cell and the rightmost cell, or anything negative if this zone is empty; may be 0 if all cells are in one vertical line.

getHeight

public int getHeight()

Specified by:

getHeight in interface Rectangle

Specified by:

getHeight in interface Zone

Overrides:

getHeight in class Zone.Skeleton

Returns:

The distance between the topmost cell and the lowest cell, or anything negative if this zone is empty; may be 0 if all cells are in one horizontal line.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Zone

Returns:

Whether this zone is empty.

size

public int size()

Specified by:

size in interface Zone

Overrides:

size in class Zone.Skeleton

Returns:

The number of cells that this zone contains (the size Zone.getAll()).

contains

public boolean contains(int x, int y)

Specified by:

contains in interface Zone

Overrides:

contains in class Zone.Skeleton

Returns:

Whether this zone contains the coordinate (x,y).

contains

public boolean contains(Coord c)

Specified by:

contains in interface Zone

Overrides:

contains in class Zone.Skeleton

Returns:

Whether this zone contains c.

xBound

public int xBound(boolean smallestOrBiggest)

Specified by:

xBound in interface Zone

Overrides:

xBound in class Zone.Skeleton

Parameters:

smallestOrBiggest - if true, finds the smallest x-coordinate value; if false, finds the biggest.

Returns:

The x-coordinate of the Coord within this that has the smallest (or biggest) x-coordinate. Or -1 if the zone is empty.

yBound

public int yBound(boolean smallestOrBiggest)

Specified by:

yBound in interface Zone

Overrides:

yBound in class Zone.Skeleton

Parameters:

smallestOrBiggest - if true, finds the smallest y-coordinate value; if false, finds the biggest.

Returns:

The y-coordinate of the Coord within this that has the smallest (or biggest) y-coordinate. Or -1 if the zone is empty.

getCenter

public Coord getCenter()

Specified by:

getCenter in interface Zone

Overrides:

getCenter in class Zone.Skeleton

Returns:

The approximate center of this zone, or null if this zone is empty.

getAll

public List<Coord> getAll()

Specified by:

getAll in interface Zone

Returns:

All cells in this zone.

translate

public Zone translate(int x, int y)

Specified by:

translate in interface Zone

Overrides:

translate in class Zone.Skeleton

Returns:

this shifted by (x,y)

getInternalBorder

public List<Coord> getInternalBorder()

Specified by:

getInternalBorder in interface Zone

Overrides:

getInternalBorder in class Zone.Skeleton

Returns:

Cells in this that are adjacent to a cell not in this

getExternalBorder

public Collection<Coord> getExternalBorder()

Description copied from interface: Zone

Gets a Collection of Coord values that are not in this Zone, but are adjacent to it, either orthogonally or diagonally. Related to the fringe() methods in CoordPacker and GreasedRegion, but guaranteed to use 8-way adjacency and to return a new Collection of Coord.

Specified by:

getExternalBorder in interface Zone

Overrides:

getExternalBorder in class Zone.Skeleton

Returns:

Cells adjacent to this (orthogonally or diagonally) that aren't in this

extend

public Rectangle extend()

Description copied from interface: Zone

Gets a new Zone that contains all the Coords in this plus all neighboring Coords, which can be orthogonally or diagonally adjacent to any Coord this has in it. Related to the expand() methods in CoordPacker and GreasedRegion, but guaranteed to use 8-way adjacency and to return a new Zone.

Specified by:

extend in interface Zone

Overrides:

extend in class Zone.Skeleton

Returns:

A variant of this where cells adjacent to this (orthogonally or diagonally) have been added (i.e. it's this plus Zone.getExternalBorder()).

iterator

public Iterator<Coord> iterator()

Specified by:

iterator in interface Iterable<Coord>

Overrides:

iterator in class Zone.Skeleton