Polygon2D

java.lang.Object
- org.mdiutil.geom.Polygon2D

All Implemented Interfaces:

Shape, Serializable, Cloneable

Direct Known Subclasses:

Polyline2D
```
public class Polygon2D
extends Object
implements Shape, Cloneable, Serializable
```
This class has the same behavior than java.awt.Polygon, except that the cordinates are float instead of int. The aim of this package is the creation of a Polygon2D class, using float coordinates. The java.awt.Polygon class uses int coordinates, but we need float coordinates for accurate distance calculation in figures.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Rectangle2D`	`bounds` Bounds of the Polygon2D.
`protected GeneralPath`	`closedPath`
`int`	`npoints` The total number of points.
`protected GeneralPath`	`path`
`float[]`	`xpoints` The array of x coordinates.
`float[]`	`ypoints` The array of x coordinates.

Constructor Summary

Constructors
Constructor and Description
`Polygon2D()` Creates an empty Polygon2D.
`Polygon2D(float[] xpoints, float[] ypoints, int npoints)` Constructs and initializes a `Polygon2D` from the specified parameters.
`Polygon2D(int[] xpoints, int[] ypoints, int npoints)` Constructs and initializes a `Polygon2D` from the specified parameters.
`Polygon2D(Polygon pol)` Constructs and initializes a `Polygon2D` from the specified Polygon.
`Polygon2D(Rectangle2D rec)` Constructs and initializes a `Polygon2D` from the specified Rectangle2D.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint(float x, float y)` Appends the specified coordinates to this `Polygon2D`.
`void`	`addPoint(Point2D p)` Add a point to this Polygon.
`protected void`	`calculatePath()` Calculate the Polygon associated GeneralPath.
`Object`	`clone()`
`boolean`	`contains(double x, double y)` Determines if the specified coordinates are inside this `Polygon`.
`boolean`	`contains(double x, double y, double w, double h)` Tests if the interior of this `Polygon` entirely contains the specified set of rectangular coordinates.
`boolean`	`contains(int x, int y)` Determines whether the specified coordinates are inside this `Polygon`.
`boolean`	`contains(Point p)` Determines whether the specified `Point` is inside this `Polygon`.
`boolean`	`contains(Point2D p)` Tests if a specified `Point2D` is inside the boundary of this `Polygon`.
`boolean`	`contains(Rectangle2D r)` Tests if the interior of this `Polygon` entirely contains the specified `Rectangle2D`.
`int`	`countPoints()` Return the number of points.
`Rectangle`	`getBounds()` Returns the bounding box of the `Shape`.
`Rectangle2D`	`getBounds2D()` Returns the high precision bounding box of the `Shape`.
`double`	`getMaxX()` Return the maximum X coordinate of the Polygon.
`double`	`getMaxY()` Return the maximum Y coordinate of the Polygon.
`double`	`getMinX()` Return the minimum X coordinate of the Polygon.
`double`	`getMinY()` Return the minimum Y coordinate of the Polygon.
`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`.
`PathIterator`	`getPathIterator(AffineTransform at, double flatness)` Returns an iterator object that iterates along the boundary of the `Polygon2D` and provides access to the geometry of the outline of the `Shape`.
`List<Point2D>`	`getPoints()` Return the list of points.
`Polygon`	`getPolygon()` Retuen the Awt Polygon corresponding with this Polygon2D.
`Polyline2D`	`getPolyline2D()` Return the `Polyline2D` corresponding to this Polygon2D.
`float[]`	`getXCoordinates()` Return the array of X coordinates of the points.
`float[]`	`getYCoordinates()` Return the array of Y coordinates of the points.
`boolean`	`intersects(double x, double y, double w, double h)` Tests if the interior of this `Polygon` intersects the interior of a specified set of rectangular coordinates.
`boolean`	`intersects(Rectangle2D r)` Tests if the interior of this `Polygon` intersects the interior of a specified `Rectangle2D`.
`void`	`reset()` Resets this `Polygon` object to an empty polygon.
`protected void`	`updateComputingPath()`
`protected void`	`updatePath(float x, float y)` Update the Polygon associated GeneralPath.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - npoints
```
public int npoints
```
    The total number of points. The value of npoints represents the number of valid points in this Polygon.
  - xpoints
```
public float[] xpoints
```
    The array of x coordinates. The value of npoints is equal to the number of points in this Polygon2D.
  - ypoints
```
public float[] ypoints
```
    The array of x coordinates. The value of npoints is equal to the number of points in this Polygon2D.
  - bounds
```
protected Rectangle2D bounds
```
    Bounds of the Polygon2D.
    
    See Also:
    
    getBounds()
  - path
```
protected GeneralPath path
```
  - closedPath
```
protected GeneralPath closedPath
```
- Constructor Detail
  - Polygon2D
```
public Polygon2D()
```
    Creates an empty Polygon2D.
  - Polygon2D
```
public Polygon2D(Rectangle2D rec)
```
    Constructs and initializes a Polygon2D from the specified Rectangle2D.
    
    Parameters:
    
    rec - the Rectangle2D
    
    Throws:
    
    NullPointerException - rec is null.
  - Polygon2D
```
public Polygon2D(Polygon pol)
```
    Constructs and initializes a Polygon2D from the specified Polygon.
    
    Parameters:
    
    pol - the Polygon
    
    Throws:
    
    NullPointerException - pol is null.
  - Polygon2D
```
public Polygon2D(float[] xpoints,
                 float[] ypoints,
                 int npoints)
```
    Constructs and initializes a Polygon2D 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 Polygon2D
    
    Throws:
    
    NegativeArraySizeException - if the value of npoints is negative.
    
    IndexOutOfBoundsException - if npoints is greater than the length of xpoints or the length of ypoints.
    
    NullPointerException - if xpoints or ypoints is null.
  - Polygon2D
```
public Polygon2D(int[] xpoints,
                 int[] ypoints,
                 int npoints)
```
    Constructs and initializes a Polygon2D 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 Polygon2D
    
    Throws:
    
    NegativeArraySizeException - if the value of npoints is negative.
    
    IndexOutOfBoundsException - if npoints is greater than the length of xpoints or the length of ypoints.
    
    NullPointerException - if xpoints or ypoints is null.
- Method Detail
  - countPoints
```
public int countPoints()
```
    Return the number of points.
    
    Returns:
    
    the number of points
  - getXCoordinates
```
public float[] getXCoordinates()
```
    Return the array of X coordinates of the points.
    
    Returns:
    
    the array
  - getYCoordinates
```
public float[] getYCoordinates()
```
    Return the array of Y coordinates of the points.
    
    Returns:
    
    the array
  - getPoints
```
public List<Point2D> getPoints()
```
    Return the list of points. Note that a list is recreated every time this method is called.
    
    Returns:
    
    the list of points
  - reset
```
public void reset()
```
    Resets this Polygon object to an empty polygon.
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - calculatePath
```
protected void calculatePath()
```
    Calculate the Polygon associated GeneralPath.
  - updatePath
```
protected void updatePath(float x,
                          float y)
```
    Update the Polygon associated GeneralPath.
    
    Parameters:
    
    x - the x coordinate of the new Point
    
    y - the y coordinate of the new Point
  - getPolyline2D
```
public Polyline2D getPolyline2D()
```
    Return the Polyline2D corresponding to this Polygon2D.
    
    Returns:
    
    the Polyline2D corresponding to this Polygon2D
  - getPolygon
```
public Polygon getPolygon()
```
    Retuen the Awt Polygon corresponding with this Polygon2D.
    
    Returns:
    
    the Awt Polygon corresponding with this Polygon2D
  - addPoint
```
public void addPoint(Point2D p)
```
    Add a point to this Polygon.
    
    Parameters:
    
    p - the point
  - addPoint
```
public void addPoint(float x,
                     float y)
```
    Appends the specified coordinates to this Polygon2D.
    
    Parameters:
    
    x - the specified x coordinate
    
    y - the specified y coordinate
  - contains
```
public boolean contains(Point p)
```
    Determines whether the specified Point is inside this Polygon.
    
    Parameters:
    
    p - the specified Point to be tested
    
    Returns:
    
    true if the Polygon contains the Point; false otherwise.
    
    See Also:
    
    contains(double, double)
  - contains
```
public boolean contains(int x,
                        int y)
```
    Determines whether the specified coordinates are inside this Polygon.
    
    Parameters:
    
    x - the specified x coordinate to be tested
    
    y - the specified y coordinate to be tested
    
    Returns:
    
    true if this Polygon contains the specified coordinates, (x, y); false otherwise.
  - getMinX
```
public double getMinX()
```
    Return the minimum X coordinate of the Polygon.
    
    Returns:
    
    the minimum X coordinate
  - getMinY
```
public double getMinY()
```
    Return the minimum Y coordinate of the Polygon.
    
    Returns:
    
    the minimum Y coordinate
  - getMaxX
```
public double getMaxX()
```
    Return the maximum X coordinate of the Polygon.
    
    Returns:
    
    the maximum X coordinate
  - getMaxY
```
public double getMaxY()
```
    Return the maximum Y coordinate of the Polygon.
    
    Returns:
    
    the maximum Y coordinate
  - getBounds2D
```
public Rectangle2D getBounds2D()
```
    Returns the high precision bounding box of the Shape.
    
    Specified by:
    
    getBounds2D in interface Shape
    
    Returns:
    
    a Rectangle2D that precisely bounds the Shape.
  - getBounds
```
public Rectangle getBounds()
```
    Returns the bounding box of the Shape.
    
    Specified by:
    
    getBounds in interface Shape
    
    Returns:
    
    a Rectangle that bounds the Shape.
  - contains
```
public boolean contains(double x,
                        double y)
```
    Determines if the specified coordinates are inside this Polygon. For the definition of insideness, see the class comments of Shape.
    
    Specified by:
    
    contains in interface Shape
    
    Parameters:
    
    x - the specified x coordinate
    
    y - the specified y coordinate
    
    Returns:
    
    true if the Polygon contains the specified coordinates; false otherwise.
  - updateComputingPath
```
protected void updateComputingPath()
```
  - contains
```
public boolean contains(Point2D p)
```
    Tests if a specified Point2D is inside the boundary of this Polygon.
    
    Specified by:
    
    contains in interface Shape
    
    Parameters:
    
    p - a specified Point2D
    
    Returns:
    
    true if this Polygon contains the specified Point2D, false otherwise.
    
    See Also:
    
    contains(double, double)
  - intersects
```
public boolean intersects(double x,
                          double y,
                          double w,
                          double h)
```
    Tests if the interior of this Polygon intersects the interior of a specified set of rectangular coordinates.
    
    Specified by:
    
    intersects in interface Shape
    
    Parameters:
    
    x - the x coordinate of the specified rectangular shape's top-left corner
    
    y - the y coordinate of the specified rectangular shape's top-left corner
    
    w - the width of the specified rectangular shape
    
    h - the height of the specified rectangular shape
    
    Returns:
    
    true if the interior of this Polygon and the interior of the specified set of rectangular coordinates intersect each other false otherwise.
  - intersects
```
public boolean intersects(Rectangle2D r)
```
    Tests if the interior of this Polygon intersects the interior of a specified Rectangle2D.
    
    Specified by:
    
    intersects in interface Shape
    
    Parameters:
    
    r - a specified Rectangle2D
    
    Returns:
    
    true if this Polygon and the interior of the specified Rectangle2D intersect each other; false otherwise.
  - contains
```
public boolean contains(double x,
                        double y,
                        double w,
                        double h)
```
    Tests if the interior of this Polygon entirely contains the specified set of rectangular coordinates.
    
    Specified by:
    
    contains in interface Shape
    
    Parameters:
    
    x - the x coordinate of the top-left corner of the specified set of rectangular coordinates
    
    y - the y coordinate of the top-left corner of the specified set of rectangular coordinates
    
    w - the width of the set of rectangular coordinates
    
    h - the height of the set of rectangular coordinates
    
    Returns:
    
    true if this Polygon entirely contains the specified set of rectangular coordinates; false otherwise.
  - contains
```
public boolean contains(Rectangle2D r)
```
    Tests if the interior of this Polygon entirely contains the specified Rectangle2D.
    
    Specified by:
    
    contains in interface Shape
    
    Parameters:
    
    r - the specified Rectangle2D
    
    Returns:
    
    true if this Polygon entirely contains the specified Rectangle2D; false otherwise.
    
    See Also:
    
    contains(double, double, double, double)
  - getPathIterator
```
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.
    
    Specified by:
    
    getPathIterator in interface Shape
    
    Parameters:
    
    at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
    
    Returns:
    
    a PathIterator object that provides access to the geometry of this Polygon.
  - getPathIterator
```
public PathIterator getPathIterator(AffineTransform at,
                                    double flatness)
```
    Returns an iterator object that iterates along the boundary of the Polygon2D 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.
    
    Specified by:
    
    getPathIterator in interface Shape
    
    Parameters:
    
    at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if 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. Since polygons are already flat the flatness parameter is ignored.
    
    Returns:
    
    a PathIterator object that provides access to the Shape object's geometry.

Class Polygon2D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

npoints

xpoints

ypoints

bounds

path

closedPath

Constructor Detail

Polygon2D

Polygon2D

Polygon2D

Polygon2D

Polygon2D

Method Detail

countPoints

getXCoordinates

getYCoordinates

getPoints

reset

clone

calculatePath

updatePath

getPolyline2D

getPolygon

addPoint

addPoint

contains

contains

getMinX

getMinY

getMaxX

getMaxY

getBounds2D

getBounds

contains

updateComputingPath

contains

intersects

intersects

contains

contains

getPathIterator

getPathIterator