Method Summary

Method Details

• getBounds

  Rectangle getBounds()

  Returns an integerRectangle that completely encloses theShape. Note that there is no guarantee that the returnedRectangle is the smallest bounding box that encloses theShape, only that theShape lies entirely within the indicatedRectangle. The returnedRectangle might also fail to completely enclose theShape if theShape overflows the limited range of the integer data type. ThegetBounds2D method generally returns a tighter bounding box due to its greater flexibility in representation.

  Note that thedefinition of insideness can lead to situations where points on the defining outline of theshape may not be considered contained in the returnedbounds object, but only in cases where those points are also not considered contained in the originalshape.

  If apoint is inside theshape according to thecontains(point) method, then it must be inside the returnedRectangle bounds object according to thecontains(point) method of thebounds. Specifically:

  shape.contains(x,y) requiresbounds.contains(x,y)

  If apoint is not inside theshape, then it might still be contained in thebounds object:

  bounds.contains(x,y) does not implyshape.contains(x,y)

  Returns:

  an integerRectangle that completely encloses theShape.

  Since:

  1.2

  See Also:

  • getBounds2D()

• getBounds2D

  Rectangle2D getBounds2D()

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

  Note that thedefinition of insideness can lead to situations where points on the defining outline of theshape may not be considered contained in the returnedbounds object, but only in cases where those points are also not considered contained in the originalshape.

  If apoint is inside theshape according to thecontains(point) method, then it must be inside the returnedRectangle2D bounds object according to thecontains(point) method of thebounds. Specifically:

  shape.contains(p) requiresbounds.contains(p)

  If apoint is not inside theshape, then it might still be contained in thebounds object:

  bounds.contains(p) does not implyshape.contains(p)

  Returns:

  an instance ofRectangle2D that 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 thedefinition of insideness.

  Parameters:

  x - the specified X coordinate to be tested

  y - the specified Y coordinate to be tested

  Returns:

  true if the specified coordinates are inside theShape boundary;false otherwise.

  Since:

  1.2

• contains

  boolean contains(Point2D p)

  Tests if a specifiedPoint2D is inside the boundary of theShape, as described by the definition of insideness.

  Parameters:

  p - the specifiedPoint2D to be tested

  Returns:

  true if the specifiedPoint2D is inside the boundary of theShape;false otherwise.

  Since:

  1.2

• intersects

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

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

  TheShape.intersects() method allows aShape implementation to conservatively returntrue when:

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

  This means that for someShapes this method might returntrue even though the rectangular area does not intersect theShape. TheArea class performs more accurate computations of geometric intersection than mostShape objects 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 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 theShape and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform;false otherwise.

  Since:

  1.2

  See Also:

  • Area

• intersects

  boolean intersects(Rectangle2D r)

  Tests if the interior of theShape intersects the interior of a specifiedRectangle2D. TheShape.intersects() method allows aShape implementation to conservatively returntrue when:

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

  This means that for someShapes this method might returntrue even though theRectangle2D does not intersect theShape. TheArea class performs more accurate computations of geometric intersection than mostShape objects and therefore can be used if a more precise answer is required.

  Parameters:

  r - the specifiedRectangle2D

  Returns:

  true if the interior of theShape and the interior of the specifiedRectangle2D intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform;false otherwise.

  Since:

  1.2

  See Also:

  • intersects(double, double, double, double)

• contains

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

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

  TheShape.contains() method allows aShape implementation to conservatively returnfalse when:

  • theintersect method returnstrue and
  • the calculations to determine whether or not theShape entirely contains the rectangular area are prohibitively expensive.

  This means that for someShapes this method might returnfalse even though theShape contains the rectangular area. TheArea class performs more accurate geometric computations than mostShape objects 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 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 theShape entirely contains the specified rectangular area;false otherwise or, if theShape contains the rectangular area and theintersects method returnstrue and the containment calculations would be too expensive to perform.

  Since:

  1.2

  See Also:

  • Area
  • intersects(double, double, double, double)

• contains

  boolean contains(Rectangle2D r)

  Tests if the interior of theShape entirely contains the specifiedRectangle2D. TheShape.contains() method allows aShape implementation to conservatively returnfalse when:

  • theintersect method returnstrue and
  • the calculations to determine whether or not theShape entirely contains theRectangle2D are prohibitively expensive.

  This means that for someShapes this method might returnfalse even though theShape contains theRectangle2D. TheArea class performs more accurate geometric computations than mostShape objects and therefore can be used if a more precise answer is required.

  Parameters:

  r - The specifiedRectangle2D

  Returns:

  true if the interior of theShape entirely contains theRectangle2D;false otherwise or, if theShape contains theRectangle2D and theintersects method returnstrue and the containment calculations would be too expensive to perform.

  Since:

  1.2

  See Also:

  • contains(double, double, double, double)

• getPathIterator

  PathIterator getPathIterator(AffineTransform at)

  Returns an iterator object that iterates along theShape boundary and provides access to the geometry of theShape outline. If an optionalAffineTransform is specified, the coordinates returned in the iteration are transformed accordingly.

  Each call to this method returns a freshPathIterator object that traverses the geometry of theShape object independently from any otherPathIterator objects in use at the same time.

  It is recommended, but not guaranteed, that objects implementing theShape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

  Parameters:

  at - an optionalAffineTransform to be applied to the coordinates as they are returned in the iteration, ornull if untransformed coordinates are desired

  Returns:

  a newPathIterator object, which independently traverses the geometry of theShape.

  Since:

  1.2

• getPathIterator

  PathIterator getPathIterator(AffineTransform at, double flatness)

  Returns an iterator object that iterates along theShape boundary and provides access to a flattened view of theShape outline geometry.

  Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator.

  If an optionalAffineTransform is specified, the coordinates returned in the iteration are transformed accordingly.

  The amount of subdivision of the curved segments is controlled by theflatness parameter, 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 freshPathIterator object that traverses theShape object geometry independently from any otherPathIterator objects in use at the same time.

  It is recommended, but not guaranteed, that objects implementing theShape interface isolate iterations that are in process from any changes that might occur to the original object's geometry during such iterations.

  Parameters:

  at - an optionalAffineTransform to be applied to the coordinates as they are returned in the iteration, ornull 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

  Returns:

  a newPathIterator that independently traverses a flattened view of the geometry of theShape.

  Since:

  1.2