stanford.androidlib.graphics

Class GRectangle

java.lang.Object

stanford.androidlib.graphics.GRectangle

All Implemented Interfaces:

Serializable

public class GRectangle
extends Object
implements Serializable

This class is a float-precision version of the Rectangle class in java.awt.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GRectangle() Constructs a new empty GRectangle.
GRectangle(float width, float height) Constructs a GRectangle at the origin with the specified width and height.
GRectangle(float x, float y, float width, float height) Constructs a new GRectangle with the specified coordinates and size.
GRectangle(GDimension size) Constructs a new GRectangle at the origin with the specified size.
GRectangle(GPoint pt) Constructs a new empty GRectangle at the specified location.
GRectangle(GPoint pt, GDimension size) Constructs a new GRectangle with the specified location and size.
GRectangle(GRectangle r) Constructs a new GRectangle from an existing one.

Method Summary

Modifier and Type	Method and Description
GRectangle	add(float x, float y) Adds the specified point to the rectangle.
GRectangle	add(GRectangle r) Adjusts the bounds of the current GRectangle so that it contains the rectangle represented by the argument.
boolean	contains(float x, float y) Returns true if the GRectangle contains the specified point.
boolean	contains(GPoint pt) Returns true if the GRectangle contains the specified point.
boolean	equals(Object obj) Tests whether two GRectangle objects are equal.
GRectangle	getBounds() Returns a new GRectangle whose bounds are the same as this one.
float	getHeight() Returns the height of this GDimension.
GPoint	getLocation() Returns a new GPoint with the location of the rectangle.
GDimension	getSize() Returns a new GDimension object with the size of the GRectangle.
float	getWidth() Returns the width of this GDimension.
float	getX() Returns the x coordinate of this GRectangle.
float	getY() Returns the y coordinate of this GRectangle.
GRectangle	grow(float dx, float dy) Adjusts the edges of a rectangle by the specified dx and dy offsets along each of its borders.
int	hashCode() Returns an integer hash code for the rectangle.
GRectangle	intersection(GRectangle r2) Returns the largest rectangle that is contained in both r1 and r2.
boolean	intersects(GRectangle r2) Returns true if r1 and r2 have a nonempty intersection.
boolean	isEmpty() Returns true if the rectangle is empty.
GRectangle	setBounds(float x, float y, float width, float height) Sets the components of a GRectangle from the specified values.
GRectangle	setBounds(GPoint pt, GDimension size) Sets the components of a GRectangle from the specified location and size.
GRectangle	setBounds(GRectangle bounds) Sets the bounds of one GRectangle equal to that of another.
GRectangle	setLocation(float x, float y) Sets the location of the GRectangle to the specified x and y values.
GRectangle	setLocation(GPoint pt) Sets the location of the GRectangle to the specified point.
GRectangle	setSize(float width, float height) Sets the size of the GRectangle to the specified values.
GRectangle	setSize(GDimension size) Sets the size of the GRectangle to the specified dimension.
String	toString() Converts this GRectangle to its string representation.
GRectangle	translate(float dx, float dy) Adjusts the coordinates of a rectangle by the specified dx and dy offsets.
GRectangle	union(GRectangle r2) Returns the smallest rectangle that contains both r1 and r2.

Methods inherited from class java.lang.Object

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

Constructor Detail

GRectangle

public GRectangle()

Constructs a new empty GRectangle.

Usage:

rect = new GRectangle();

GRectangle

public GRectangle(float x,
                  float y,
                  float width,
                  float height)

Constructs a new GRectangle with the specified coordinates and size.

Parameters:

x - The x-coordinate of the rectangle

y - The y-coordinate of the rectangle

width - The width of the rectangle

height - The height of the rectangle

Usage:

rect = new GRectangle(x, y, width, height);

GRectangle

public GRectangle(float width,
                  float height)

Constructs a GRectangle at the origin with the specified width and height.

Parameters:

width - The width of the rectangle

height - The height of the rectangle

Usage:

rect = new GRectangle(width, height);

GRectangle

public GRectangle(GPoint pt,
                  GDimension size)

Constructs a new GRectangle with the specified location and size.

Parameters:

pt - The location of the upper left corner of the rectangle

size - The dimensions of the rectangle

Usage:

rect = new GRectangle(pt, size);

GRectangle

public GRectangle(GPoint pt)

Constructs a new empty GRectangle at the specified location.

Parameters:

pt - The location of the upper left corner of the rectangle

Usage:

rect = new GRectangle(pt);

GRectangle

public GRectangle(GDimension size)

Constructs a new GRectangle at the origin with the specified size.

Parameters:

size - The dimensions of the rectangle

Usage:

rect = new GRectangle(size);

GRectangle

public GRectangle(GRectangle r)

Constructs a new GRectangle from an existing one.

Parameters:

r - The original rectangle

Usage:

rect = new GRectangle(r);

Method Detail

getX

public float getX()

Returns the x coordinate of this GRectangle.

Returns:

The x coordinate of this GRectangle

Usage:

x = rect.getX();

getY

public float getY()

Returns the y coordinate of this GRectangle.

Returns:

The y coordinate of this GRectangle

Usage:

y = rect.getY();

getWidth

public float getWidth()

Returns the width of this GDimension.

Returns:

The width of this GDimension

Usage:

width = rect.getWidth();

getHeight

public float getHeight()

Returns the height of this GDimension.

Returns:

The height of this GDimension

Usage:

height = rect.getHeight();

setBounds

public GRectangle setBounds(float x,
                            float y,
                            float width,
                            float height)

Sets the components of a GRectangle from the specified values.

Parameters:

x - The x-coordinate of the rectangle

y - The y-coordinate of the rectangle

width - The width of the rectangle

height - The height of the rectangle

Usage:

rect.setBounds(x, y, width, height);

setBounds

public GRectangle setBounds(GPoint pt,
                            GDimension size)

Sets the components of a GRectangle from the specified location and size.

Parameters:

pt - The location of the upper left corner of the rectangle

size - The dimensions of the rectangle

Usage:

rect.setBounds(pt, size);

setBounds

public GRectangle setBounds(GRectangle bounds)

Sets the bounds of one GRectangle equal to that of another.

Parameters:

bounds - A GRectangle specifying the new bounds

Usage:

rect.setBounds(bounds);

getBounds

public GRectangle getBounds()

Returns a new GRectangle whose bounds are the same as this one.

Returns:

A new rectangle with the same bounds

Usage:

r = rect.getBounds();

setLocation

public GRectangle setLocation(float x,
                              float y)

Sets the location of the GRectangle to the specified x and y values.

Parameters:

x - The new x-coordinate for the rectangle

y - The new y-coordinate for the rectangle

Usage:

rect.setLocation(x, y);

setLocation

public GRectangle setLocation(GPoint pt)

Sets the location of the GRectangle to the specified point.

Parameters:

pt - The new location for the rectangle

Usage:

rect.setLocation(pt);

getLocation

public GPoint getLocation()

Returns a new GPoint with the location of the rectangle.

Returns:

The location of the rectangle as a GPoint

Usage:

pt = rect.getLocation();

translate

public GRectangle translate(float dx,
                            float dy)

Adjusts the coordinates of a rectangle by the specified dx and dy offsets.

Parameters:

dx - The change in the x direction (positive is rightward)

dy - The change in the y direction (positive is downward)

Usage:

rect.translate(dx, dy);

setSize

public GRectangle setSize(float width,
                          float height)

Sets the size of the GRectangle to the specified values.

Parameters:

width - The new width of the rectangle

height - The new height of the rectangle

Usage:

rect.setSize(width, height);

setSize

public GRectangle setSize(GDimension size)

Sets the size of the GRectangle to the specified dimension.

Parameters:

size - The new dimensions of the rectangle

Usage:

rect.setSize(size);

getSize

public GDimension getSize()

Returns a new GDimension object with the size of the GRectangle.

Returns:

The size of the rectangle as a GDimension

Usage:

size = rect.getSize();

grow

public GRectangle grow(float dx,
                       float dy)

Adjusts the edges of a rectangle by the specified dx and dy offsets along each of its borders.

Parameters:

dx - The offset to extend each of the left and right borders

dy - The offset to extend each of the top and bottom borders

Usage:

rect.grow(dx, dy);

isEmpty

public boolean isEmpty()

Returns true if the rectangle is empty.

Returns:

true if the rectangle is empty, and false otherwise

Usage:

if (rect.isEmpty()) . . .

contains

public boolean contains(float x,
                        float y)

Returns true if the GRectangle contains the specified point.

Parameters:

x - The x-coordinate of the point being tested

y - The y-coordinate of the point being tested

Returns:

true if the rectangle contains (x, y), and false otherwise

Usage:

if (rect.contains(x, y)) . . .

contains

public boolean contains(GPoint pt)

Returns true if the GRectangle contains the specified point.

Parameters:

pt - The point being tested

Returns:

true if the rectangle contains pt, and false otherwise

Usage:

if (rect.contains(pt)) . . .

intersects

public boolean intersects(GRectangle r2)

Returns true if r1 and r2 have a nonempty intersection.

Parameters:

r2 - A second rectangle

Returns:

true if the two rectangles intersect, and false otherwise

Usage:

if (r1.intersects(r2)) . . .

intersection

public GRectangle intersection(GRectangle r2)

Returns the largest rectangle that is contained in both r1 and r2.

Parameters:

r2 - A second rectangle

Returns:

The intersection of this rectangle and r2

Usage:

r3 = r1.intersection(r2);

union

public GRectangle union(GRectangle r2)

Returns the smallest rectangle that contains both r1 and r2.

Parameters:

r2 - A second rectangle

Returns:

The union of this rectangle and r2

Usage:

r3 = r1.union(r2);

add

public GRectangle add(GRectangle r)

Adjusts the bounds of the current GRectangle so that it contains the rectangle represented by the argument.

Parameters:

r - A new rectangle to include in this one

Usage:

rect.add(r);

add

public GRectangle add(float x,
                      float y)

Adds the specified point to the rectangle.

Parameters:

x - The x coordinate of the new point

y - The y coordinate of the new point

Usage:

rect.add(x, y);

hashCode

public int hashCode()

Returns an integer hash code for the rectangle. The hash code for a GRectangle is constructed from the hash codes from the float values of the coordinates, which are the ones used in the equals method.

Overrides:

hashCode in class Object

Returns:

The hash code for this rectangle

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

Usage:

hash = rect.hashCode();

Noshow:

equals

public boolean equals(Object obj)

Tests whether two GRectangle objects are equal. Because floating-point values are inexact, this method checks for equality by comparing the float values (rather than the float values) of the coordinates.

Overrides:

equals in class Object

Parameters:

obj - Any object

Returns:

true if the obj is a GRectangle equal to this one, and false otherwise

See Also:

Object.hashCode(), HashMap

Usage:

if (rect.equals(obj)) . . .

Noshow:

toString

public String toString()

Converts this GRectangle to its string representation.

Overrides:

toString in class Object

Returns:

A string representation of this rectangle

Usage:

str = rect.toString();

Noshow: