Package org.jungrapht.visualization.layout.model

Class Rectangle

java.lang.Object

org.jungrapht.visualization.layout.model.Rectangle

public class Rectangle
extends Object

Simple, immutable Rectangle class, included to reduce dependency on awt classes

Author:

Tom Nelson

Field Summary

Fields

Modifier and Type	Field	Description
double	height	height (y dimension
static Rectangle	IDENTITY	identity rectangle of zero size at origin
double	maxX	x location of lower right corner
double	maxY	y location of lower right corner
double	width	width (x dimension)
double	x	x location of upper-left corner
double	y	y location of upper left corner

Constructor Summary

Constructors

Constructor	Description
Rectangle(double x, double y, double width, double height)

Method Summary

Modifier and Type	Method	Description
boolean	contains(double ox, double oy)	Fail fast for the most common case where the point coordinates are not contained.
boolean	contains(Point p)
boolean	equals(Object o)	Compare for equality
static Rectangle	from(Point min, Point max)
double	getCenterX()
double	getCenterY()
int	hashCode()
boolean	intersects(Rectangle other)	fail-fast implementation to reduce computation
Point	max()
Point	min()
static Rectangle	of(double x, double y, double width, double height)
static Rectangle	of(int width, int height)
static Rectangle	of(int x, int y, int width, int height)
Rectangle	offset(double x, double y)	offset the rectangle's location by the passed coordinates
String	toString()
Rectangle	union(double newX, double newY)	return a new Rectangle that is is the expansion of this Rectangle to contain the passed Point
Rectangle	union(Rectangle other)	return a union of this rectangle and the other rectangle

Methods inherited from class java.lang.Object

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

Field Detail

x

public final double x

x location of upper-left corner

y

public final double y

y location of upper left corner

width

public final double width

width (x dimension)

height

public final double height

height (y dimension

maxX

public final double maxX

x location of lower right corner

maxY

public final double maxY

y location of lower right corner

IDENTITY

public static Rectangle IDENTITY

identity rectangle of zero size at origin

Constructor Detail

Rectangle

public Rectangle(double x,
                 double y,
                 double width,
                 double height)

Parameters:

x - left most x location

y - top most y location

width - horizontal size of rectangle when aligned

height - vertical size of rectangle when aligned

Method Detail

of

public static Rectangle of(int x,
                           int y,
                           int width,
                           int height)

Parameters:

x - location of upper left corner

y - location of upper left corner

width - size in x dimension

height - size in y dimension

Returns:

a new Rectangle with the passed properties

of

public static Rectangle of(int width,
                           int height)

of

public static Rectangle of(double x,
                           double y,
                           double width,
                           double height)

Parameters:

x - location of upper left corner

y - location of upper left corner

width - size in x dimension

height - size in y dimension

Returns:

a new Rectangle with the passed properties

from

public static Rectangle from(Point min,
                             Point max)

getCenterX

public double getCenterX()

Returns:

the x coordinate of the center of this Rectangle

getCenterY

public double getCenterY()

Returns:

the y coordinate of the center of this Rectangle

intersects

public boolean intersects(Rectangle other)

fail-fast implementation to reduce computation

Parameters:

other - another Rectangle to compare

Returns:

whether there is a non-zero intersection of the 2 shapes

contains

public boolean contains(Point p)

Parameters:

p - point to test

Returns:

true if the coordinate is contained, false otherwise

min

public Point min()

max

public Point max()

contains

public boolean contains(double ox,
                        double oy)

Fail fast for the most common case where the point coordinates are not contained. Implementation leaves space for debug breakpoints

Parameters:

ox - coodinate to test

oy - coordinate to test

Returns:

true if the coordinate is contained, false otherwise

offset

public Rectangle offset(double x,
                        double y)

offset the rectangle's location by the passed coordinates

Parameters:

x - horizontal offset

y - vertical offset

Returns:

a new Rectangle offset by the passed coordinates

union

public Rectangle union(double newX,
                       double newY)

return a new Rectangle that is is the expansion of this Rectangle to contain the passed Point

Parameters:

newX - x coordinate of expansion point

newY - y coordinate of expansion point

Returns:

a new Rectangle that was expanded to include the passed coordinates

union

public Rectangle union(Rectangle other)

return a union of this rectangle and the other rectangle

Parameters:

other -

Returns:

equals

public boolean equals(Object o)

Compare for equality

Overrides:

equals in class Object

Parameters:

o - the object to compare

Returns:

true if the other Object is a Rectangle with identical properties to this Rectangle

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

a hash of the Rectangle properties

toString

public String toString()

Overrides:

toString in class Object

Returns:

a String representation of this Rectangle