 
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 
Shape moving = …;
Area movingArea = new Area(moving);
Based on 66 examples
Based on 53 examples
public class Area extends Object implements Shape, Cloneable
An Area
object stores and manipulates a
resolutionindependent description of an enclosed area of
2dimensional space.
Area
objects can be transformed and can perform
various Constructive Area Geometry (CAG) operations when combined
with other Area
objects.
The CAG operations include area
{@link #add addition}, {@link #subtract subtraction},
{@link #intersect intersection}, and {@link #exclusiveOr exclusive or}.
See the linked method documentation for examples of the various
operations.
The Area
class implements the Shape
interface and provides full support for all of its hittesting
and path iteration facilities, but an Area
is more
specific than a generalized path in a number of ways:
Area
objects constructed from unclosed paths
are implicitly closed during construction as if those paths
had been filled by the Graphics2D.fill
method.
Area
resembles the path from which it was
constructed only in that it describes the same enclosed
2dimensional area, but may use entirely different types
and ordering of the path segments to do so.
Area
include:
Area
from an unclosed (open)
Shape
results in a closed outline in the
Area
object.
Area
from a Shape
which encloses no area (even when "closed") produces an
empty Area
. A common example of this issue
is that producing an Area
from a line will
be empty since the line encloses no area. An empty
Area
will iterate no geometry in its
PathIterator
objects.
Shape
may be split into
two (or more) subpaths each enclosing one of the
nonintersecting portions of the original path.
Area
may take more path segments to
describe the same geometry even when the original
outline is simple and obvious. The analysis that the
Area
class must perform on the path may
not reflect the same concepts of "simple and obvious"
as a human being perceives.
Constructor Summary  

Area() Default constructor which creates an empty area. 

The Area class creates an area geometry from the
specified java.awt.Shape object.

Method Summary  

void 
Adds the shape of the specified Area to the
shape of this Area .

Object 
clone() Returns an exact copy of this Area object.

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

boolean 

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

boolean 
Tests whether the geometries of the two Area objects
are equal.

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.

Rectangle 
Returns a bounding java.awt.Rectangle that completely encloses this Area .

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

PathIterator 
Creates a java.awt.geom.PathIterator for the outline of this Area object.

PathIterator 
getPathIterator(AffineTransform at, double flatness) Creates a PathIterator for the flattened outline of
this Area object.

void 
Sets the shape of this Area to the intersection of
its current shape and the shape of the specified Area .

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

boolean 
isEmpty() Tests whether this Area object encloses any area.

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

boolean 
Tests whether this Area is rectangular in shape.

boolean 
Tests whether this Area is comprised of a single
closed subpath.

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

void 
Subtracts the shape of the specified Area from the
shape of this Area .

void 
Transforms the geometry of this Area using the specified
java.awt.geom.AffineTransform.

Methods inherited from class java.lang.Object 

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 
Constructor Detail 

public Area()
public Area(Shape s)
Area
class creates an area geometry from the
specified {@link Shape} object. The geometry is explicitly
closed, if the Shape
is not already closed. The
fill rule (evenodd or winding) specified by the geometry of the
Shape
is used to determine the resulting enclosed area.
s
 the Shape
from which the area is constructedMethod Detail 

public void add(Area rhs)
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) ################ ################ ################ ############## ############## ################ ############ ############ ################ ########## ########## ################ ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
rhs
 the Area
to be added to the
current shapepublic Object clone()
Area
object.
clone
in class Object
public boolean contains(double x, double y)
x
y
public boolean contains(double x, double y, double w, double h)
x
y
w
h
public boolean contains(Point2D p)
p
public boolean contains(Rectangle2D r)
r
public Area createTransformedArea(AffineTransform t)
Area
object that contains the same
geometry as this Area
transformed by the specified
AffineTransform
. This Area
object
is unchanged.
t
 the specified AffineTransform
used to transform
the new Area
Area
object representing the transformed
geometry.public boolean equals(Area other)
Area
objects
are equal.
This method will return false if the argument is null.
other
 the Area
to be compared to this
Area
true
if the two geometries are equal;
false
otherwise.public void exclusiveOr(Area rhs)
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) ################ ################ ############## ############## ## ## ############ ############ #### #### ########## ########## ###### ###### ######## ######## ################ ###### ###### ###### ###### #### #### #### #### ## ## ## ##
rhs
 the Area
to be exclusive ORed with this
Area
.public Rectangle getBounds()
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.
Rectangle
for the
Area
.public Rectangle2D getBounds2D()
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.
Rectangle2D
for the
Area
.public PathIterator getPathIterator(AffineTransform at)
Area
object. This Area
object is unchanged.
at
 an optional AffineTransform
to be applied to
the coordinates as they are returned in the iteration, or
null
if untransformed coordinates are desiredPathIterator
object that returns the
geometry of the outline of this Area
, one
segment at a time.public PathIterator getPathIterator(AffineTransform at, double flatness)
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.
at
 an optional AffineTransform
to be
applied to the coordinates as they are returned in the
iteration, or null
if untransformed coordinates
are desiredflatness
 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 pointsPathIterator
object that returns the
geometry of the outline of this Area
, one segment
at a time.public void intersect(Area rhs)
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) ################ ################ ################ ############## ############## ############ ############ ############ ######## ########## ########## #### ######## ######## ###### ###### #### #### ## ##
rhs
 the Area
to be intersected with this
Area
public boolean intersects(double x, double y, double w, double h)
x
y
w
h
public boolean intersects(Rectangle2D r)
r
public boolean isEmpty()
Area
object encloses any area.
true
if this Area
object
represents an empty area; false
otherwise.public boolean isPolygonal()
Area
consists entirely of
straight edged polygonal geometry.
true
if the geometry of this
Area
consists entirely of line segments;
false
otherwise.public boolean isRectangular()
Area
is rectangular in shape.
true
if the geometry of this
Area
is rectangular in shape; false
otherwise.public boolean isSingular()
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 {@link PathIterator#SEG_MOVETO SEG_MOVETO} segments
that appear in the path.
true
if the Area
is comprised
of a single basic geometry; false
otherwise.public void reset()
Area
and
restores it to an empty area.
public void subtract(Area rhs)
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) ################ ################ ############## ############## ## ############ ############ #### ########## ########## ###### ######## ######## ######## ###### ###### ###### #### #### #### ## ## ##
rhs
 the Area
to be subtracted from the
current shapepublic void transform(AffineTransform t)
Area
using the specified
{@link AffineTransform}. The geometry is transformed in place, which
permanently changes the enclosed area defined by this object.
t
 the transformation used to transform the area
 
PREV CLASS NEXT CLASS  FRAMES NO FRAMES  
SUMMARY: NESTED  FIELD  CONSTR  METHOD  DETAIL: FIELD  CONSTR  METHOD 