java.awt
Interface Shape

All Known Implementing Classes:
Arc2D sample code for java.awt.geom.Arc2D definition code for java.awt.geom.Arc2D , Arc2D.Double sample code for java.awt.geom.Arc2D.Double definition code for java.awt.geom.Arc2D.Double , Arc2D.Float sample code for java.awt.geom.Arc2D.Float definition code for java.awt.geom.Arc2D.Float , Area sample code for java.awt.geom.Area definition code for java.awt.geom.Area , BasicTextUI.BasicCaret sample code for javax.swing.plaf.basic.BasicTextUI.BasicCaret definition code for javax.swing.plaf.basic.BasicTextUI.BasicCaret , CubicCurve2D sample code for java.awt.geom.CubicCurve2D definition code for java.awt.geom.CubicCurve2D , CubicCurve2D.Double sample code for java.awt.geom.CubicCurve2D.Double definition code for java.awt.geom.CubicCurve2D.Double , CubicCurve2D.Float sample code for java.awt.geom.CubicCurve2D.Float definition code for java.awt.geom.CubicCurve2D.Float , DefaultCaret sample code for javax.swing.text.DefaultCaret definition code for javax.swing.text.DefaultCaret , Ellipse2D sample code for java.awt.geom.Ellipse2D definition code for java.awt.geom.Ellipse2D , Ellipse2D.Double sample code for java.awt.geom.Ellipse2D.Double definition code for java.awt.geom.Ellipse2D.Double , Ellipse2D.Float sample code for java.awt.geom.Ellipse2D.Float definition code for java.awt.geom.Ellipse2D.Float , GeneralPath sample code for java.awt.geom.GeneralPath definition code for java.awt.geom.GeneralPath , Line2D sample code for java.awt.geom.Line2D definition code for java.awt.geom.Line2D , Line2D.Double sample code for java.awt.geom.Line2D.Double definition code for java.awt.geom.Line2D.Double , Line2D.Float sample code for java.awt.geom.Line2D.Float definition code for java.awt.geom.Line2D.Float , Polygon sample code for java.awt.Polygon definition code for java.awt.Polygon , QuadCurve2D sample code for java.awt.geom.QuadCurve2D definition code for java.awt.geom.QuadCurve2D , QuadCurve2D.Double sample code for java.awt.geom.QuadCurve2D.Double definition code for java.awt.geom.QuadCurve2D.Double , QuadCurve2D.Float sample code for java.awt.geom.QuadCurve2D.Float definition code for java.awt.geom.QuadCurve2D.Float , Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle , Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D , Rectangle2D.Double sample code for java.awt.geom.Rectangle2D.Double definition code for java.awt.geom.Rectangle2D.Double , Rectangle2D.Float sample code for java.awt.geom.Rectangle2D.Float definition code for java.awt.geom.Rectangle2D.Float , RectangularShape sample code for java.awt.geom.RectangularShape definition code for java.awt.geom.RectangularShape , RoundRectangle2D sample code for java.awt.geom.RoundRectangle2D definition code for java.awt.geom.RoundRectangle2D , RoundRectangle2D.Double sample code for java.awt.geom.RoundRectangle2D.Double definition code for java.awt.geom.RoundRectangle2D.Double , RoundRectangle2D.Float sample code for java.awt.geom.RoundRectangle2D.Float definition code for java.awt.geom.RoundRectangle2D.Float

public interface Shape

The Shape interface provides definitions for objects that represent some form of geometric shape. The Shape is described by a PathIterator sample code for java.awt.geom.PathIterator definition code for java.awt.geom.PathIterator object, which can express the outline of the Shape as well as a rule for determining how the outline divides the 2D plane into interior and exterior points. Each Shape object provides callbacks to get the bounding box of the geometry, determine whether points or rectangles lie partly or entirely within the interior of the Shape, and retrieve a PathIterator object that describes the trajectory path of the Shape outline.

Definition of insideness: A point is considered to lie inside a Shape if and only if:

The contains and intersects methods consider the interior of a Shape to 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.

See Also:
PathIterator sample code for java.awt.geom.PathIterator definition code for java.awt.geom.PathIterator , AffineTransform sample code for java.awt.geom.AffineTransform definition code for java.awt.geom.AffineTransform , FlatteningPathIterator sample code for java.awt.geom.FlatteningPathIterator definition code for java.awt.geom.FlatteningPathIterator , GeneralPath sample code for java.awt.geom.GeneralPath definition code for java.awt.geom.GeneralPath

Method Summary
 boolean contains sample code for java.awt.Shape.contains(double, double) definition code for java.awt.Shape.contains(double, double) (double x, double y)
          Tests if the specified coordinates are inside the boundary of the Shape.
 boolean contains sample code for java.awt.Shape.contains(double, double, double, double) definition code for java.awt.Shape.contains(double, double, double, double) (double x, double y, double w, double h)
          Tests if the interior of the Shape entirely contains the specified rectangular area.
 boolean contains sample code for java.awt.Shape.contains(java.awt.geom.Point2D) definition code for java.awt.Shape.contains(java.awt.geom.Point2D) (Point2D sample code for java.awt.geom.Point2D definition code for java.awt.geom.Point2D  p)
          Tests if a specified Point2D sample code for java.awt.geom.Point2D definition code for java.awt.geom.Point2D is inside the boundary of the Shape.
 boolean contains sample code for java.awt.Shape.contains(java.awt.geom.Rectangle2D) definition code for java.awt.Shape.contains(java.awt.geom.Rectangle2D) (Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  r)
          Tests if the interior of the Shape entirely contains the specified Rectangle2D.
 Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle getBounds sample code for java.awt.Shape.getBounds() definition code for java.awt.Shape.getBounds() ()
          Returns an integer Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle that completely encloses the Shape.
 Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D getBounds2D sample code for java.awt.Shape.getBounds2D() definition code for java.awt.Shape.getBounds2D() ()
          Returns a high precision and more accurate bounding box of the Shape than the getBounds method.
 PathIterator sample code for java.awt.geom.PathIterator definition code for java.awt.geom.PathIterator getPathIterator sample code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform) definition code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform) (AffineTransform sample code for java.awt.geom.AffineTransform definition code for java.awt.geom.AffineTransform  at)
          Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline.
 PathIterator sample code for java.awt.geom.PathIterator definition code for java.awt.geom.PathIterator getPathIterator sample code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform, double) definition code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform, double) (AffineTransform sample code for java.awt.geom.AffineTransform definition code for java.awt.geom.AffineTransform  at, double flatness)
          Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.
 boolean intersects sample code for java.awt.Shape.intersects(double, double, double, double) definition code for java.awt.Shape.intersects(double, double, double, double) (double x, double y, double w, double h)
          Tests if the interior of the Shape intersects the interior of a specified rectangular area.
 boolean intersects sample code for java.awt.Shape.intersects(java.awt.geom.Rectangle2D) definition code for java.awt.Shape.intersects(java.awt.geom.Rectangle2D) (Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  r)
          Tests if the interior of the Shape intersects the interior of a specified Rectangle2D.
 

Method Detail

getBounds sample code for java.awt.Shape.getBounds() definition code for java.awt.Shape.getBounds()

Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  getBounds()
Returns an integer Rectangle sample code for java.awt.Rectangle definition code for java.awt.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.

Returns:
an integer Rectangle that completely encloses the Shape.
See Also:
getBounds2D() sample code for java.awt.Shape.getBounds2D() definition code for java.awt.Shape.getBounds2D()

getBounds2D sample code for java.awt.Shape.getBounds2D() definition code for java.awt.Shape.getBounds2D()

Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  getBounds2D()
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 sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.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.

Returns:
an instance of Rectangle2D that is a high-precision bounding box of the Shape.
See Also:
getBounds() sample code for java.awt.Shape.getBounds() definition code for java.awt.Shape.getBounds()

contains sample code for java.awt.Shape.contains(double, double) definition code for java.awt.Shape.contains(double, double)

boolean contains(double x,
                 double y)
Tests if the specified coordinates are inside the boundary of the Shape.

Parameters:
x - the specified x coordinate
y - the specified y coordinate
Returns:
true if the specified coordinates are inside the Shape boundary; false otherwise.

contains sample code for java.awt.Shape.contains(java.awt.geom.Point2D) definition code for java.awt.Shape.contains(java.awt.geom.Point2D)

boolean contains(Point2D sample code for java.awt.geom.Point2D definition code for java.awt.geom.Point2D  p)
Tests if a specified Point2D sample code for java.awt.geom.Point2D definition code for java.awt.geom.Point2D is inside the boundary of the Shape.

Parameters:
p - a specified Point2D
Returns:
true if the specified Point2D is inside the boundary of the Shape; false otherwise.

intersects sample code for java.awt.Shape.intersects(double, double, double, double) definition code for java.awt.Shape.intersects(double, double, double, double)

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. 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.

This method might conservatively return true when:

This means that this method might return true even though the rectangular area does not intersect the Shape. The Area sample code for java.awt.geom.Area definition code for java.awt.geom.Area class can be used to perform more accurate computations of geometric intersection for any Shape object if a more precise answer is required.

Parameters:
x - the x coordinate of the specified rectangular area
y - the y coordinate 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 the Shape 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.
See Also:
Area sample code for java.awt.geom.Area definition code for java.awt.geom.Area

intersects sample code for java.awt.Shape.intersects(java.awt.geom.Rectangle2D) definition code for java.awt.Shape.intersects(java.awt.geom.Rectangle2D)

boolean intersects(Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  r)
Tests if the interior of the Shape intersects the interior of a specified Rectangle2D. This method might conservatively return true when: This means that this method might return true even though the Rectangle2D does not intersect the Shape.

Parameters:
r - the specified Rectangle2D
Returns:
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.
See Also:
intersects(double, double, double, double) sample code for java.awt.Shape.intersects(double, double, double, double) definition code for java.awt.Shape.intersects(double, double, double, double)

contains sample code for java.awt.Shape.contains(double, double, double, double) definition code for java.awt.Shape.contains(double, double, double, double)

boolean contains(double x,
                 double y,
                 double w,
                 double h)
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.

This method might conservatively return false when:

This means that this method might return false even though the Shape contains the rectangular area. The Area class can be used to perform more accurate computations of geometric intersection for any Shape object if a more precise answer is required.

Parameters:
x - the x coordinate of the specified rectangular area
y - the y coordinate 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 the Shape entirely contains the specified rectangular area; false otherwise or, if the Shape contains the rectangular area and the intersects method returns true and the containment calculations would be too expensive to perform.
See Also:
Area sample code for java.awt.geom.Area definition code for java.awt.geom.Area , intersects(double, double, double, double) sample code for java.awt.Shape.intersects(double, double, double, double) definition code for java.awt.Shape.intersects(double, double, double, double)

contains sample code for java.awt.Shape.contains(java.awt.geom.Rectangle2D) definition code for java.awt.Shape.contains(java.awt.geom.Rectangle2D)

boolean contains(Rectangle2D sample code for java.awt.geom.Rectangle2D definition code for java.awt.geom.Rectangle2D  r)
Tests if the interior of the Shape entirely contains the specified Rectangle2D. This method might conservatively return false when: This means that this method might return false even though the Shape contains the Rectangle2D. The Area class can be used to perform more accurate computations of geometric intersection for any Shape object if a more precise answer is required.

Parameters:
r - The specified Rectangle2D
Returns:
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.
See Also:
contains(double, double, double, double) sample code for java.awt.Shape.contains(double, double, double, double) definition code for java.awt.Shape.contains(double, double, double, double)

getPathIterator sample code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform) definition code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform)

PathIterator sample code for java.awt.geom.PathIterator definition code for java.awt.geom.PathIterator  getPathIterator(AffineTransform sample code for java.awt.geom.AffineTransform definition code for java.awt.geom.AffineTransform  at)
Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline. If an optional AffineTransform sample code for java.awt.geom.AffineTransform definition code for java.awt.geom.AffineTransform is specified, the coordinates returned in the iteration are transformed accordingly.

Each call to this method returns a fresh PathIterator object that traverses the geometry of the Shape object independently from any other PathIterator objects in use at the same time.

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

Before using a particular implementation of the Shape interface in more than one thread simultaneously, refer to its documentation to verify that it guarantees that iterations are isolated from modifications.

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
Returns:
a new PathIterator object, which independently traverses the geometry of the Shape.

getPathIterator sample code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform, double) definition code for java.awt.Shape.getPathIterator(java.awt.geom.AffineTransform, double)

PathIterator sample code for java.awt.geom.PathIterator definition code for java.awt.geom.PathIterator  getPathIterator(AffineTransform sample code for java.awt.geom.AffineTransform definition code for java.awt.geom.AffineTransform  at,
                             double flatness)
Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.

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

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

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. 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 PathIterator object that traverses the Shape object geometry independently from any other PathIterator objects in use at the same time.

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

Before using a particular implementation of this interface in more than one thread simultaneously, refer to its documentation to verify that it guarantees that iterations are isolated from modifications.

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
Returns:
a new PathIterator that independently traverses the Shape geometry.