Rectangle2D JDK 1.6)

Methods

public void add (double newx, double newy)

Adds a point, specified by the double precision arguments newx and newy, to this Rectangle2D.

Adds a point, specified by the double precision arguments newx and newy, to this Rectangle2D. The resulting Rectangle2D is the smallest Rectangle2D that contains both the original Rectangle2D and the specified point.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a rectangle. Therefore, if the added point falls on the left or bottom edge of the enlarged rectangle, contains returns false for that point.
Parameters:
- newx - the X coordinate of the new point
- newy - the Y coordinate of the new point
Since: 1.2

public void add (Point2D pt)

Adds the Point2D object pt to this Rectangle2D.

Adds the Point2D object pt to this Rectangle2D. The resulting Rectangle2D is the smallest Rectangle2D that contains both the original Rectangle2D and the specified Point2D.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a rectangle. Therefore, if the added point falls on the left or bottom edge of the enlarged rectangle, contains returns false for that point.
Parameters:
- pt - the new Point2D to add to this Rectangle2D.
Since: 1.2

public void add (Rectangle2D r)

Adds a Rectangle2D object to this Rectangle2D.

Adds a Rectangle2D object to this
Rectangle2D. The resulting Rectangle2D
is the union of the two Rectangle2D objects.
Parameters:
- r - the Rectangle2D to add to this Rectangle2D.
Since: 1.2

public Object clone () [Inherited From RectangularShape]

Creates a new object of the same class and with the same contents as this object.

public boolean contains (double x, double y)

Tests if the specified coordinates are inside the boundary of the Shape.

Tests if the specified coordinates are inside the boundary of the
Shape.
Since: 1.2

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

Tests if the interior of the Shape entirely contains the specified rectangular area.

Tests if the interior of the Shape entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within the Shape for the entire rectanglar area to be considered contained within the Shape.

The Shape.contains() method allows a Shape implementation to conservatively return false when:

the intersect method returns true and
the calculations to determine whether or not the Shape entirely contains the rectangular area are prohibitively expensive.

This means that for some Shapes this method might return false even though the Shape contains the rectangular area. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.
Since: 1.2

public boolean contains (Point2D p) [Inherited From RectangularShape]

Tests if a specified Point2D is inside the boundary of the Shape.

Tests if a specified Point2D is inside the boundary
of the Shape.
Since: 1.2

public boolean contains (Rectangle2D r) [Inherited From RectangularShape]

Tests if the interior of the Shape entirely contains the specified Rectangle2D.

Tests if the interior of the Shape entirely contains the
specified Rectangle2D.
The Shape.contains() method allows a Shape
implementation to conservatively return false when:

the intersect method returns true and
the calculations to determine whether or not the
Shape entirely contains the Rectangle2D
are prohibitively expensive.

This means that for some Shapes this method might
return false even though the Shape contains
the Rectangle2D.
The Area class performs
more accurate geometric computations than most
Shape objects and therefore can be used if a more precise
answer is required.
Since: 1.2

publicabstract Rectangle2D createIntersection (Rectangle2D r)

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

Returns a new Rectangle2D object representing the
intersection of this Rectangle2D with the specified
Rectangle2D.
Returns: the largest Rectangle2D contained in both the specified Rectangle2D and in this Rectangle2D.
Parameters:
- r - the Rectangle2D to be intersected with this Rectangle2D
Since: 1.2

publicabstract Rectangle2D createUnion (Rectangle2D r)

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

Returns a new Rectangle2D object representing the
union of this Rectangle2D with the specified
Rectangle2D.
Returns: the smallest Rectangle2D containing both the specified Rectangle2D and this Rectangle2D.
Parameters:
- r - the Rectangle2D to be combined with this Rectangle2D
Since: 1.2

public boolean equals (Object obj)

Determines whether or not the specified Object is equal to this Rectangle2D.

Determines whether or not the specified Object is
equal to this Rectangle2D. The specified
Object is equal to this Rectangle2D
if it is an instance of Rectangle2D and if its
location and size are the same as this Rectangle2D.
Returns: true if obj is an instance of Rectangle2D and has the same values; false otherwise.
Parameters:
- obj - an Object to be compared with this Rectangle2D.
Since: 1.2

public Rectangle getBounds () [Inherited From RectangularShape]

Returns an integer Rectangle that completely encloses the Shape.

Returns an integer Rectangle that completely encloses the
Shape. Note that there is no guarantee that the
returned Rectangle is the smallest bounding box that
encloses the Shape, only that the Shape
lies entirely within the indicated Rectangle. The
returned Rectangle might also fail to completely
enclose the Shape if the Shape overflows
the limited range of the integer data type. The
getBounds2D method generally returns a
tighter bounding box due to its greater flexibility in
representation.
Since: 1.2

public Rectangle2D getBounds2D ()

Returns a high precision and more accurate bounding box of the Shape than the getBounds method.

Returns a high precision and more accurate bounding box of
the Shape than the getBounds method.
Note that there is no guarantee that the returned
Rectangle2D is the smallest bounding box that encloses
the Shape, only that the Shape lies
entirely within the indicated Rectangle2D. The
bounding box returned by this method is usually tighter than that
returned by the getBounds method and never fails due
to overflow problems since the return value can be an instance of
the Rectangle2D that uses double precision values to
store the dimensions.
Since: 1.2

public double getCenterX () [Inherited From RectangularShape]

Returns the X coordinate of the center of the framing rectangle of the Shape in double precision.

Returns the X coordinate of the center of the framing
rectangle of the Shape in double
precision.
Returns: the X coordinate of the center of the framing rectangle of the Shape.
Since: 1.2

public double getCenterY () [Inherited From RectangularShape]

Returns the Y coordinate of the center of the framing rectangle of the Shape in double precision.

Returns the Y coordinate of the center of the framing
rectangle of the Shape in double
precision.
Returns: the Y coordinate of the center of the framing rectangle of the Shape.
Since: 1.2

public Rectangle2D getFrame () [Inherited From RectangularShape]

Returns the framing Rectangle2D that defines the overall shape of this object.

Returns the framing Rectangle2D
that defines the overall shape of this object.
Returns: a Rectangle2D, specified in double coordinates.
Since: 1.2
See Also: RectangularShape.setFrame(double, double, double, double), RectangularShape.setFrame(Point2D, Dimension2D), RectangularShape.setFrame(Rectangle2D),

publicabstract double getHeight () [Inherited From RectangularShape]

Returns the height of the framing rectangle in double precision.

Returns the height of the framing rectangle
in double precision.
Returns: the height of the framing rectangle.
Since: 1.2

public double getMaxX () [Inherited From RectangularShape]

Returns the largest X coordinate of the framing rectangle of the Shape in double precision.

Returns the largest X coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the largest X coordinate of the framing rectangle of the Shape.
Since: 1.2

public double getMaxY () [Inherited From RectangularShape]

Returns the largest Y coordinate of the framing rectangle of the Shape in double precision.

Returns the largest Y coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the largest Y coordinate of the framing rectangle of the Shape.
Since: 1.2

public double getMinX () [Inherited From RectangularShape]

Returns the smallest X coordinate of the framing rectangle of the Shape in double precision.

Returns the smallest X coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the smallest X coordinate of the framing rectangle of the Shape.
Since: 1.2

public double getMinY () [Inherited From RectangularShape]

Returns the smallest Y coordinate of the framing rectangle of the Shape in double precision.

Returns the smallest Y coordinate of the framing
rectangle of the Shape in double
precision.
Returns: the smallest Y coordinate of the framing rectangle of the Shape.
Since: 1.2

public PathIterator getPathIterator (AffineTransform at)

Returns an iteration object that defines the boundary of this Rectangle2D.

Returns an iteration object that defines the boundary of this
Rectangle2D.
The iterator for this class is multi-threaded safe, which means
that this Rectangle2D class guarantees that
modifications to the geometry of this Rectangle2D
object do not affect any iterations of that geometry that
are already in process.
Returns: the PathIterator object that returns the geometry of the outline of this Rectangle2D, one segment at a time.
Parameters:
- at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
Since: 1.2

public PathIterator getPathIterator (AffineTransform at, double flatness) [Overrides RectangularShape]

Returns an iteration object that defines the boundary of the flattened Rectangle2D.

Returns an iteration object that defines the boundary of the
flattened Rectangle2D. Since rectangles are already
flat, the flatness parameter is ignored.
The iterator for this class is multi-threaded safe, which means
that this Rectangle2D class guarantees that
modifications to the geometry of this Rectangle2D
object do not affect any iterations of that geometry that
are already in process.
Returns: the PathIterator object that returns the geometry of the outline of this Rectangle2D, one segment at a time.
Parameters:
- at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
- flatness - the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve. Since rectangles are already flat, the flatness parameter is ignored.
Since: 1.2

publicabstract double getWidth () [Inherited From RectangularShape]

Returns the width of the framing rectangle in double precision.

Returns the width of the framing rectangle in
double precision.
Returns: the width of the framing rectangle.
Since: 1.2

publicabstract double getX () [Inherited From RectangularShape]

Returns the X coordinate of the upper-left corner of the framing rectangle in double precision.

Returns the X coordinate of the upper-left corner of
the framing rectangle in double precision.
Returns: the X coordinate of the upper-left corner of the framing rectangle.
Since: 1.2

publicabstract double getY () [Inherited From RectangularShape]

Returns the Y coordinate of the upper-left corner of the framing rectangle in double precision.

Returns the Y coordinate of the upper-left corner of
the framing rectangle in double precision.
Returns: the Y coordinate of the upper-left corner of the framing rectangle.
Since: 1.2

public int hashCode ()

Returns the hashcode for this Rectangle2D.

Returns the hashcode for this Rectangle2D.
Returns: the hashcode for this Rectangle2D.
Since: 1.2

publicstatic void intersect (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)

Intersects the pair of specified source Rectangle2D objects and puts the result into the specified destination Rectangle2D object.

Intersects the pair of specified source Rectangle2D
objects and puts the result into the specified destination
Rectangle2D object. One of the source rectangles
can also be the destination to avoid creating a third Rectangle2D
object, but in this case the original points of this source
rectangle will be overwritten by this method.
Parameters:
- src1 - the first of a pair of Rectangle2D objects to be intersected with each other
- src2 - the second of a pair of Rectangle2D objects to be intersected with each other
- dest - the Rectangle2D that holds the results of the intersection of src1 and src2
Since: 1.2

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

Tests if the interior of the Shape intersects the interior of a specified rectangular area.

Tests if the interior of the Shape intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the Shape if any point is contained in both the interior of the Shape and the specified rectangular area.

The Shape.intersects() method allows a Shape implementation to conservatively return true when:

there is a high probability that the rectangular area and the Shape intersect, but
the calculations to accurately determine this intersection are prohibitively expensive.

This means that for some Shapes this method might return true even though the rectangular area does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.
Since: 1.2

public boolean intersects (Rectangle2D r) [Inherited From RectangularShape]

Tests if the interior of the Shape intersects the interior of a specified Rectangle2D.

Tests if the interior of the Shape intersects the
interior of a specified Rectangle2D.
The Shape.intersects() method allows a Shape
implementation to conservatively return true when:

there is a high probability that the Rectangle2D and the
Shape intersect, but
the calculations to accurately determine this intersection
are prohibitively expensive.

This means that for some Shapes this method might
return true even though the Rectangle2D does not
intersect the Shape.
The Area class performs
more accurate computations of geometric intersection than most
Shape objects and therefore can be used if a more precise
answer is required.
Since: 1.2

public boolean intersectsLine (double x1, double y1, double x2, double y2)

Tests if the specified line segment intersects the interior of this Rectangle2D.

Tests if the specified line segment intersects the interior of this
Rectangle2D.
Returns: true if the specified line segment intersects the interior of this Rectangle2D; false otherwise.
Parameters:
- x1 - the X coordinate of the start point of the specified line segment
- y1 - the Y coordinate of the start point of the specified line segment
- x2 - the X coordinate of the end point of the specified line segment
- y2 - the Y coordinate of the end point of the specified line segment
Since: 1.2

public boolean intersectsLine (Line2D l)

Tests if the specified line segment intersects the interior of this Rectangle2D.

Tests if the specified line segment intersects the interior of this
Rectangle2D.
Returns: true if the specified Line2D intersects the interior of this Rectangle2D; false otherwise.
Parameters:
- l - the specified {@link Line2D} to test for intersection with the interior of this Rectangle2D
Since: 1.2

publicabstract boolean isEmpty () [Inherited From RectangularShape]

Determines whether the RectangularShape is empty.

Determines whether the RectangularShape is empty.
When the RectangularShape is empty, it encloses no
area.
Returns: true if the RectangularShape is empty; false otherwise.
Since: 1.2

publicabstract int outcode (double x, double y)

Determines where the specified coordinates lie with respect to this Rectangle2D.

Determines where the specified 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.
Returns: the logical OR of all appropriate out codes.
Parameters:
- x - the specified X coordinate
- y - the specified Y coordinate
Since: 1.2
See Also: Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM,

public int outcode (Point2D p)

Determines where the specified Point2D lies with respect to this Rectangle2D.

Determines where the specified Point2D lies 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 Point2D is on the same
side of the edge as the rest of this Rectangle2D.
Returns: the logical OR of all appropriate out codes.
Parameters:
- p - the specified Point2D
Since: 1.2
See Also: Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM,

public void setFrame (double x, double y, double w, double h) [Specified in RectangularShape]

Sets the location and size of the outer bounds of this Rectangle2D to the specified rectangular values.

Sets the location and size of the outer bounds of this
Rectangle2D to the specified rectangular values.
Parameters:
- x - the X coordinate of the upper-left corner of this Rectangle2D
- y - the Y coordinate of the upper-left corner of this Rectangle2D
- w - the width of this Rectangle2D
- h - the height of this Rectangle2D
Since: 1.2

public void setFrame (Point2D loc, Dimension2D size) [Inherited From RectangularShape]

Sets the location and size of the framing rectangle of this Shape to the specified Point2D and Dimension2D, respectively.

Sets the location and size of the framing rectangle of this
Shape to the specified Point2D and
Dimension2D, respectively. The framing rectangle is used
by the subclasses of RectangularShape to define
their geometry.
Parameters:
- loc - the specified Point2D
- size - the specified Dimension2D
Since: 1.2
See Also: RectangularShape.getFrame(),

public void setFrame (Rectangle2D r) [Inherited From RectangularShape]

Sets the framing rectangle of this Shape to be the specified Rectangle2D.

Sets the framing rectangle of this Shape to
be the specified Rectangle2D. The framing rectangle is
used by the subclasses of RectangularShape to define
their geometry.
Parameters:
- r - the specified Rectangle2D
Since: 1.2
See Also: RectangularShape.getFrame(),

public void setFrameFromCenter (double centerX, double centerY, double cornerX, double cornerY) [Inherited From RectangularShape]

Sets the framing rectangle of this Shape based on the specified center point coordinates and corner point coordinates.

Sets the framing rectangle of this Shape
based on the specified center point coordinates and corner point
coordinates. The framing rectangle is used by the subclasses of
RectangularShape to define their geometry.
Parameters:
- centerX - the X coordinate of the specified center point
- centerY - the Y coordinate of the specified center point
- cornerX - the X coordinate of the specified corner point
- cornerY - the Y coordinate of the specified corner point
Since: 1.2

public void setFrameFromCenter (Point2D center, Point2D corner) [Inherited From RectangularShape]

Sets the framing rectangle of this Shape based on a specified center Point2D and corner Point2D.

Sets the framing rectangle of this Shape based on a
specified center Point2D and corner
Point2D. The framing rectangle is used by the subclasses
of RectangularShape to define their geometry.
Parameters:
- center - the specified center Point2D
- corner - the specified corner Point2D
Since: 1.2

public void setFrameFromDiagonal (double x1, double y1, double x2, double y2) [Inherited From RectangularShape]

Sets the diagonal of the framing rectangle of this Shape based on the two specified coordinates.

Sets the diagonal of the framing rectangle of this Shape
based on the two specified coordinates. The framing rectangle is
used by the subclasses of RectangularShape to define
their geometry.
Parameters:
- x1 - the X coordinate of the start point of the specified diagonal
- y1 - the Y coordinate of the start point of the specified diagonal
- x2 - the X coordinate of the end point of the specified diagonal
- y2 - the Y coordinate of the end point of the specified diagonal
Since: 1.2

public void setFrameFromDiagonal (Point2D p1, Point2D p2) [Inherited From RectangularShape]

Sets the diagonal of the framing rectangle of this Shape based on two specified Point2D objects.

Sets the diagonal of the framing rectangle of this Shape
based on two specified Point2D objects. The framing
rectangle is used by the subclasses of RectangularShape
to define their geometry.
Parameters:
- p1 - the start Point2D of the specified diagonal
- p2 - the end Point2D of the specified diagonal
Since: 1.2

publicabstract void setRect (double x, double y, double w, double h)

Sets the location and size of this Rectangle2D to the specified double values.

Sets the location and size of this Rectangle2D
to the specified double values.
Parameters:
- x - the X coordinate of the upper-left corner of this Rectangle2D
- y - the Y coordinate of the upper-left corner of this Rectangle2D
- w - the width of this Rectangle2D
- h - the height of this Rectangle2D
Since: 1.2

public void setRect (Rectangle2D r)

Sets this Rectangle2D to be the same as the specified Rectangle2D.

Sets this Rectangle2D to be the same as the specified
Rectangle2D.
Parameters:
- r - the specified Rectangle2D
Since: 1.2

publicstatic void union (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)

Unions the pair of source Rectangle2D objects and puts the result into the specified destination Rectangle2D object.

Unions the pair of source Rectangle2D objects
and puts the result into the specified destination
Rectangle2D object. One of the source rectangles
can also be the destination to avoid creating a third Rectangle2D
object, but in this case the original points of this source
rectangle will be overwritten by this method.
Parameters:
- src1 - the first of a pair of Rectangle2D objects to be combined with each other
- src2 - the second of a pair of Rectangle2D objects to be combined with each other
- dest - the Rectangle2D that holds the results of the union of src1 and src2
Since: 1.2