-
- All Known Implementing Classes:
Arc2D,Arc2D.Double,Arc2D.Float,Area,BasicTextUI.BasicCaret,CubicCurve2D,CubicCurve2D.Double,CubicCurve2D.Float,DefaultCaret,Ellipse2D,Ellipse2D.Double,Ellipse2D.Float,GeneralPath,Line2D,Line2D.Double,Line2D.Float,Path2D,Path2D.Double,Path2D.Float,Polygon,QuadCurve2D,QuadCurve2D.Double,QuadCurve2D.Float,Rectangle,Rectangle2D,Rectangle2D.Double,Rectangle2D.Float,RectangularShape,RoundRectangle2D,RoundRectangle2D.Double,RoundRectangle2D.Float
public interface ShapeTheShapeinterface provides definitions for objects that represent some form of geometric shape. TheShapeis described by aPathIteratorobject, which can express the outline of theShapeas well as a rule for determining how the outline divides the 2D plane into interior and exterior points. EachShapeobject provides callbacks to get the bounding box of the geometry, determine whether points or rectangles lie partly or entirely within the interior of theShape, and retrieve aPathIteratorobject that describes the trajectory path of theShapeoutline.Definition of insideness: A point is considered to lie inside a
Shapeif and only if:- it lies completely
inside the
Shapeboundary or -
it lies exactly on the
Shapeboundary and the space immediately adjacent to the point in the increasingXdirection is entirely inside the boundary or -
it lies exactly on a horizontal boundary segment and the
space immediately adjacent to the point in the
increasing
Ydirection is inside the boundary.
The
containsandintersectsmethods consider the interior of aShapeto be the area it encloses as if it were filled. This means that these methods consider unclosed shapes to be implicitly closed for the purpose of determining if a shape contains or intersects a rectangle or if a shape contains a point.- Since:
- 1.2
- See Also:
PathIterator,AffineTransform,FlatteningPathIterator,GeneralPath
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancontains(double x, double y)Tests if the specified coordinates are inside the boundary of theShape, as described by the definition of insideness.booleancontains(double x, double y, double w, double h)Tests if the interior of theShapeentirely contains the specified rectangular area.booleancontains(Point2D p)Tests if a specifiedPoint2Dis inside the boundary of theShape, as described by the definition of insideness.booleancontains(Rectangle2D r)Tests if the interior of theShapeentirely contains the specifiedRectangle2D.RectanglegetBounds()Returns an integerRectanglethat completely encloses theShape.Rectangle2DgetBounds2D()Returns a high precision and more accurate bounding box of theShapethan thegetBoundsmethod.PathIteratorgetPathIterator(AffineTransform at)Returns an iterator object that iterates along theShapeboundary and provides access to the geometry of theShapeoutline.PathIteratorgetPathIterator(AffineTransform at, double flatness)Returns an iterator object that iterates along theShapeboundary and provides access to a flattened view of theShapeoutline geometry.booleanintersects(double x, double y, double w, double h)Tests if the interior of theShapeintersects the interior of a specified rectangular area.booleanintersects(Rectangle2D r)Tests if the interior of theShapeintersects the interior of a specifiedRectangle2D.
-
-
-
Method Detail
-
getBounds
Rectangle getBounds()
Returns an integerRectanglethat completely encloses theShape. Note that there is no guarantee that the returnedRectangleis the smallest bounding box that encloses theShape, only that theShapelies entirely within the indicatedRectangle. The returnedRectanglemight also fail to completely enclose theShapeif theShapeoverflows the limited range of the integer data type. ThegetBounds2Dmethod 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
shapemay not be considered contained in the returnedboundsobject, but only in cases where those points are also not considered contained in the originalshape.If a
pointis inside theshapeaccording to thecontains(point)method, then it must be inside the returnedRectanglebounds object according to thecontains(point)method of thebounds. Specifically:shape.contains(x,y)requiresbounds.contains(x,y)If a
pointis not inside theshape, then it might still be contained in theboundsobject:bounds.contains(x,y)does not implyshape.contains(x,y)- Returns:
- an integer
Rectanglethat completely encloses theShape. - Since:
- 1.2
- See Also:
getBounds2D()
-
getBounds2D
Rectangle2D getBounds2D()
Returns a high precision and more accurate bounding box of theShapethan thegetBoundsmethod. Note that there is no guarantee that the returnedRectangle2Dis the smallest bounding box that encloses theShape, only that theShapelies entirely within the indicatedRectangle2D. The bounding box returned by this method is usually tighter than that returned by thegetBoundsmethod and never fails due to overflow problems since the return value can be an instance of theRectangle2Dthat uses double precision values to store the dimensions.Note that the definition of insideness can lead to situations where points on the defining outline of the
shapemay not be considered contained in the returnedboundsobject, but only in cases where those points are also not considered contained in the originalshape.If a
pointis inside theshapeaccording to thecontains(point)method, then it must be inside the returnedRectangle2Dbounds object according to thecontains(point)method of thebounds. Specifically:shape.contains(p)requiresbounds.contains(p)If a
pointis not inside theshape, then it might still be contained in theboundsobject:bounds.contains(p)does not implyshape.contains(p)- Returns:
- an instance of
Rectangle2Dthat is a high-precision bounding box of theShape. - Since:
- 1.2
- See Also:
getBounds()
-
contains
boolean contains(double x, double y)Tests if the specified coordinates are inside the boundary of theShape, as described by the definition of insideness.- Parameters:
x- the specified X coordinate to be testedy- the specified Y coordinate to be tested- Returns:
trueif the specified coordinates are inside theShapeboundary;falseotherwise.- Since:
- 1.2
-
contains
boolean contains(Point2D p)
Tests if a specifiedPoint2Dis inside the boundary of theShape, as described by the definition of insideness.- Parameters:
p- the specifiedPoint2Dto be tested- Returns:
trueif the specifiedPoint2Dis inside the boundary of theShape;falseotherwise.- Since:
- 1.2
-
intersects
boolean intersects(double x, double y, double w, double h)Tests if the interior of theShapeintersects the interior of a specified rectangular area. The rectangular area is considered to intersect theShapeif any point is contained in both the interior of theShapeand the specified rectangular area.The
Shape.intersects()method allows aShapeimplementation to conservatively returntruewhen:-
there is a high probability that the rectangular area and the
Shapeintersect, but - the calculations to accurately determine this intersection are prohibitively expensive.
Shapesthis method might returntrueeven though the rectangular area does not intersect theShape. TheAreaclass performs more accurate computations of geometric intersection than mostShapeobjects and therefore can be used if a more precise answer is required.- Parameters:
x- the X coordinate of the upper-left corner of the specified rectangular areay- the Y coordinate of the upper-left corner of the specified rectangular areaw- the width of the specified rectangular areah- the height of the specified rectangular area- Returns:
trueif the interior of theShapeand the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform;falseotherwise.- Since:
- 1.2
- See Also:
Area
-
there is a high probability that the rectangular area and the
-
intersects
boolean intersects(Rectangle2D r)
Tests if the interior of theShapeintersects the interior of a specifiedRectangle2D. TheShape.intersects()method allows aShapeimplementation to conservatively returntruewhen:-
there is a high probability that the
Rectangle2Dand theShapeintersect, but - the calculations to accurately determine this intersection are prohibitively expensive.
Shapesthis method might returntrueeven though theRectangle2Ddoes not intersect theShape. TheAreaclass performs more accurate computations of geometric intersection than mostShapeobjects and therefore can be used if a more precise answer is required.- Parameters:
r- the specifiedRectangle2D- Returns:
trueif the interior of theShapeand the interior of the specifiedRectangle2Dintersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform;falseotherwise.- Since:
- 1.2
- See Also:
intersects(double, double, double, double)
-
there is a high probability that the
-
contains
boolean contains(double x, double y, double w, double h)Tests if the interior of theShapeentirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within theShapefor the entire rectangular area to be considered contained within theShape.The
Shape.contains()method allows aShapeimplementation to conservatively returnfalsewhen:-
the
intersectmethod returnstrueand -
the calculations to determine whether or not the
Shapeentirely contains the rectangular area are prohibitively expensive.
Shapesthis method might returnfalseeven though theShapecontains the rectangular area. TheAreaclass performs more accurate geometric computations than mostShapeobjects and therefore can be used if a more precise answer is required.- Parameters:
x- the X coordinate of the upper-left corner of the specified rectangular areay- the Y coordinate of the upper-left corner of the specified rectangular areaw- the width of the specified rectangular areah- the height of the specified rectangular area- Returns:
trueif the interior of theShapeentirely contains the specified rectangular area;falseotherwise or, if theShapecontains the rectangular area and theintersectsmethod returnstrueand the containment calculations would be too expensive to perform.- Since:
- 1.2
- See Also:
Area,intersects(double, double, double, double)
-
the
-
contains
boolean contains(Rectangle2D r)
Tests if the interior of theShapeentirely contains the specifiedRectangle2D. TheShape.contains()method allows aShapeimplementation to conservatively returnfalsewhen:-
the
intersectmethod returnstrueand -
the calculations to determine whether or not the
Shapeentirely contains theRectangle2Dare prohibitively expensive.
Shapesthis method might returnfalseeven though theShapecontains theRectangle2D. TheAreaclass performs more accurate geometric computations than mostShapeobjects and therefore can be used if a more precise answer is required.- Parameters:
r- The specifiedRectangle2D- Returns:
trueif the interior of theShapeentirely contains theRectangle2D;falseotherwise or, if theShapecontains theRectangle2Dand theintersectsmethod returnstrueand the containment calculations would be too expensive to perform.- Since:
- 1.2
- See Also:
contains(double, double, double, double)
-
the
-
getPathIterator
PathIterator getPathIterator(AffineTransform at)
Returns an iterator object that iterates along theShapeboundary and provides access to the geometry of theShapeoutline. If an optionalAffineTransformis specified, the coordinates returned in the iteration are transformed accordingly.Each call to this method returns a fresh
PathIteratorobject that traverses the geometry of theShapeobject independently from any otherPathIteratorobjects in use at the same time.It is recommended, but not guaranteed, that objects implementing the
Shapeinterface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.- Parameters:
at- an optionalAffineTransformto be applied to the coordinates as they are returned in the iteration, ornullif untransformed coordinates are desired- Returns:
- a new
PathIteratorobject, which independently traverses the geometry of theShape. - Since:
- 1.2
-
getPathIterator
PathIterator getPathIterator(AffineTransform at, double flatness)
Returns an iterator object that iterates along theShapeboundary and provides access to a flattened view of theShapeoutline geometry.Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator.
If an optional
AffineTransformis specified, the coordinates returned in the iteration are transformed accordingly.The amount of subdivision of the curved segments is controlled by the
flatnessparameter, which specifies the maximum distance that any point on the unflattened transformed curve can deviate from the returned flattened path segments. Note that a limit on the accuracy of the flattened path might be silently imposed, causing very small flattening parameters to be treated as larger values. This limit, if there is one, is defined by the particular implementation that is used.Each call to this method returns a fresh
PathIteratorobject that traverses theShapeobject geometry independently from any otherPathIteratorobjects in use at the same time.It is recommended, but not guaranteed, that objects implementing the
Shapeinterface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.- Parameters:
at- an optionalAffineTransformto be applied to the coordinates as they are returned in the iteration, ornullif untransformed coordinates are desiredflatness- the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve- Returns:
- a new
PathIteratorthat independently traverses a flattened view of the geometry of theShape. - Since:
- 1.2
-
-