java.awt.Polygon Maven / Gradle / Ivy

Neither this file nor any files generated from it describe a complete specification, and they may only be used as described below. For example, no permission is given for you to incorporate this file, in whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided to you for informative, as opposed to normative, use. The file and any files generated from it may be used to generate other informative documentation, such as a unified set of documents of API signatures for a platform that includes technologies expressed as Java APIs. The file may also be used to produce "compilation stubs," which allow applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 217: Personal Basis Profile 1.1. In the event of a discrepency between this work and the JSR 217 specification, which is available at http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence. */ package java.awt; // import java.awt.geom.AffineTransform; // import java.awt.geom.PathIterator; // import java.awt.geom.Point2D; // import java.awt.geom.Rectangle2D; // import sun.awt.geom.Crossings; // PBP/PP // [6187229] /** * 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. This Polygon is defined with * an even-odd winding rule. (The even-odd rule specifies that a point lies inside the path if a ray drawn in any direction from that point to infinity is crossed by path segments an odd number of times.) * This class's hit-testing methods, which include the * contains, intersects and inside * methods, use the insideness definition described in the * {@link Shape} class comments. * * @version 1.26, 07/24/98 * @author Sami Shaio * @see Shape * @author Herb Jellinek * @since JDK1.0 */ public class Polygon implements Shape, java.io.Serializable { /** * 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 * {@link #xpoints xpoints} or {@link #ypoints ypoints}. * This value can be NULL. * * @serial * @see #addPoint(int, int) */ public int npoints; /** * 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 {@link #npoints npoints} is equal to the * number of valid points in this Polygon. * * @serial * @see #addPoint(int, int) */ public int[] xpoints; /** * 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. * * @serial * @see #addPoint(int, int) */ public int[] ypoints; // PBP/PP /** * Bounds of the polygon. * This value can be NULL. * Please see the javadoc comments getBounds(). * * @serial * @see #getBounds() */ protected Rectangle bounds; /* * JDK 1.1 serialVersionUID */ private static final long serialVersionUID = -6460061437900069969L; /** * Creates an empty polygon. */ public Polygon() { } /** * Constructs and initializes a Polygon from the specified * parameters. * @param xpoints an array of x coordinates * @param ypoints an array of y coordinates * @param npoints the total number of points in the * Polygon * @exception NegativeArraySizeException if the value of * npoints is negative. * @exception IndexOutOfBoundsException if npoints is * greater than the length of xpoints * or the length of ypoints. * @exception NullPointerException if xpoints or * ypoints is null. */ public Polygon(int[] xpoints, int[] ypoints, int npoints) { } /** * 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. * @see java.awt.Polygon#invalidate * @since 1.4 */ public void reset() { } // /** * 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. * @see java.awt.Polygon#getBounds * @since 1.4 */ public void invalidate() { } /** * Translates the vertices of the Polygon by * deltaX along the x axis and by * deltaY along the y axis. * @param deltaX the amount to translate along the x axis * @param deltaY the amount to translate along the y axis * @since JDK1.1 */ public void translate(int deltaX, int deltaY) { } /** * 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. * @param x the specified x coordinate * @param y the specified y coordinate * @see java.awt.Polygon#getBounds * @see java.awt.Polygon#contains */ public void addPoint(int x, int y) { } /** * Gets the bounding box of this Polygon. * The bounding box is the smallest {@link Rectangle} whose * sides are parallel to the x and y axes of the * coordinate space, and can completely contain the Polygon. * @return a Rectangle that defines the bounds of this * Polygon. * @since JDK1.1 */ public Rectangle getBounds() { return null; } // /** // * Returns the bounds of this Polygon. // * @return the bounds of this Polygon. // * @deprecated As of JDK version 1.1, // * replaced by getBounds(). // */ // public Rectangle getBoundingBox() { return null; } // PBP/PP /** * Determines whether the specified {@link Point} is inside this * Polygon. * @param p the specified Point to be tested * @return true if the Polygon contains the * Point; false otherwise. */ public boolean contains(Point p) { return false; } // PBP/PP /** * Determines whether the specified coordinates are inside this * Polygon. *