Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt

Interface Shape

java.lang.Object
|
+--java.awt.Shape


public interface Shape

This interface represents an abstract shape. The shape is described by a PathIterator, and has callbacks for determining bounding box, where points and rectangles lie in relation to the shape, and tracing the trajectory.

A point is inside if it is completely inside, or on the boundary and adjacent points in the increasing x or y direction are completely inside. Unclosed shapes are considered as implicitly closed when performing contains or intersects.

Since:Author:See Also:

Method Summary

booleancontains(double x, double y)

Test if the coordinates lie in the shape.
booleancontains(java.awt.geom.Point2D p)

Test if the point lie in the shape.
booleancontains(double x, double y, double w, double h)

Test if a high-precision rectangle lies completely in the shape.
booleancontains(java.awt.geom.Rectangle2D r)

Test if a high-precision rectangle lies completely in the shape.
java.awt.RectanglegetBounds()

Returns a Rectange that bounds the shape.
java.awt.geom.Rectangle2DgetBounds2D()

Returns a high precision bounding box of the shape.
java.awt.geom.PathIteratorgetPathIterator(java.awt.geom.AffineTransform transform)

Return an iterator along the shape boundary.
java.awt.geom.PathIteratorgetPathIterator(java.awt.geom.AffineTransform transform, double flatness)

Return an iterator along the flattened version of the shape boundary.
booleanintersects(double x, double y, double w, double h)

Test if a high-precision rectangle intersects the shape.
booleanintersects(java.awt.geom.Rectangle2D r)

Test if a high-precision rectangle intersects the shape.

Method Details

contains

public boolean contains(double x, double y)

Test if the coordinates lie in the shape.

Since:Parameters:

Returns:


contains

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

Test if a high-precision rectangle lies completely in the shape. This is true if all points in the rectangle are in the shape, with the caveat that the operation may include high probability estimates when the actual calculation is prohibitively expensive. The Area class can be used for more precise answers.

Since:Parameters:

Returns:

See Also:


contains

public boolean contains(java.awt.geom.Point2D p)

Test if the point lie in the shape.

Since:Parameters:

Returns:

Throws:


contains

public boolean contains(java.awt.geom.Rectangle2D r)

Test if a high-precision rectangle lies completely in the shape. This is true if all points in the rectangle are in the shape, with the caveat that the operation may include high probability estimates when the actual calculation is prohibitively expensive. The Area class can be used for more precise answers.

Since:Parameters:

Returns:

Throws:

See Also:


getBounds

public Rectangle getBounds()

Returns a Rectange that bounds the shape. There is no guarantee that this is the minimum bounding box, particularly if the shape overflows the finite integer range of a bound. Generally, getBounds2D returns a tighter bound.

Returns:

See Also:


getBounds2D

public Rectangle2D getBounds2D()

Returns a high precision bounding box of the shape. There is no guarantee that this is the minimum bounding box, but at least it never overflows.

Since:Returns:

See Also:


getPathIterator

public PathIterator getPathIterator(java.awt.geom.AffineTransform transform)

Return an iterator along the shape boundary. If the optional transform is provided, the iterator is transformed accordingly. Each call returns a new object, independent from others in use. It is recommended, but not required, that the Shape isolate iterations from future changes to the boundary, and document this fact.

Since:Parameters:

Returns:


getPathIterator

public PathIterator getPathIterator(java.awt.geom.AffineTransform transform, double flatness)

Return an iterator along the flattened version of the shape boundary. Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE points are returned in the iterator. The flatness paramter controls how far points are allowed to differ from the real curve; although a limit on accuracy may cause this parameter to be enlarged if needed.

If the optional transform is provided, the iterator is transformed accordingly. Each call returns a new object, independent from others in use. It is recommended, but not required, that the Shape isolate iterations from future changes to the boundary, and document this fact.

Since:Parameters:

Returns:


intersects

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

Test if a high-precision rectangle intersects the shape. This is true if any point in the rectangle is in the shape, with the caveat that the operation may include high probability estimates when the actual calculation is prohibitively expensive. The Area class can be used for more precise answers.

Since:Parameters:

Returns:

See Also:


intersects

public boolean intersects(java.awt.geom.Rectangle2D r)

Test if a high-precision rectangle intersects the shape. This is true if any point in the rectangle is in the shape, with the caveat that the operation may include high probability estimates when the actual calculation is prohibitively expensive. The Area class can be used for more precise answers.

Since:Parameters:

Returns:

Throws:

See Also: