Home » openjdk-7 » java » awt » [javadoc | source]
java.awt
public class: Polygon [javadoc | source]
java.lang.Object
   java.awt.Polygon

All Implemented Interfaces:
    Shape, Serializable

Direct Known Subclasses:
    PolygonRegionContainment

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 {@code (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 {@code (x,y)} points are joined by a line segment that closes the polygon. This Polygon is defined with an even-odd winding rule. See WIND_EVEN_ODD for a definition of the even-odd winding rule. This class's hit-testing methods, which include the contains, intersects and inside methods, use the insideness definition described in the Shape class comments.
Nested Class Summary:
class  Polygon.PolygonPathIterator   
Field Summary
public  int npoints    The total number of points. The value of npoints represents the number of valid points in this Polygon and might be less than the number of elements in xpoints or ypoints . This value can be NULL. 
public  int[] xpoints    The array of X coordinates. The number of elements in this array might be more than the number of X coordinates in this Polygon. The extra elements allow new points to be added to this Polygon without re-creating this array. The value of npoints is equal to the number of valid points in this Polygon. 
public  int[] ypoints    The array of Y coordinates. The number of elements in this array might be more than the number of Y coordinates in this Polygon. The extra elements allow new points to be added to this Polygon without re-creating this array. The value of npoints is equal to the number of valid points in this Polygon. 
protected  Rectangle bounds    The bounds of this {@code Polygon}. This value can be null. 
Constructor:
 public Polygon() 
 public Polygon(int[] xpoints,
    int[] ypoints,
    int npoints) 
Method from java.awt.Polygon Summary:
addPoint,   calculateBounds,   contains,   contains,   contains,   contains,   contains,   contains,   getBoundingBox,   getBounds,   getBounds2D,   getPathIterator,   getPathIterator,   inside,   intersects,   intersects,   invalidate,   reset,   translate,   updateBounds
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.Polygon Detail:
 public  void addPoint(int x,
    int y) 
    Appends the specified coordinates 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.

  void calculateBounds(int[] xpoints,
    int[] ypoints,
    int npoints) 
 public boolean contains(Point p) 
    Determines whether the specified Point is inside this Polygon.
 public boolean contains(Point2D p) 
    {@inheritDoc}
 public boolean contains(Rectangle2D r) 
    {@inheritDoc}
 public boolean contains(int x,
    int y) 
    Determines whether the specified coordinates are inside this Polygon.

 public boolean contains(double x,
    double y) 
    {@inheritDoc}
 public boolean contains(double x,
    double y,
    double w,
    double h) 
    {@inheritDoc}
 public Rectangle getBoundingBox() 
Deprecated! As - of JDK version 1.1, replaced by getBounds().

    Returns the bounds of this Polygon.
 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 can completely contain the Polygon.
 public Rectangle2D getBounds2D() 
    {@inheritDoc}
 public PathIterator getPathIterator(AffineTransform at) 
    Returns an iterator object that iterates along the boundary of this Polygon and provides access to the geometry of the outline of this Polygon. An optional AffineTransform can be specified so that the coordinates returned in the iteration are transformed accordingly.
 public PathIterator getPathIterator(AffineTransform at,
    double flatness) 
    Returns an iterator object that iterates along the boundary of the Shape and provides access to the geometry of the outline of the Shape. Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator. Since polygons are already flat, the flatness parameter is ignored. An optional AffineTransform can be specified in which case the coordinates returned in the iteration are transformed accordingly.
 public boolean inside(int x,
    int y) 
Deprecated! As - of JDK version 1.1, replaced by contains(int, int).

    Determines whether the specified coordinates are contained in this Polygon.
 public boolean intersects(Rectangle2D r) 
    {@inheritDoc}
 public boolean intersects(double x,
    double y,
    double w,
    double h) 
    {@inheritDoc}
 public  void invalidate() 
    Invalidates or flushes any internally-cached data that depends on the vertex coordinates of this Polygon. This method should be called after any direct manipulation of the coordinates in the xpoints or ypoints arrays to avoid inconsistent results from methods such as getBounds or contains that might cache data from earlier computations relating to the vertex coordinates.
 public  void reset() 
    Resets this Polygon object to an empty polygon. The coordinate arrays and the data in them are left untouched but the number of points is reset to zero to mark the old vertex data as invalid and to start accumulating new vertex data at the beginning. All internally-cached data relating to the old vertices are discarded. Note that since the coordinate arrays from before the reset are reused, creating a new empty Polygon might be more memory efficient than resetting the current one if the number of vertices in the new polygon data is significantly smaller than the number of vertices in the data from before the reset.
 public  void translate(int deltaX,
    int deltaY) 
    Translates the vertices of the Polygon by deltaX along the x axis and by deltaY along the y axis.
  void updateBounds(int x,
    int y)