IlvPolygon2D (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.util.java2d.IlvPolygon2D

All Implemented Interfaces:

Shape, Cloneable

Direct Known Subclasses:

IlvPolygon2D.Double, IlvPolygon2D.Float
```
public abstract class IlvPolygon2D
extends Object
implements Shape, Cloneable
```
An IlvPolygon2D instance describes a closed (circular) polyline with no specific starting or end points, in other words, a polygon. The coordinates of the points can be of type float or double. The polygon uses the even-odd winding rule to test for containment (see WIND_EVEN_ODD).

Since:

JViews 8.5

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IlvPolygon2D.Double` The `Double` class defines a polygon with `double` coordinates.
`static class`	`IlvPolygon2D.Float` The `Float` class defines a polygon with `float` coordinates.

Constructor Summary

Constructors
Modifier Constructor and Description

protected IlvPolygon2D()
This class is abstract.

Constructors
Modifier	Constructor and Description
`protected`	`IlvPolygon2D()` This class is abstract.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(double x, double y)` Determines whether a point is contained in this `Shape`.
`boolean`	`contains(double x, double y, double width, double height)` Determines whether a rectangle is contained in this `Shape`.
`boolean`	`contains(Point2D p)` Determines whether a point is contained in this `Shape`.
`boolean`	`contains(Rectangle2D r)` Determines whether a rectangle is contained in this `Shape`.
`boolean`	`containsInClosure(double x, double y)` Determines whether a point is contained in this polygon (inside or on the border).
`boolean`	`containsInConvexHull(Point2D point)` Determines whether a point is contained in the convex hull of this polygon.
`boolean`	`containsInInterior(double x, double y)` Determines whether a point is contained in the inside area of this polygon.
`boolean`	`equals(Object other)`
`double`	`getArea()` Returns the area covered by the polygon.
`Rectangle`	`getBounds()` Returns the smallest integer rectangle covering all points.
`abstract Rectangle2D`	`getBounds2D()` Returns the smallest rectangle covering all points.
`Point2D`	`getGravity0()` Returns the center of gravity of all points.
`Point2D`	`getGravity1()` Returns the center of gravity of all segments.
`Point2D`	`getGravity2()` Returns the gravity center of the area covered by the polygon.
`abstract int`	`getNumberOfPoints()` Returns the number of points in the polygon.
`PathIterator`	`getPathIterator(AffineTransform transform)` Returns an iterator that runs along the boundary of this `Shape`.
`PathIterator`	`getPathIterator(AffineTransform at, double flatness)` Returns an iterator that runs along a flattened boundary of this `Shape`.
`abstract Point2D`	`getPoint(int index)` Returns a specific point (0 <= index < getNumberOfPoints()).
`abstract Point2D[]`	`getPoints()` Returns the array of points.
`boolean`	`intersects(double x, double y, double width, double height)` Determines whether a rectangle has points in common with this `Shape`.
`boolean`	`intersects(Rectangle2D r)` Determines whether a rectangle has points in common with this `Shape`.
`String`	`toString()` Returns a string representation of this polygon.

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

- Constructor Detail
  - IlvPolygon2D
```
protected IlvPolygon2D()
```
    This class is abstract. To create an instance, create an instance of IlvPolygon2D.Float or IlvPolygon2D.Double.
- Method Detail
  - getNumberOfPoints
```
public abstract int getNumberOfPoints()
```
    Returns the number of points in the polygon.
    
    Returns:
    
    A positive integer.
  - getPoint
```
public abstract Point2D getPoint(int index)
```
    Returns a specific point (0 <= index < getNumberOfPoints()). The point should not be modified.
  - getPoints
```
public abstract Point2D[] getPoints()
```
    Returns the array of points. Neither the array nor the points contained therein should be modified.
  - getBounds
```
public Rectangle getBounds()
```
    Returns the smallest integer rectangle covering all points.
    
    Specified by:
    
    getBounds in interface Shape
  - getBounds2D
```
public abstract Rectangle2D getBounds2D()
```
    Returns the smallest rectangle covering all points.
    
    Specified by:
    
    getBounds2D in interface Shape
  - containsInInterior
```
public boolean containsInInterior(double x,
                                  double y)
```
    Determines whether a point is contained in the inside area of this polygon.
    
    Parameters:
    
    x - The x coordinate of the point to be tested.
    
    y - The y coordinate of the point to be tested.
  - containsInClosure
```
public boolean containsInClosure(double x,
                                 double y)
```
    Determines whether a point is contained in this polygon (inside or on the border).
    
    Parameters:
    
    x - The x coordinate of the point to be tested.
    
    y - The y coordinate of the point to be tested.
  - contains
```
public boolean contains(double x,
                        double y)
```
    Determines whether a point is contained in this Shape.
    
    Specified by:
    
    contains in interface Shape
    
    Parameters:
    
    x - The x coordinate of the point to be tested.
    
    y - The y coordinate of the point to be tested.
  - contains
```
public boolean contains(Point2D p)
```
    Determines whether a point is contained in this Shape.
    
    Specified by:
    
    contains in interface Shape
    
    Parameters:
    
    p - The point to be tested.
  - intersects
```
public boolean intersects(double x,
                          double y,
                          double width,
                          double height)
```
    Determines whether a rectangle has points in common with this Shape.
    
    Specified by:
    
    intersects in interface Shape
  - intersects
```
public boolean intersects(Rectangle2D r)
```
    Determines whether a rectangle has points in common with this Shape.
    
    Specified by:
    
    intersects in interface Shape
  - contains
```
public boolean contains(double x,
                        double y,
                        double width,
                        double height)
```
    Determines whether a rectangle is contained in this Shape.
    
    Specified by:
    
    contains in interface Shape
  - contains
```
public boolean contains(Rectangle2D r)
```
    Determines whether a rectangle is contained in this Shape.
    
    Specified by:
    
    contains in interface Shape
  - getPathIterator
```
public PathIterator getPathIterator(AffineTransform transform)
```
    Returns an iterator that runs along the boundary of this Shape.
    
    Specified by:
    
    getPathIterator in interface Shape
  - getPathIterator
```
public PathIterator getPathIterator(AffineTransform at,
                                    double flatness)
```
    Returns an iterator that runs along a flattened boundary of this Shape.
    
    Specified by:
    
    getPathIterator in interface Shape
  - containsInConvexHull
```
public boolean containsInConvexHull(Point2D point)
```
    Determines whether a point is contained in the convex hull of this polygon.
    
    Parameters:
    
    point - The point to be tested.
  - getArea
```
public double getArea()
```
    Returns the area covered by the polygon. This is positive if the polygon turns right, negative if it turns left, and may even be zero if the polygon crosses itself.
  - getGravity0
```
public Point2D getGravity0()
```
    Returns the center of gravity of all points.
  - getGravity1
```
public Point2D getGravity1()
```
    Returns the center of gravity of all segments.
  - getGravity2
```
public Point2D getGravity2()
```
    Returns the gravity center of the area covered by the polygon.
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Returns a string representation of this polygon.
    
    Overrides:
    
    toString in class Object

Class IlvPolygon2D

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvPolygon2D

Method Detail

getNumberOfPoints

getPoint

getPoints

getBounds

getBounds2D

containsInInterior

containsInClosure

contains

contains

intersects

intersects

contains

contains

getPathIterator

getPathIterator

containsInConvexHull

getArea

getGravity0

getGravity1

getGravity2

equals

toString