rle.core.board
Class RLRectangle

java.lang.Object
  java.awt.geom.RectangularShape
      java.awt.geom.Rectangle2D
          rle.core.board.RLRectangle

All Implemented Interfaces:

java.awt.Shape, java.lang.Cloneable

public final class RLRectangle
extends java.awt.geom.Rectangle2D

Immutable object for specifying rectangular regions on the Board.

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.geom.Rectangle2D

java.awt.geom.Rectangle2D.Double, java.awt.geom.Rectangle2D.Float

Field Summary

int	height
int	width
int	x
int	y

Fields inherited from class java.awt.geom.Rectangle2D

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

Constructor Summary

RLRectangle(int x, int y, int wid, int hgt)

Method Summary

java.awt.geom.Rectangle2D	createIntersection(java.awt.geom.Rectangle2D r) Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.
java.awt.geom.Rectangle2D	createUnion(java.awt.geom.Rectangle2D r) Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.
int	distance(int x, int y) Return the distance of a point to this rectangle.
int	distance(RLPoint p)
int	distance(RLRectangle r)
boolean	equals(java.lang.Object o)
java.awt.geom.Rectangle2D	getBounds2D() Returns the high precision bounding box of this Rectangle2D.
double	getHeight()
double	getWidth()
double	getX()
double	getY()
int	hashCode()
boolean	isEmpty() Determines whether or not this Rectangle2D is empty.
int	outcode(double x, double y) Determines where the specified double coordinates lie with respect to this Rectangle2D.
java.util.Set<RLPoint>	perimeter()
RLPoint	point()
java.util.Set<RLPoint>	points()
void	setRect(double x, double y, double width, double height) Throws an UnsupportedOperationException because this class is immutable.
RLDimension	size()
java.lang.String	toString() Returns the String representation of this Rectangle2D.

Methods inherited from class java.awt.geom.Rectangle2D

add, add, add, contains, contains, getPathIterator, getPathIterator, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union

Methods inherited from class java.awt.geom.RectangularShape

clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

Methods inherited from class java.lang.Object

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

Field Detail

x

public final int x

y

public final int y

width

public final int width

height

public final int height

Constructor Detail

RLRectangle

public RLRectangle(int x,
                   int y,
                   int wid,
                   int hgt)

Method Detail

distance

public int distance(int x,
                    int y)

Return the distance of a point to this rectangle. If the point is in the rectangle, we return 0. Otherwise, returns the smallest distance to any point within this rectangle.

distance

public int distance(RLPoint p)

distance

public int distance(RLRectangle r)

points

public java.util.Set<RLPoint> points()

perimeter

public java.util.Set<RLPoint> perimeter()

getX

public double getX()

Specified by:

getX in class java.awt.geom.RectangularShape

getY

public double getY()

Specified by:

getY in class java.awt.geom.RectangularShape

getHeight

public double getHeight()

Specified by:

getHeight in class java.awt.geom.RectangularShape

getWidth

public double getWidth()

Specified by:

getWidth in class java.awt.geom.RectangularShape

point

public RLPoint point()

size

public RLDimension size()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.awt.geom.Rectangle2D

hashCode

public int hashCode()

Overrides:

hashCode in class java.awt.geom.Rectangle2D

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height)

Throws an UnsupportedOperationException because this class is immutable.

Specified by:

setRect in class java.awt.geom.Rectangle2D

isEmpty

public boolean isEmpty()

Determines whether or not this Rectangle2D is empty.

Specified by:

isEmpty in class java.awt.geom.RectangularShape

Returns:

true if this Rectangle2D is empty; false otherwise.

Since:

1.2

outcode

public int outcode(double x,
                   double y)

Determines where the specified double coordinates lie with respect to this Rectangle2D. This method computes a binary OR of the appropriate mask values indicating, for each side of this Rectangle2D, whether or not the specified coordinates are on the same side of the edge as the rest of this Rectangle2D.

Specified by:

outcode in class java.awt.geom.Rectangle2D

Parameters:

x, y - the specified coordinates

Returns:

the logical OR of all appropriate out codes.

Since:

1.2

See Also:

Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM

getBounds2D

public java.awt.geom.Rectangle2D getBounds2D()

Returns the high precision bounding box of this Rectangle2D.

Specified by:

getBounds2D in interface java.awt.Shape

Overrides:

getBounds2D in class java.awt.geom.Rectangle2D

Returns:

the bounding box of this Rectangle2D.

Since:

1.2

createIntersection

public java.awt.geom.Rectangle2D createIntersection(java.awt.geom.Rectangle2D r)

Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.

Specified by:

createIntersection in class java.awt.geom.Rectangle2D

Parameters:

r - the Rectangle2D to be intersected with this Rectangle2D

Returns:

the largest Rectangle2D contained in both the specified Rectangle2D and in this Rectangle2D.

Since:

1.2

createUnion

public java.awt.geom.Rectangle2D createUnion(java.awt.geom.Rectangle2D r)

Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.

Specified by:

createUnion in class java.awt.geom.Rectangle2D

Parameters:

r - the Rectangle2D to be combined with this Rectangle2D

Returns:

the smallest Rectangle2D containing both the specified Rectangle2D and this Rectangle2D.

Since:

1.2

toString

public java.lang.String toString()

Returns the String representation of this Rectangle2D.

Overrides:

toString in class java.lang.Object

Returns:

a String representing this Rectangle2D.

Since:

1.2