public abstract class RectangularShape extends Object implements Shape, Cloneable
RectangularShape
is the base class for a number of Shape
objects whose geometry is defined by a rectangular frame. This class does not directly specify any specific geometry by itself, but merely provides manipulation methods inherited by a whole category of Shape
objects. The manipulation methods provided by this class can be used to query and modify the rectangular frame, which provides a reference for the subclasses to define their geometry.
protected RectangularShape()
This is an abstract class that cannot be instantiated directly.
Arc2D
, Ellipse2D
, Rectangle2D
, RoundRectangle2D
public abstract double getX()
Returns the X coordinate of the upper-left corner of the framing rectangle in double
precision.
public abstract double getY()
Returns the Y coordinate of the upper-left corner of the framing rectangle in double
precision.
public abstract double getWidth()
Returns the width of the framing rectangle in double
precision.
public abstract double getHeight()
Returns the height of the framing rectangle in double
precision.
public double getMinX()
Returns the smallest X coordinate of the framing rectangle of the Shape
in double
precision.
Shape
.public double getMinY()
Returns the smallest Y coordinate of the framing rectangle of the Shape
in double
precision.
Shape
.public double getMaxX()
Returns the largest X coordinate of the framing rectangle of the Shape
in double
precision.
Shape
.public double getMaxY()
Returns the largest Y coordinate of the framing rectangle of the Shape
in double
precision.
Shape
.public double getCenterX()
Returns the X coordinate of the center of the framing rectangle of the Shape
in double
precision.
Shape
.public double getCenterY()
Returns the Y coordinate of the center of the framing rectangle of the Shape
in double
precision.
Shape
.public Rectangle2D getFrame()
Returns the framing Rectangle2D
that defines the overall shape of this object.
Rectangle2D
, specified in double
coordinates.setFrame(double, double, double, double)
, setFrame(Point2D, Dimension2D)
, setFrame(Rectangle2D)
public abstract boolean isEmpty()
Determines whether the RectangularShape
is empty. When the RectangularShape
is empty, it encloses no area.
true
if the RectangularShape
is empty; false
otherwise.public abstract void setFrame(double x, double y, double w, double h)
Sets the location and size of the framing rectangle of this Shape
to the specified rectangular values.
x
- the X coordinate of the upper-left corner of the specified rectangular shapey
- the Y coordinate of the upper-left corner of the specified rectangular shapew
- the width of the specified rectangular shapeh
- the height of the specified rectangular shapegetFrame()
public void setFrame(Point2D loc, Dimension2D size)
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.
loc
- the specified Point2D
size
- the specified Dimension2D
getFrame()
public void setFrame(Rectangle2D r)
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.
r
- the specified Rectangle2D
getFrame()
public void setFrameFromDiagonal(double x1, double y1, double x2, double y2)
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.
x1
- the X coordinate of the start point of the specified diagonaly1
- the Y coordinate of the start point of the specified diagonalx2
- the X coordinate of the end point of the specified diagonaly2
- the Y coordinate of the end point of the specified diagonalpublic void setFrameFromDiagonal(Point2D p1, Point2D p2)
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.
p1
- the start Point2D
of the specified diagonalp2
- the end Point2D
of the specified diagonalpublic void setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY)
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.
centerX
- the X coordinate of the specified center pointcenterY
- the Y coordinate of the specified center pointcornerX
- the X coordinate of the specified corner pointcornerY
- the Y coordinate of the specified corner pointpublic void setFrameFromCenter(Point2D center, Point2D corner)
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.
center
- the specified center Point2D
corner
- the specified corner Point2D
public boolean contains(Point2D p)
Tests if a specified Point2D
is inside the boundary of the Shape
, as described by the definition of insideness.
contains
in interface Shape
p
- the specified Point2D
to be testedtrue
if the specified Point2D
is inside the boundary of the Shape
; false
otherwise.public boolean intersects(Rectangle2D r)
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:
Rectangle2D
and the Shape
intersect, but 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. intersects
in interface Shape
r
- the specified Rectangle2D
true
if the interior of the Shape
and the interior of the specified Rectangle2D
intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false
otherwise.Shape.intersects(double, double, double, double)
public boolean contains(Rectangle2D r)
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:
intersect
method returns true
and Shape
entirely contains the Rectangle2D
are prohibitively expensive. 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. contains
in interface Shape
r
- The specified Rectangle2D
true
if the interior of the Shape
entirely contains the Rectangle2D
; false
otherwise or, if the Shape
contains the Rectangle2D
and the intersects
method returns true
and the containment calculations would be too expensive to perform.Shape.contains(double, double, double, double)
public Rectangle getBounds()
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.
Note that the definition of insideness can lead to situations where points on the defining outline of the shape
may not be considered contained in the returned bounds
object, but only in cases where those points are also not considered contained in the original shape
.
If a point
is inside the shape
according to the contains(point)
method, then it must be inside the returned Rectangle
bounds object according to the contains(point)
method of the bounds
. Specifically:
shape.contains(x,y)
requires bounds.contains(x,y)
If a point
is not inside the shape
, then it might still be contained in the bounds
object:
bounds.contains(x,y)
does not imply shape.contains(x,y)
getBounds
in interface Shape
Rectangle
that completely encloses the Shape
.Shape.getBounds2D()
public PathIterator getPathIterator(AffineTransform at, double flatness)
Returns an iterator object that iterates along the Shape
object's boundary and provides access to a flattened view of the outline of the Shape
object's geometry.
Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types will be returned by the iterator.
The amount of subdivision of the curved segments is controlled by the flatness
parameter, which specifies the maximum distance that any point on the unflattened transformed curve can deviate from the returned flattened path segments. An optional AffineTransform
can be specified so that the coordinates returned in the iteration are transformed accordingly.
getPathIterator
in interface Shape
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 curvePathIterator
object that provides access to the Shape
object's flattened geometry.public Object clone()
Creates a new object of the same class and with the same contents as this object.
clone
in class Object
OutOfMemoryError
- if there is not enough memory.Cloneable
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.