Polygon2D (MorphoLibJ 1.6.0.1 API)

java.lang.Object
- inra.ijpb.geometry.Polygon2D

All Implemented Interfaces:

Iterable<Point2D>
```
public class Polygon2D
extends Object
implements Iterable<Point2D>
```
A polygon shape in the plane. Polygon is assumed to be simple: only one connected component, no hole.

Author:

dlegland

Constructor Summary

Constructors
Constructor and Description
`Polygon2D()` Creates a new empty polygon.
`Polygon2D(Collection<Point2D> vertices)` Creates a new polygon from a collection of vertices.
`Polygon2D(double[] xCoords, double[] yCoords)` Creates a new polygon from the coordinates of its vertices.
`Polygon2D(int n)` Creates a new empty polygon by allocating enough space for storing vertex coordinates.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addVertex(Point2D position)` Adds a new vertex in this polygon
`double`	`area()` Computes the area of this polygon
`Box2D`	`boundingBox()` Returns the bounding box of this polygon.
`Point2D`	`centroid()` Computes the centroid of this polygon
`boolean`	`contains(Point2D point)` Checks if this polygon contains the query point.
`ij.gui.PolygonRoi`	`createRoi()` Converts this polygon into an ImageJ Polygon ROI.
`Point2D`	`getVertex(int index)` Returns index at the specific index
`Polygon2D`	`invert()` Computes the complementary polygon, whose interior is the exterior of this polygon.
`Iterator<Point2D>`	`iterator()`
`void`	`setVertex(int i, Point2D pos)` Changes vertex coordinate at the specified index
`double`	`signedArea()` Computes the signed area of this polygon
`int`	`vertexNumber()` Returns the number of vertices within this polygon
`ArrayList<Point2D>`	`vertices()`

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

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

- Constructor Detail
  - Polygon2D
```
public Polygon2D()
```
    Creates a new empty polygon.
  - Polygon2D
```
public Polygon2D(int n)
```
    Creates a new empty polygon by allocating enough space for storing vertex coordinates.
    
    Parameters:
    
    n - then number of vertices
  - Polygon2D
```
public Polygon2D(double[] xCoords,
                 double[] yCoords)
```
    Creates a new polygon from the coordinates of its vertices.
    
    Parameters:
    
    xCoords - the x-coordinates of the vertices
    
    yCoords - the y-coordinates of the vertices
  - Polygon2D
```
public Polygon2D(Collection<Point2D> vertices)
```
    Creates a new polygon from a collection of vertices. A new collection is created.
    
    Parameters:
    
    vertices - the polygon vertices
- Method Detail
  - boundingBox
```
public Box2D boundingBox()
```
    Returns the bounding box of this polygon.
    
    Returns:
    
    the bounding box of this polygon.
  - area
```
public double area()
```
    Computes the area of this polygon
    
    Returns:
    
    the area of this polygon
    
    See Also:
    
    signedArea()
  - signedArea
```
public double signedArea()
```
    Computes the signed area of this polygon
    
    Returns:
    
    the signed area of this polygon
    
    See Also:
    
    area()
  - centroid
```
public Point2D centroid()
```
    Computes the centroid of this polygon
    
    Returns:
    
    the centroid position of the polygon.
  - contains
```
public boolean contains(Point2D point)
```
    Checks if this polygon contains the query point. Uses winding number algorithm.
    
    Parameters:
    
    point - the polygon
    
    Returns:
    
    true if the polygon contains the query point
  - invert
```
public Polygon2D invert()
```
    Computes the complementary polygon, whose interior is the exterior of this polygon. Keeps the same vertex as initial vertex.
    
    Returns:
    
    the inverted polygon
  - createRoi
```
public ij.gui.PolygonRoi createRoi()
```
    Converts this polygon into an ImageJ Polygon ROI.
    
    Returns:
    
    the corresponding PolygonRoi
  - vertexNumber
```
public int vertexNumber()
```
    Returns the number of vertices within this polygon
    
    Returns:
    
    the number of vertices within this polygon
  - addVertex
```
public int addVertex(Point2D position)
```
    Adds a new vertex in this polygon
    
    Parameters:
    
    position - the position of the new vertex
    
    Returns:
    
    the index of the newly created vertex
  - getVertex
```
public Point2D getVertex(int index)
```
    Returns index at the specific index
    
    Parameters:
    
    index - vertex index
    
    Returns:
    
    the vertex at the specified index
  - setVertex
```
public void setVertex(int i,
                      Point2D pos)
```
    Changes vertex coordinate at the specified index
    
    Parameters:
    
    i - vertex index
    
    pos - the position of the new vertex
  - vertices
```
public ArrayList<Point2D> vertices()
```
    Returns:
    
    a reference to the inner array of vertices
  - iterator
```
public Iterator<Point2D> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Point2D>
    
    Returns:
    
    an iterator over the vertices of this polygon

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

boundingBox

area

signedArea

centroid

contains

invert

createRoi

vertexNumber

addVertex

getVertex

setVertex

vertices

iterator