OpenJDK 1.22 · java.awt.geom.Area · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Rectangle2D	cachedBounds
private Vector<Curve>	curves
private static Vector<Curve>	EmptyCurves

Access	Constructor and Description
public	Area() Default constructor which creates an empty area.
public	Area(Shape the `Shape` from which the area is constructed s) The `Area` class creates an area geometry from the specified `Shape` object.

Method Summary

Modifier and Type	Method and Description
public void	add(Area the `Area` to be added to the current shape rhs) Adds the shape of the specified `Area` to the shape of this `Area`.
public Object	Returns: Created clone object clone() Overrides java.lang.Object.clone. Returns an exact copy of this `Area` object.
public boolean	contains(double the specified X coordinate to be tested x, double the specified Y coordinate to be tested y) Implements java.awt.Shape.contains. Tests if the specified coordinates are inside the boundary of the `Shape`, as described by the definition of insideness.
public boolean	contains(Point2D the specified `Point2D` to be tested p) Implements java.awt.Shape.contains. Tests if a specified `Point2D` is inside the boundary of the `Shape`, as described by the definition of insideness.
public boolean	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) Implements java.awt.Shape.contains. Tests if the interior of the `Shape` entirely contains the specified rectangular area.
public boolean	contains(Rectangle2D The specified `Rectangle2D` r) Implements java.awt.Shape.contains. Tests if the interior of the `Shape` entirely contains the specified `Rectangle2D`.
public Area	Returns: a new `Area` object representing the transformed geometry. createTransformedArea(AffineTransform the specified `AffineTransform` used to transform the new `Area` t) Creates a new `Area` object that contains the same geometry as this `Area` transformed by the specified `AffineTransform`.
public boolean	Returns: `true` if the two geometries are equal; `false` otherwise. equals(Area the `Area` to be compared to this `Area` other) Tests whether the geometries of the two `Area` objects are equal.
public void	exclusiveOr(Area the `Area` to be exclusive ORed with this `Area`. rhs) Sets the shape of this `Area` to be the combined area of its current shape and the shape of the specified `Area`, minus their intersection.
public Rectangle	Returns: the bounding `Rectangle` for the `Area`. getBounds() Implements java.awt.Shape.getBounds. Returns a bounding `Rectangle` that completely encloses this `Area`.
public Rectangle2D	Returns: the bounding `Rectangle2D` for the `Area`. getBounds2D() Implements java.awt.Shape.getBounds2D. Returns a high precision bounding `Rectangle2D` that completely encloses this `Area`.
private Rectangle2D	getCachedBounds()
public PathIterator	Returns: the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. 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) Implements java.awt.Shape.getPathIterator. Creates a `PathIterator` for the outline of this `Area` object.
public PathIterator	Returns: the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. 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 amount that the control points for a given curve can vary from colinear before a subdivided curve is replaced by a straight line connecting the end points flatness) Implements java.awt.Shape.getPathIterator. Creates a `PathIterator` for the flattened outline of this `Area` object.
public void	intersect(Area the `Area` to be intersected with this `Area` rhs) Sets the shape of this `Area` to the intersection of its current shape and the shape of the specified `Area`.
public boolean	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) Implements java.awt.Shape.intersects. Tests if the interior of the `Shape` intersects the interior of a specified rectangular area.
public boolean	intersects(Rectangle2D the specified `Rectangle2D` r) Implements java.awt.Shape.intersects. Tests if the interior of the `Shape` intersects the interior of a specified `Rectangle2D`.
private void	invalidateBounds()
public boolean	Returns: `true` if this `Area` object represents an empty area; `false` otherwise. isEmpty() Tests whether this `Area` object encloses any area.
public boolean	Returns: `true` if the geometry of this `Area` consists entirely of line segments; `false` otherwise. isPolygonal() Tests whether this `Area` consists entirely of straight edged polygonal geometry.
public boolean	Returns: `true` if the geometry of this `Area` is rectangular in shape; `false` otherwise. isRectangular() Tests whether this `Area` is rectangular in shape.
public boolean	Returns: `true` if the `Area` is comprised of a single basic geometry; `false` otherwise. isSingular() Tests whether this `Area` is comprised of a single closed subpath.
private static Vector<Curve>	pathToCurves(PathIterator pi)
public void	reset() Removes all of the geometry from this `Area` and restores it to an empty area.
public void	subtract(Area the `Area` to be subtracted from the current shape rhs) Subtracts the shape of the specified `Area` from the shape of this `Area`.
public void	transform(AffineTransform the transformation used to transform the area t) Transforms the geometry of this `Area` using the specified `AffineTransform`.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

cachedBounds	back to summary
private Rectangle2D cachedBounds

curves	back to summary
private Vector<Curve> curves

EmptyCurves	back to summary
private static Vector<Curve> EmptyCurves

Area	back to summary
public Area() Default constructor which creates an empty area. Since 1.2

Area	back to summary
public Area(Shape s) The `Area` class creates an area geometry from the specified `Shape` object. The geometry is explicitly closed, if the `Shape` is not already closed. The fill rule (even-odd or winding) specified by the geometry of the `Shape` is used to determine the resulting enclosed area. Parameters s:Shape the `Shape` from which the area is constructed Exceptions NullPointerException: if `s` is null Since 1.2

Method Detail

add back to summary

add	back to summary
public void add(Area rhs) Adds the shape of the specified `Area` to the shape of this `Area`. The resulting shape of this `Area` will include the union of both shapes, or all areas that were contained in either this or the specified `Area`. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.add(a2); a1(before) + a2 = a1(after) ################ ################ ################ ############## ############## ################ ############ ############ ################ ########## ########## ################ ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ## Parameters rhs:Area the `Area` to be added to the current shape Exceptions NullPointerException: if `rhs` is null Since 1.2

public void add(Area rhs)

Adds the shape of the specified Area to the shape of this Area. The resulting shape of this Area will include the union of both shapes, or all areas that were contained in either this or the specified Area.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.add(a2);

       a1(before)     +         a2         =     a1(after)

    ################     ################     ################
    ##############         ##############     ################
    ############             ############     ################
    ##########                 ##########     ################
    ########                     ########     ################
    ######                         ######     ######    ######
    ####                             ####     ####        ####
    ##                                 ##     ##            ##

Parameters

rhs:Area: the Area to be added to the current shape

Exceptions

NullPointerException:: if rhs is null

Since

1.2

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Returns an exact copy of this `Area` object. Returns:Object Created clone object Since 1.2

public Object clone()

Overrides java.lang.Object.clone.

Returns an exact copy of this Area object.

Returns:Object: Created clone object
Since: 1.2

contains back to summary

contains	back to summary
public boolean contains(double x, double y) Implements java.awt.Shape.contains. Doc from java.awt.Shape.contains. 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)

Implements java.awt.Shape.contains.

Doc from java.awt.Shape.contains.

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) Implements java.awt.Shape.contains. Doc from java.awt.Shape.contains. 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)

Implements java.awt.Shape.contains.

Doc from java.awt.Shape.contains.

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) Implements java.awt.Shape.contains. Doc from java.awt.Shape.contains. 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

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

Implements java.awt.Shape.contains.

Doc from java.awt.Shape.contains.

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

contains back to summary

contains	back to summary
public boolean contains(Rectangle2D r) Implements java.awt.Shape.contains. Doc from java.awt.Shape.contains. 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

public boolean contains(Rectangle2D r)

Implements java.awt.Shape.contains.

Doc from java.awt.Shape.contains.

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

createTransformedArea back to summary

createTransformedArea	back to summary
public Area createTransformedArea(AffineTransform t) Creates a new `Area` object that contains the same geometry as this `Area` transformed by the specified `AffineTransform`. This `Area` object is unchanged. Parameters t:AffineTransform the specified `AffineTransform` used to transform the new `Area` Returns:Area a new `Area` object representing the transformed geometry. Exceptions NullPointerException: if `t` is null Since 1.2

public Area createTransformedArea(AffineTransform t)

Creates a new Area object that contains the same geometry as this Area transformed by the specified AffineTransform. This Area object is unchanged.

Parameters

t:AffineTransform: the specified AffineTransform used to transform the new Area

Returns:Area

a new Area object representing the transformed geometry.

Exceptions

NullPointerException:: if t is null

Since

1.2

equals back to summary

equals	back to summary
public boolean equals(Area other) Tests whether the geometries of the two `Area` objects are equal. This method will return false if the argument is null. Parameters other:Area the `Area` to be compared to this `Area` Returns:boolean `true` if the two geometries are equal; `false` otherwise. Since 1.2

public boolean equals(Area other)

Tests whether the geometries of the two Area objects are equal. This method will return false if the argument is null.

Parameters

other:Area: the Area to be compared to this Area

Returns:boolean

true if the two geometries are equal; false otherwise.

Since

1.2

exclusiveOr back to summary

exclusiveOr	back to summary
public void exclusiveOr(Area rhs) Sets the shape of this `Area` to be the combined area of its current shape and the shape of the specified `Area`, minus their intersection. The resulting shape of this `Area` will include only areas that were contained in either this `Area` or in the specified `Area`, but not in both. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.exclusiveOr(a2); a1(before) xor a2 = a1(after) ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ## Parameters rhs:Area the `Area` to be exclusive ORed with this `Area`. Exceptions NullPointerException: if `rhs` is null Since 1.2

public void exclusiveOr(Area rhs)

Sets the shape of this Area to be the combined area of its current shape and the shape of the specified Area, minus their intersection. The resulting shape of this Area will include only areas that were contained in either this Area or in the specified Area, but not in both.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.exclusiveOr(a2);

       a1(before)    xor        a2         =     a1(after)

    ################     ################
    ##############         ##############     ##            ##
    ############             ############     ####        ####
    ##########                 ##########     ######    ######
    ########                     ########     ################
    ######                         ######     ######    ######
    ####                             ####     ####        ####
    ##                                 ##     ##            ##

Parameters

rhs:Area: the Area to be exclusive ORed with this Area.

Exceptions

NullPointerException:: if rhs is null

Since

1.2

getBounds back to summary

getBounds	back to summary
public Rectangle getBounds() Implements java.awt.Shape.getBounds. Returns a bounding `Rectangle` that completely encloses this `Area`. The Area class will attempt to return the tightest bounding box possible for the Shape. The bounding box will not be padded to include the control points of curves in the outline of the Shape, but should tightly fit the actual geometry of the outline itself. Since the returned object represents the bounding box with integers, the bounding box can only be as tight as the nearest integer coordinates that encompass the geometry of the Shape. Returns:Rectangle the bounding `Rectangle` for the `Area`. Since 1.2

public Rectangle getBounds()

Implements java.awt.Shape.getBounds.

Returns a bounding Rectangle that completely encloses this Area.

The Area class will attempt to return the tightest bounding box possible for the Shape. The bounding box will not be padded to include the control points of curves in the outline of the Shape, but should tightly fit the actual geometry of the outline itself. Since the returned object represents the bounding box with integers, the bounding box can only be as tight as the nearest integer coordinates that encompass the geometry of the Shape.

Returns:Rectangle: the bounding Rectangle for the Area.
Since: 1.2

getBounds2D back to summary

getBounds2D	back to summary
public Rectangle2D getBounds2D() Implements java.awt.Shape.getBounds2D. Returns a high precision bounding `Rectangle2D` that completely encloses this `Area`. The Area class will attempt to return the tightest bounding box possible for the Shape. The bounding box will not be padded to include the control points of curves in the outline of the Shape, but should tightly fit the actual geometry of the outline itself. Returns:Rectangle2D the bounding `Rectangle2D` for the `Area`. Since 1.2

public Rectangle2D getBounds2D()

Implements java.awt.Shape.getBounds2D.

Returns a high precision bounding Rectangle2D that completely encloses this Area.

Returns:Rectangle2D: the bounding Rectangle2D for the Area.
Since: 1.2

getCachedBounds	back to summary
private Rectangle2D getCachedBounds()

getPathIterator back to summary

getPathIterator	back to summary
public PathIterator getPathIterator(AffineTransform at) Implements java.awt.Shape.getPathIterator. Creates a `PathIterator` for the outline of this `Area` object. This `Area` object is unchanged. 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 the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. Since 1.2

public PathIterator getPathIterator(AffineTransform at)

Implements java.awt.Shape.getPathIterator.

Creates a PathIterator for the outline of this Area object. This Area object is unchanged.

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

the PathIterator object that returns the geometry of the outline of this Area, one segment at a time.

Since

1.2

getPathIterator back to summary

getPathIterator	back to summary
public PathIterator getPathIterator(AffineTransform at, double flatness) Implements java.awt.Shape.getPathIterator. Creates a `PathIterator` for the flattened outline of this `Area` object. Only uncurved path segments represented by the SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator. This `Area` object is unchanged. 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 amount that the control points for a given curve can vary from colinear before a subdivided curve is replaced by a straight line connecting the end points Returns:PathIterator the `PathIterator` object that returns the geometry of the outline of this `Area`, one segment at a time. Since 1.2

public PathIterator getPathIterator(AffineTransform at, double flatness)

Implements java.awt.Shape.getPathIterator.

Creates a PathIterator for the flattened outline of this Area object. Only uncurved path segments represented by the SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator. This Area object is unchanged.

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 amount that the control points for a given curve can vary from colinear before a subdivided curve is replaced by a straight line connecting the end points

Returns:PathIterator

the PathIterator object that returns the geometry of the outline of this Area, one segment at a time.

Since

1.2

intersect back to summary

intersect	back to summary
public void intersect(Area rhs) Sets the shape of this `Area` to the intersection of its current shape and the shape of the specified `Area`. The resulting shape of this `Area` will include only areas that were contained in both this `Area` and also in the specified `Area`. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.intersect(a2); a1(before) intersect a2 = a1(after) ################ ################ ################ ############## ############## ############ ############ ############ ######## ########## ########## #### ######## ######## ###### ###### #### #### ## ## Parameters rhs:Area the `Area` to be intersected with this `Area` Exceptions NullPointerException: if `rhs` is null Since 1.2

public void intersect(Area rhs)

Sets the shape of this Area to the intersection of its current shape and the shape of the specified Area. The resulting shape of this Area will include only areas that were contained in both this Area and also in the specified Area.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.intersect(a2);

     a1(before)   intersect     a2         =     a1(after)

    ################     ################     ################
    ##############         ##############       ############
    ############             ############         ########
    ##########                 ##########           ####
    ########                     ########
    ######                         ######
    ####                             ####
    ##                                 ##

Parameters

rhs:Area: the Area to be intersected with this Area

Exceptions

NullPointerException:: if rhs is null

Since

1.2

intersects back to summary

intersects	back to summary
public boolean intersects(double x, double y, double w, double h) Implements java.awt.Shape.intersects. Doc from java.awt.Shape.intersects. 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

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

Implements java.awt.Shape.intersects.

Doc from java.awt.Shape.intersects.

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

intersects back to summary

intersects	back to summary
public boolean intersects(Rectangle2D r) Implements java.awt.Shape.intersects. Doc from java.awt.Shape.intersects. 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 boolean intersects(Rectangle2D r)

Implements java.awt.Shape.intersects.

Doc from java.awt.Shape.intersects.

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

invalidateBounds	back to summary
private void invalidateBounds()

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Tests whether this `Area` object encloses any area. Returns:boolean `true` if this `Area` object represents an empty area; `false` otherwise. Since 1.2

public boolean isEmpty()

Tests whether this Area object encloses any area.

Returns:boolean: true if this Area object represents an empty area; false otherwise.
Since: 1.2

isPolygonal back to summary

isPolygonal	back to summary
public boolean isPolygonal() Tests whether this `Area` consists entirely of straight edged polygonal geometry. Returns:boolean `true` if the geometry of this `Area` consists entirely of line segments; `false` otherwise. Since 1.2

public boolean isPolygonal()

Tests whether this Area consists entirely of straight edged polygonal geometry.

Returns:boolean: true if the geometry of this Area consists entirely of line segments; false otherwise.
Since: 1.2

isRectangular back to summary

isRectangular	back to summary
public boolean isRectangular() Tests whether this `Area` is rectangular in shape. Returns:boolean `true` if the geometry of this `Area` is rectangular in shape; `false` otherwise. Since 1.2

public boolean isRectangular()

Tests whether this Area is rectangular in shape.

Returns:boolean: true if the geometry of this Area is rectangular in shape; false otherwise.
Since: 1.2

isSingular back to summary

isSingular	back to summary
public boolean isSingular() Tests whether this `Area` is comprised of a single closed subpath. This method returns `true` if the path contains 0 or 1 subpaths, or `false` if the path contains more than 1 subpath. The subpaths are counted by the number of `SEG_MOVETO` segments that appear in the path. Returns:boolean `true` if the `Area` is comprised of a single basic geometry; `false` otherwise. Since 1.2

public boolean isSingular()

Tests whether this Area is comprised of a single closed subpath. This method returns true if the path contains 0 or 1 subpaths, or false if the path contains more than 1 subpath. The subpaths are counted by the number of SEG_MOVETO segments that appear in the path.

Returns:boolean: true if the Area is comprised of a single basic geometry; false otherwise.
Since: 1.2

pathToCurves	back to summary
private static Vector<Curve> pathToCurves(PathIterator pi)

reset back to summary

reset	back to summary
public void reset() Removes all of the geometry from this `Area` and restores it to an empty area. Since 1.2

public void reset()

Removes all of the geometry from this Area and restores it to an empty area.

Since: 1.2

subtract back to summary

subtract	back to summary
public void subtract(Area rhs) Subtracts the shape of the specified `Area` from the shape of this `Area`. The resulting shape of this `Area` will include areas that were contained only in this `Area` and not in the specified `Area`. // Example: Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]); Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]); a1.subtract(a2); a1(before) - a2 = a1(after) ################ ################ ############## ############## ## ############ ############ #### ########## ########## ###### ######## ######## ######## ###### ###### ###### #### #### #### ## ## ## Parameters rhs:Area the `Area` to be subtracted from the current shape Exceptions NullPointerException: if `rhs` is null Since 1.2

public void subtract(Area rhs)

Subtracts the shape of the specified Area from the shape of this Area. The resulting shape of this Area will include areas that were contained only in this Area and not in the specified Area.

    // Example:
    Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
    Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
    a1.subtract(a2);

       a1(before)     -         a2         =     a1(after)

    ################     ################
    ##############         ##############     ##
    ############             ############     ####
    ##########                 ##########     ######
    ########                     ########     ########
    ######                         ######     ######
    ####                             ####     ####
    ##                                 ##     ##

Parameters

rhs:Area: the Area to be subtracted from the current shape

Exceptions

NullPointerException:: if rhs is null

Since

1.2

transform back to summary

transform	back to summary
public void transform(AffineTransform t) Transforms the geometry of this `Area` using the specified `AffineTransform`. The geometry is transformed in place, which permanently changes the enclosed area defined by this object. Parameters t:AffineTransform the transformation used to transform the area Exceptions NullPointerException: if `t` is null Since 1.2

public void transform(AffineTransform t)

Transforms the geometry of this Area using the specified AffineTransform. The geometry is transformed in place, which permanently changes the enclosed area defined by this object.

Parameters

t:AffineTransform: the transformation used to transform the area

Exceptions

NullPointerException:: if t is null

Since

1.2

public Class Area

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail