GNU Classpath (0.99.1-pre) | |

Prev Class | Next Class | Frames | No Frames |

Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |

**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, Polygon, QuadCurve2D, QuadCurve2D.Double, QuadCurve2D.Float, Rectangle, Rectangle2D, Rectangle2D.Double, Rectangle2D.Float, RectangularShape, RoundRectangle2D, RoundRectangle2D.Double, RoundRectangle2D.Float

`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:**- 1.0

**See Also:**`PathIterator`

,`AffineTransform`

,`FlatteningPathIterator`

,`GeneralPath`

## Method Summary

`boolean`

`contains(double x, double y)`

- Test if the coordinates lie in the shape.

`boolean`

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

- Test if a high-precision rectangle lies completely in the shape.

`boolean`

`boolean`

`contains(Rectangle2D r)`

- Test if a high-precision rectangle lies completely in the shape.

`Rectangle`

`getBounds()`

- Returns a
`Rectange`

that bounds the shape.

`Rectangle2D`

`getBounds2D()`

- Returns a high precision bounding box of the shape.

`PathIterator`

`getPathIterator(AffineTransform transform)`

- Return an iterator along the shape boundary.

`PathIterator`

`getPathIterator(AffineTransform transform, double flatness)`

- Return an iterator along the flattened version of the shape boundary.

`boolean`

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

- Test if a high-precision rectangle intersects the shape.

`boolean`

`intersects(Rectangle2D r)`

- Test if a high-precision rectangle intersects the shape.

public boolean contains(double x, double y)

Test if the coordinates lie in the shape.

Parameters:`x`

- the x coordinate`y`

- the y coordinate

Returns:- true if (x,y) lies inside the shape

Since:- 1.2

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.

Parameters:`x`

- the x coordinate of the rectangle`y`

- the y coordinate of the rectangle`w`

- the width of the rectangle, undefined results if negative`h`

- the height of the rectangle, undefined results if negative

Returns:- true if the rectangle is contained in this shape

Since:- 1.2

See Also:`Area`

public boolean contains(Point2D p)

Test if the point lie in the shape.

Parameters:`p`

- the high-precision point

Returns:- true if p lies inside the shape

Throws:`NullPointerException`

- if p is null

Since:- 1.2

public boolean contains(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.

Parameters:`r`

- the rectangle

Returns:- true if the rectangle is contained in this shape

Throws:`NullPointerException`

- if r is null

Since:- 1.2

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:- the shape's bounding box

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.

Returns:- the shape's bounding box

Since:- 1.2

See Also:`getBounds()`

public PathIterator getPathIterator(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.

Parameters:`transform`

- an optional transform to apply to the iterator (`null`

permitted).

Returns:- a new iterator over the boundary

Since:- 1.2

public PathIterator getPathIterator(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 parameter 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.

Parameters:`transform`

- an optional transform to apply to the iterator (`null`

permitted).`flatness`

- the maximum distance for deviation from the real boundary

Returns:- a new iterator over the boundary

Since:- 1.2

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.

Parameters:`x`

- the x coordinate of the rectangle`y`

- the y coordinate of the rectangle`w`

- the width of the rectangle, undefined results if negative`h`

- the height of the rectangle, undefined results if negative

Returns:- true if the rectangle intersects this shape

Since:- 1.2

See Also:`Area`

public boolean intersects(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.

Parameters:`r`

- the rectangle

Returns:- true if the rectangle intersects this shape

Throws:`NullPointerException`

- if r is null

Since:- 1.2

Shape.java -- the classic Object-Oriented shape interface
Copyright (C) 1999, 2002, 2005, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.

GNU Classpath (0.99.1-pre) |