All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.awt.Polygon 

java.lang.Object
    |
    +----java.awt.Polygon
public class Polygon
extends Object
implements Shape, Serializable
The Polygon class encapsulates a description of a closed, two-dimensional region within a coordinate space. This region is bounded by an arbitrary number of line segments, each of which is one side of the polygon. Internally, a polygon comprises of a list of (x, y) coordinate pairs, where each pair defines a vertex of the polygon, and two successive pairs are the endpoints of a line that is a side of the polygon. The first and final pairs of (x, y) points are joined by a line segment that closes the polygon.

Since:
JDK1.0

Variable Index

o bounds
o npoints
The total number of points.
o xpoints
The array of x coordinates.
o ypoints
The array of y coordinates.

Constructor Index

o Polygon()
Creates an empty polygon.
o Polygon(int[], int[], int)
Constructs and initializes a polygon from the specified parameters.

Method Index

o addPoint(int, int)
Appends a point to this polygon.
o contains(double, double)
Test if a given coordinate is inside the boundary of the shape.
o contains(double, double, double, double)
Test if the interior of the Shape entirely contains the given set of rectangular coordinates.
o contains(int, int)
Determines whether the specified point is contained by this polygon.
o contains(Point)
Determines whether the specified point is inside the Polygon.
o contains(Point2D)
Test if a given Point is inside the boundary of the shape.
o contains(Rectangle2D)
Test if the interior of the Shape entirely contains the given Rectangle.
o getBoundingBox()
Deprecated.
o getBounds()
Gets the bounding box of this polygon.
o getBounds2D()
Return the high precision bounding box of the shape.
o getPathIterator(AffineTransform)
Return an iterator object that iterates along the boundary of the shape and provides access to the geometry of the outline of the shape.
o getPathIterator(AffineTransform, double)
Return an iterator object that iterates along the boundary of the shape and provides access to a flattened view of the geometry of the outline of the shape.
o inside(int, int)
Deprecated.
o intersects(double, double, double, double)
Test if the interior of the Shape intersects the interior of a given set of rectangular coordinates.
o intersects(Rectangle2D)
Test if the interior of the Shape intersects the interior of a given Rectangle.
o translate(int, int)
Translates the vertices by deltaX along the x axis and by deltaY along the y axis.

Variables

o npoints 
public int npoints
The total number of points.

o xpoints 
public int[] xpoints
The array of x coordinates.

o ypoints 
public int[] ypoints
The array of y coordinates.

o bounds 
protected Rectangle bounds

Constructors

o Polygon 
public Polygon()
Creates an empty polygon.

o Polygon 
public Polygon(int[] xpoints,
               int[] ypoints,
               int npoints)
Constructs and initializes a polygon from the specified parameters.

Parameters:
xpoints - an array of x coordinates.
ypoints - an array of y coordinates.
npoints - the total number of points in the polygon.
Throws: NegativeArraySizeException
if the value of npoints is negative.

Methods

o translate 
public void translate(int deltaX,
                      int deltaY)
Translates the vertices by deltaX along the x axis and by deltaY along the y axis.

Parameters:
deltaX - the amount to translate along the x axis
deltaY - the amount to translate along the y axis
o addPoint 
public void addPoint(int x,
                     int y)
Appends a point to this polygon.

If an operation that calculates the bounding box of this polygon has already been performed, such as getBounds or contains, then this method updates the bounding box.

Parameters:
x - the x coordinate of the point.
y - the y coordinate of the point.
See Also:
getBounds, contains
o getBounds 
public Rectangle getBounds()
Gets the bounding box of this polygon. The bounding box is the smallest rectangle whose sides are parallel to the x and y axes of the coordinate space, and that can completely contain the polygon.

Returns:
a rectangle that defines the bounds of this polygon.
o getBoundingBox 
public Rectangle getBoundingBox()
Note: getBoundingBox() is deprecated. As of JDK version 1.1, replaced by getBounds().

o contains 
public boolean contains(Point p)
Determines whether the specified point is inside the Polygon. Uses an even-odd insideness rule (also known as an alternating rule).

Parameters:
p - the point to be tested
o contains 
public boolean contains(int x,
                        int y)
Determines whether the specified point is contained by this polygon.

(The contains method is based on code by Hanpeter van Vliet [hvvliet@inter.nl.net].)

Parameters:
x - the x coordinate of the point to be tested.
y - the y coordinate of the point to be tested.
Returns:
true if the point (x, y) is contained by this polygon; false otherwise.
o inside 
public boolean inside(int x,
                      int y)
Note: inside() is deprecated. As of JDK version 1.1, replaced by contains(int, int).

o getBounds2D 
public Rectangle2D getBounds2D()
Return the high precision bounding box of the shape.

o contains 
public boolean contains(double x,
                        double y)
Test if a given coordinate is inside the boundary of the shape.

o contains 
public boolean contains(Point2D p)
Test if a given Point is inside the boundary of the shape.

o intersects 
public boolean intersects(double x,
                          double y,
                          double w,
                          double h)
Test if the interior of the Shape intersects the interior of a given set of rectangular coordinates.

o intersects 
public boolean intersects(Rectangle2D r)
Test if the interior of the Shape intersects the interior of a given Rectangle.

o contains 
public boolean contains(double x,
                        double y,
                        double w,
                        double h)
Test if the interior of the Shape entirely contains the given set of rectangular coordinates.

o contains 
public boolean contains(Rectangle2D r)
Test if the interior of the Shape entirely contains the given Rectangle.

o getPathIterator 
public PathIterator getPathIterator(AffineTransform at)
Return an iterator object that iterates along the boundary of the shape and provides access to the geometry of the outline of the shape. An optional affine transform can be specified in which case the coordinates returned in the iteration will be transformed accordingly.

Parameters:
at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if the untransformed coordinates are desired.
o getPathIterator 
public PathIterator getPathIterator(AffineTransform at,
                                    double flatness)
Return an iterator object that iterates along the boundary of the shape and provides access to a flattened view of the geometry of the outline of the shape. Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types will be returned by the iterator. The amount of subdivision of the curved segments is controlled by the flatness parameter which specifies ?REMIND?. An optional affine transform can be specified in which case the coordinates returned in the iteration will be transformed accordingly.

Parameters:
at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if the untransformed coordinates are desired.
flatness - 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 endpoints. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index
Submit a bug or feature