Polygon2D

java.lang.Object
- EE324StandardProjectClasses.Polygon2D

All Implemented Interfaces:

java.lang.Iterable<Point2D>
```
public class Polygon2D
extends java.lang.Object
implements java.lang.Iterable<Point2D>
```
A 2D polygon class. Construct and draw polygons. Compute basic computational geometry operations on polygons and compute the convex hull of a polygon. The polygon is internally stored as an array of Point2D objects. Points can be retrieved by index.
NOTE: This class requires inclusion of the StdDraw and the JTS geometry libraries.

Author:

Conor McArdle (conor.mcardle@dcu.ie)

Constructor Summary

Constructors
Constructor and Description
`Polygon2D()` Construct an empty polygon.
`Polygon2D(java.util.List<Point2D> points)` Construct a polygon from a List of Point2D.
`Polygon2D(Point2D[] points)` Construct a polygon from an array of points.
`Polygon2D(Polygon2D poly)` Copy constructor - makes a copy of the specified polygon.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint(Point2D p)` Add a point to this polygon.
`Point2D[]`	`asPointsArray()` This polygon as an array of points.
`boolean`	`contains(Point2D p)` Test if a specified point is contained inside this polygon. Uses JTS method: boolean Geometry.contains(Geometry g)
`boolean`	`contains(Point2D p1, Point2D p2)` Test if a specified line segment is entirely contained inside this polygon. Uses JTS method: boolean Geometry.contains(Geometry g)
`boolean`	`disjoint(Point2D p1, Point2D p2)` Test if the specified line segment points are disjoint from this polygon. Returns true if none of the line segment points lie on the perimeter or the interior of this polygon. Uses JTS method: boolean Geometry.disjoint(Geometry g)
`void`	`draw()` Draw perimeter of this polygon - uses the StdDraw library.
`void`	`draw(java.awt.Color clr)` Draw perimeter of this polygon with a given color - uses the StdDraw library.
`void`	`draw(java.awt.Color clr, double penWidth)` Draw perimeter of this polygon with a given color and pen width - uses the StdDraw library.
`void`	`drawFilled()` Draw and fill this polygon - uses the StdDraw library.
`void`	`drawFilled(java.awt.Color clr)` Draw and fill this polygon with a given color - uses the StdDraw library.
`Point2D`	`get(int indx)` Get a specific vertex of the polygon.
`Polygon2D`	`getHull()` Get the convex hull of this polygon. Note: returned hull is not a closed polygon (first point is not repeated as the last point). Uses JTS method: Geometry.convexHull()
`boolean`	`intersects(Point2D p1, Point2D p2)` Test if a specified line segment intersects this polygon. Returns true if this polygon and the specified line segment have at least one point in common. Uses JTS method: boolean Geometry.intersects(Geometry g)
`java.util.Iterator<Point2D>`	`iterator()` Iterator supporting for-each style iteration over all points in this polygon.
`int`	`size()` The number of vertices of this polygon.
`java.lang.String`	`toString()` Get a string representation of this polygon's points.
`boolean`	`touches(Point2D p)` Test if a specified point touches this polygon. Uses JTS method: boolean Geometry.touches(Geometry g)
`boolean`	`touches(Point2D p1, Point2D p2)` Test if a specified line segment touches this polygon. Returns true if this polygon and the line segment have at least one point in common, but none of the line segment points lie in the interior of the polygon perimeter. Uses JTS method: boolean Geometry.touches(Geometry g)

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - Polygon2D
```
public Polygon2D()
```
    Construct an empty polygon.
  - Polygon2D
```
public Polygon2D(java.util.List<Point2D> points)
```
    Construct a polygon from a List of Point2D. Order of points is preserved.
    
    Parameters:
    
    points - List of Point2D references
  - Polygon2D
```
public Polygon2D(Point2D[] points)
```
    Construct a polygon from an array of points. Order of points is preserved.
    
    Parameters:
    
    points - array of Point2D references
  - Polygon2D
```
public Polygon2D(Polygon2D poly)
```
    Copy constructor - makes a copy of the specified polygon.
    
    Parameters:
    
    poly - the polygon to copy
- Method Detail
  - addPoint
```
public void addPoint(Point2D p)
```
    Add a point to this polygon. Note: resizes the internal array of points storing the polygon.
    
    Parameters:
    
    p - the point to add to this polygon
  - asPointsArray
```
public Point2D[] asPointsArray()
```
    This polygon as an array of points.
    
    Returns:
    
    the polygon as an array of Point2D
  - contains
```
public boolean contains(Point2D p)
```
    Test if a specified point is contained inside this polygon.
    Uses JTS method: boolean Geometry.contains(Geometry g)
    
    Parameters:
    
    p - point to test
    
    Returns:
    
    true if this polygon contains point, false otherwise
  - contains
```
public boolean contains(Point2D p1,
                        Point2D p2)
```
    Test if a specified line segment is entirely contained inside this polygon.
    Uses JTS method: boolean Geometry.contains(Geometry g)
    
    Parameters:
    
    p1 - first end point of line segment
    
    p2 - second end point of line segment
    
    Returns:
    
    true if this polygon contains line segment, false otherwise
  - disjoint
```
public boolean disjoint(Point2D p1,
                        Point2D p2)
```
    Test if the specified line segment points are disjoint from this polygon.
    Returns true if none of the line segment points lie on the perimeter or the interior of this polygon.
    Uses JTS method: boolean Geometry.disjoint(Geometry g)
    
    Parameters:
    
    p1 - first end point of line segment
    
    p2 - second end point of line segment
    
    Returns:
    
    true if line segment and this polygon are disjoint, false otherwise
  - draw
```
public void draw()
```
    Draw perimeter of this polygon - uses the StdDraw library.
  - draw
```
public void draw(java.awt.Color clr)
```
    Draw perimeter of this polygon with a given color - uses the StdDraw library.
    
    Parameters:
    
    clr - the pen color to use
  - draw
```
public void draw(java.awt.Color clr,
                 double penWidth)
```
    Draw perimeter of this polygon with a given color and pen width - uses the StdDraw library.
    
    Parameters:
    
    clr - the pen color to use
    
    penWidth - width of the pen to use
  - drawFilled
```
public void drawFilled()
```
    Draw and fill this polygon - uses the StdDraw library.
  - drawFilled
```
public void drawFilled(java.awt.Color clr)
```
    Draw and fill this polygon with a given color - uses the StdDraw library.
    
    Parameters:
    
    clr - the pen color to use
  - get
```
public Point2D get(int indx)
```
    Get a specific vertex of the polygon.
    
    Parameters:
    
    indx - index of point to get
    
    Returns:
    
    the polygon vertex as a Point2D, returns null if index doesn't exist
  - getHull
```
public Polygon2D getHull()
```
    Get the convex hull of this polygon.
    Note: returned hull is not a closed polygon (first point is not repeated as the last point).
    Uses JTS method: Geometry.convexHull()
    
    Returns:
    
    the convex hull of this polygon
  - intersects
```
public boolean intersects(Point2D p1,
                          Point2D p2)
```
    Test if a specified line segment intersects this polygon.
    Returns true if this polygon and the specified line segment have at least one point in common.
    Uses JTS method: boolean Geometry.intersects(Geometry g)
    
    Parameters:
    
    p1 - first point on line
    
    p2 - second point on line
    
    Returns:
    
    true if line segment intersects this polygon, false otherwise
  - iterator
```
public java.util.Iterator<Point2D> iterator()
```
    Iterator supporting for-each style iteration over all points in this polygon. Example:
    for (Point2D pnt : poly) { pnt.draw(); } // poly a Polygon2D object
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Point2D>
  - size
```
public int size()
```
    The number of vertices of this polygon.
    
    Returns:
    
    number of polygon vertices
  - toString
```
public java.lang.String toString()
```
    Get a string representation of this polygon's points.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string representation of the polygon points
  - touches
```
public boolean touches(Point2D p)
```
    Test if a specified point touches this polygon.
    Uses JTS method: boolean Geometry.touches(Geometry g)
    
    Parameters:
    
    p - point to test
    
    Returns:
    
    true if point touches this polygon, false otherwise
  - touches
```
public boolean touches(Point2D p1,
                       Point2D p2)
```
    Test if a specified line segment touches this polygon.
    Returns true if this polygon and the line segment have at least one point in common, but none of the line segment points lie in the interior of the polygon perimeter.
    Uses JTS method: boolean Geometry.touches(Geometry g)
    
    Parameters:
    
    p1 - first end point of line segment
    
    p2 - second end point of line segment
    
    Returns:
    
    true if line segment touches this polygon, false otherwise

Class Polygon2D

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Polygon2D

Polygon2D

Polygon2D

Polygon2D

Method Detail

addPoint

asPointsArray

contains

contains

disjoint

draw

draw

draw

drawFilled

drawFilled

get

getHull

intersects

iterator

size

toString

touches

touches