OpenJDK 27 · java.awt.Shape · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if the specified coordinates are inside the `Shape` boundary; `false` otherwise. contains(double the specified X coordinate to be tested x, double the specified Y coordinate to be tested y) Tests if the specified coordinates are inside the boundary of the `Shape`, as described by the definition of insideness.
public boolean	Returns: `true` if the specified `Point2D` is inside the boundary of the `Shape`; `false` otherwise. contains(Point2D the specified `Point2D` to be tested p) Tests if a specified `Point2D` is inside the boundary of the `Shape`, as described by the definition of insideness.
public boolean	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. contains(double the X coordinate of the upper-left corner of the specified rectangular area x, double the Y coordinate of the upper-left corner of the specified rectangular area y, double the width of the specified rectangular area w, double the height of the specified rectangular area h) Tests if the interior of the `Shape` entirely contains the specified rectangular area.
public boolean	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. contains(Rectangle2D The specified `Rectangle2D` r) Tests if the interior of the `Shape` entirely contains the specified `Rectangle2D`.
public Rectangle	Returns: an integer `Rectangle` that completely encloses the `Shape`. getBounds() Returns an integer `Rectangle` that completely encloses the `Shape`.
public Rectangle2D	Returns: an instance of `Rectangle2D` that is a high-precision bounding box of the `Shape`. getBounds2D() Returns a high precision and more accurate bounding box of the `Shape` than the `getBounds` method.
public PathIterator	Returns: a new `PathIterator` object, which independently traverses the geometry of the `Shape`. getPathIterator(AffineTransform an optional `AffineTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired at) Returns an iterator object that iterates along the `Shape` boundary and provides access to the geometry of the `Shape` outline.
public PathIterator	Returns: a new `PathIterator` that independently traverses a flattened view of the geometry of the `Shape`. getPathIterator(AffineTransform an optional `AffineTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired at, double the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve flatness) Returns an iterator object that iterates along the `Shape` boundary and provides access to a flattened view of the `Shape` outline geometry.
public boolean	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. intersects(double the X coordinate of the upper-left corner of the specified rectangular area x, double the Y coordinate of the upper-left corner of the specified rectangular area y, double the width of the specified rectangular area w, double the height of the specified rectangular area h) Tests if the interior of the `Shape` intersects the interior of a specified rectangular area.
public boolean	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. intersects(Rectangle2D the specified `Rectangle2D` r) Tests if the interior of the `Shape` intersects the interior of a specified `Rectangle2D`.

Method Detail

contains back to summary

contains	back to summary
public boolean contains(double x, double y) Tests if the specified coordinates are inside the boundary of the `Shape`, as described by the definition of insideness. Parameters x:double the specified X coordinate to be tested y:double the specified Y coordinate to be tested Returns:boolean `true` if the specified coordinates are inside the `Shape` boundary; `false` otherwise. Since 1.2

public boolean contains(double x, double y)

Tests if the specified coordinates are inside the boundary of the Shape, as described by the definition of insideness.

Parameters

x:double: the specified X coordinate to be tested
y:double: the specified Y coordinate to be tested

Returns:boolean

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

Since

1.2

contains back to summary

contains	back to summary
public boolean contains(Point2D p) Tests if a specified `Point2D` is inside the boundary of the `Shape`, as described by the definition of insideness. Parameters p:Point2D the specified `Point2D` to be tested Returns:boolean `true` if the specified `Point2D` is inside the boundary of the `Shape`; `false` otherwise. Since 1.2

public boolean contains(Point2D p)

Tests if a specified Point2D is inside the boundary of the Shape, as described by the definition of insideness.

Parameters

p:Point2D: the specified Point2D to be tested

Returns:boolean

true if the specified Point2D is inside the boundary of the Shape; false otherwise.

Since

1.2

contains back to summary

contains	back to summary
public 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 rectangular area to be considered contained within the `Shape`. The `Shape.contains()` method allows a `Shape` implementation to conservatively return `false` when: the `intersect` method returns `true` and the calculations to determine whether or not the `Shape` entirely contains the rectangular area are prohibitively expensive. This means that for some `Shapes` this method might return `false` even though the `Shape` contains the rectangular area. The `Area` class performs more accurate geometric computations than most `Shape` objects and therefore can be used if a more precise answer is required. Parameters x:double the X coordinate of the upper-left corner of the specified rectangular area y:double the Y coordinate of the upper-left corner of the specified rectangular area w:double the width of the specified rectangular area h:double the height of the specified rectangular area Returns:boolean `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. Since 1.2 See Also `java.awt.geom.Area`, `intersects`

public 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 rectangular area to be considered contained within the Shape.

The Shape.contains() method allows a Shape implementation to conservatively return false when:

the intersect method returns true and
the calculations to determine whether or not the Shape entirely contains the rectangular area are prohibitively expensive.

This means that for some Shapes this method might return false even though the Shape contains the rectangular area. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.

Parameters

x:double: the X coordinate of the upper-left corner of the specified rectangular area
y:double: the Y coordinate of the upper-left corner of the specified rectangular area
w:double: the width of the specified rectangular area
h:double: the height of the specified rectangular area

Returns:boolean

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.

Since

1.2

See Also

java.awt.geom.Area, intersects

contains back to summary

contains	back to summary
public boolean contains(Rectangle2D r) Tests if the interior of the `Shape` entirely contains the specified `Rectangle2D`. The `Shape.contains()` method allows a `Shape` implementation to conservatively return `false` when: the `intersect` method returns `true` and the calculations to determine whether or not the `Shape` entirely contains the `Rectangle2D` are prohibitively expensive. This means that for some `Shapes` this method might return `false` even though the `Shape` contains the `Rectangle2D`. The `Area` class performs more accurate geometric computations than most `Shape` objects and therefore can be used if a more precise answer is required. Parameters r:Rectangle2D The specified `Rectangle2D` Returns:boolean `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. Since 1.2 See Also `contains(double, double, double, double)`

public boolean contains(Rectangle2D r)

Tests if the interior of the Shape entirely contains the specified Rectangle2D. The Shape.contains() method allows a Shape implementation to conservatively return false when:

the intersect method returns true and
the calculations to determine whether or not the Shape entirely contains the Rectangle2D are prohibitively expensive.

This means that for some Shapes this method might return false even though the Shape contains the Rectangle2D. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.

Parameters

r:Rectangle2D: The specified Rectangle2D

Returns:boolean

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.

Since

1.2

getBounds back to summary

getBounds	back to summary
public Rectangle getBounds() Returns an integer `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. Note that the definition of insideness can lead to situations where points on the defining outline of the `shape` may not be considered contained in the returned `bounds` object, but only in cases where those points are also not considered contained in the original `shape`. If a `point` is inside the `shape` according to the `contains(point)` method, then it must be inside the returned `Rectangle` bounds object according to the `contains(point)` method of the `bounds`. Specifically: `shape.contains(x,y)` requires `bounds.contains(x,y)` If a `point` is not inside the `shape`, then it might still be contained in the `bounds` object: `bounds.contains(x,y)` does not imply `shape.contains(x,y)` Returns:Rectangle an integer `Rectangle` that completely encloses the `Shape`. Since 1.2 See Also `getBounds2D`

public Rectangle getBounds()

Returns an integer 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.

Note that the definition of insideness can lead to situations where points on the defining outline of the shape may not be considered contained in the returned bounds object, but only in cases where those points are also not considered contained in the original shape.

If a point is inside the shape according to the contains(point) method, then it must be inside the returned Rectangle bounds object according to the contains(point) method of the bounds. Specifically:

shape.contains(x,y) requires bounds.contains(x,y)

If a point is not inside the shape, then it might still be contained in the bounds object:

bounds.contains(x,y) does not imply shape.contains(x,y)

Returns:Rectangle: an integer Rectangle that completely encloses the Shape.
Since: 1.2
See Also: getBounds2D

getBounds2D back to summary

getBounds2D	back to summary
public 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` 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. Note that the definition of insideness can lead to situations where points on the defining outline of the `shape` may not be considered contained in the returned `bounds` object, but only in cases where those points are also not considered contained in the original `shape`. If a `point` is inside the `shape` according to the `contains(point)` method, then it must be inside the returned `Rectangle2D` bounds object according to the `contains(point)` method of the `bounds`. Specifically: `shape.contains(p)` requires `bounds.contains(p)` If a `point` is not inside the `shape`, then it might still be contained in the `bounds` object: `bounds.contains(p)` does not imply `shape.contains(p)` Returns:Rectangle2D an instance of `Rectangle2D` that is a high-precision bounding box of the `Shape`. Since 1.2 See Also `getBounds`

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

If a point is inside the shape according to the contains(point) method, then it must be inside the returned Rectangle2D bounds object according to the contains(point) method of the bounds. Specifically:

shape.contains(p) requires bounds.contains(p)

If a point is not inside the shape, then it might still be contained in the bounds object:

bounds.contains(p) does not imply shape.contains(p)

Returns:Rectangle2D: an instance of Rectangle2D that is a high-precision bounding box of the Shape.
Since: 1.2
See Also: getBounds

getPathIterator back to summary

getPathIterator	back to summary
public PathIterator getPathIterator(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` 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. Parameters at:AffineTransform an optional `AffineTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired Returns:PathIterator a new `PathIterator` object, which independently traverses the geometry of the `Shape`. Since 1.2

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

Parameters

at:AffineTransform: an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired

Returns:PathIterator

a new PathIterator object, which independently traverses the geometry of the Shape.

Since

1.2

getPathIterator back to summary

getPathIterator	back to summary
public PathIterator getPathIterator(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. Parameters at:AffineTransform an optional `AffineTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired flatness:double 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:PathIterator a new `PathIterator` that independently traverses a flattened view of the geometry of the `Shape`. Since 1.2

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

Parameters

at:AffineTransform: an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
flatness:double: 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:PathIterator

a new PathIterator that independently traverses a flattened view of the geometry of the Shape.

Since

1.2

intersects back to summary

intersects	back to summary
public 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. The `Shape.intersects()` method allows a `Shape` implementation to conservatively return `true` when: there is a high probability that the rectangular area and the `Shape` intersect, but the calculations to accurately determine this intersection are prohibitively expensive. This means that for some `Shapes` this method might return `true` even though the rectangular area does not intersect the `Shape`. The `Area` class performs more accurate computations of geometric intersection than most `Shape` objects and therefore can be used if a more precise answer is required. Parameters x:double the X coordinate of the upper-left corner of the specified rectangular area y:double the Y coordinate of the upper-left corner of the specified rectangular area w:double the width of the specified rectangular area h:double the height of the specified rectangular area Returns:boolean `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. Since 1.2 See Also `java.awt.geom.Area`

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

The Shape.intersects() method allows a Shape implementation to conservatively return true when:

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

This means that for some Shapes this method might return true even though the rectangular area does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.

Parameters

x:double: the X coordinate of the upper-left corner of the specified rectangular area
y:double: the Y coordinate of the upper-left corner of the specified rectangular area
w:double: the width of the specified rectangular area
h:double: the height of the specified rectangular area

Returns:boolean

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.

Since

1.2

See Also

java.awt.geom.Area

intersects back to summary

intersects	back to summary
public boolean intersects(Rectangle2D r) Tests if the interior of the `Shape` intersects the interior of a specified `Rectangle2D`. The `Shape.intersects()` method allows a `Shape` implementation to conservatively return `true` when: there is a high probability that the `Rectangle2D` and the `Shape` intersect, but the calculations to accurately determine this intersection are prohibitively expensive. This means that for some `Shapes` this method might return `true` even though the `Rectangle2D` does not intersect the `Shape`. The `Area` class performs more accurate computations of geometric intersection than most `Shape` objects and therefore can be used if a more precise answer is required. Parameters r:Rectangle2D the specified `Rectangle2D` Returns:boolean `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. Since 1.2 See Also `intersects(double, double, double, double)`

public boolean intersects(Rectangle2D r)

Tests if the interior of the Shape intersects the interior of a specified Rectangle2D. The Shape.intersects() method allows a Shape implementation to conservatively return true when:

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

This means that for some Shapes this method might return true even though the Rectangle2D does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.

Parameters

r:Rectangle2D: the specified Rectangle2D

Returns:boolean

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.

Since

1.2

public Interface Shape

Method Summary

Method Detail