Module javafx.graphics

Package javafx.geometry

Class Rectangle2D

java.lang.Object

javafx.geometry.Rectangle2D

public class Rectangle2D
extends Object

A 2D rectangle used to describe the bounds of an object. It is defined by a location (minX, minY) and dimension (width x height).

Since:

JavaFX 2.0

Field Summary

Fields

Modifier and Type	Field	Description
static Rectangle2D	EMPTY	An empty Rectangle2D instance (with all coordinates equal to zero).

Constructor Summary

Constructors

Constructor	Description
Rectangle2D(double minX, double minY, double width, double height)	Creates a new instance of Rectangle2D.

Method Summary

Modifier and Type	Method	Description
boolean	contains(double x, double y)	Tests if the specified (x, y) coordinates are inside the boundary of Rectangle2D.
boolean	contains(double x, double y, double w, double h)	Tests if the interior of this Rectangle2D entirely contains the specified rectangular area.
boolean	contains(Point2D p)	Tests if the specified point is inside the boundary of Rectangle2D.
boolean	contains(Rectangle2D r)	Tests if the interior of this Rectangle2D entirely contains the specified Rectangle2D, r.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
double	getHeight()	The height of this Rectangle2D.
double	getMaxX()	The x coordinate of the lower-right corner of this Rectangle2D.
double	getMaxY()	The y coordinate of the lower-right corner of this Rectangle2D.
double	getMinX()	The x coordinate of the upper-left corner of this Rectangle2D.
double	getMinY()	The y coordinate of the upper-left corner of this Rectangle2D.
double	getWidth()	The width of this Rectangle2D.
int	hashCode()	Returns a hash code for this Rectangle2D object.
boolean	intersects(double x, double y, double w, double h)	Tests if the interior of this Rectangle2D intersects the interior of a specified rectangular area.
boolean	intersects(Rectangle2D r)	Tests if the interior of this Rectangle2D intersects the interior of a specified Rectangle2D, r.
String	toString()	Returns a string representation of this Rectangle2D.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Rectangle2D EMPTY

An empty Rectangle2D instance (with all coordinates equal to zero).

Constructor Detail

Rectangle2D

public Rectangle2D(double minX,
                   double minY,
                   double width,
                   double height)

Creates a new instance of Rectangle2D.

Parameters:

minX - The x coordinate of the upper-left corner of the Rectangle2D

minY - The y coordinate of the upper-left corner of the Rectangle2D

width - The width of the Rectangle2D

height - The height of the Rectangle2D

Method Detail

getMinX

public double getMinX()

The x coordinate of the upper-left corner of this Rectangle2D.

Default value:

0.0

Returns:

the x coordinate of the upper-left corner

getMinY

public double getMinY()

The y coordinate of the upper-left corner of this Rectangle2D.

Default value:

0.0

Returns:

the y coordinate of the upper-left corner

getWidth

public double getWidth()

The width of this Rectangle2D.

Default value:

0.0

Returns:

the width

getHeight

public double getHeight()

The height of this Rectangle2D.

Default value:

0.0

Returns:

the height

getMaxX

public double getMaxX()

The x coordinate of the lower-right corner of this Rectangle2D.

Default value:

minX + width

Returns:

the x coordinate of the lower-right corner

getMaxY

public double getMaxY()

The y coordinate of the lower-right corner of this Rectangle2D.

Default value:

minY + height

Returns:

the y coordinate of the lower-right corner

contains

public boolean contains(Point2D p)

Tests if the specified point is inside the boundary of Rectangle2D.

Parameters:

p - the specified point to be tested

Returns:

true if the specified point is inside the boundary of this Rectangle2D; false otherwise

contains

public boolean contains(double x,
                        double y)

Tests if the specified (x, y) coordinates are inside the boundary of Rectangle2D.

Parameters:

x - the specified x coordinate to be tested

y - the specified y coordinate to be tested

Returns:

true if the specified (x, y) coordinates are inside the boundary of this Rectangle2D; false otherwise

contains

public boolean contains(Rectangle2D r)

Tests if the interior of this Rectangle2D entirely contains the specified Rectangle2D, r.

Parameters:

r - The specified Rectangle2D

Returns:

true if the specified Rectangle2D, r, is inside the boundary of this Rectangle2D; false otherwise

contains

public boolean contains(double x,
                        double y,
                        double w,
                        double h)

Tests if the interior of this Rectangle2D entirely contains the specified rectangular area.

Parameters:

x - the x coordinate of the upper-left corner of the specified rectangular area

y - the y coordinate of the upper-left corner of the specified rectangular area

w - the width of the specified rectangular area

h - the height of the specified rectangular area

Returns:

true if the interior of this Rectangle2D entirely contains the specified rectangular area; false otherwise

intersects

public boolean intersects(Rectangle2D r)

Tests if the interior of this Rectangle2D intersects the interior of a specified Rectangle2D, r.

Parameters:

r - The specified Rectangle2D

Returns:

true if the interior of this Rectangle2D and the interior of the specified Rectangle2D, r, intersect

intersects

public boolean intersects(double x,
                          double y,
                          double w,
                          double h)

Tests if the interior of this Rectangle2D intersects the interior of a specified rectangular area.

Parameters:

x - the x coordinate of the upper-left corner of the specified rectangular area

y - the y coordinate of the upper-left corner of the specified rectangular area

w - the width of the specified rectangular area

h - the height of the specified rectangular area

Returns:

true if the interior of this Rectangle2D and the interior of the rectangular area intersect

equals

public boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is equal to the obj argument; false otherwise

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this Rectangle2D object.

Overrides:

hashCode in class Object

Returns:

a hash code for this Rectangle2D object.

See Also:

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

toString

public String toString()

Returns a string representation of this Rectangle2D. This method is intended to be used only for informational purposes. The content and format of the returned string might vary between implementations. The returned string might be empty but cannot be null.

Overrides:

toString in class Object

Returns:

a string representation of the object.