Polygon (mini2Dx)

java.lang.Object
- org.mini2Dx.core.geom.Shape
- - org.mini2Dx.core.geom.Polygon

All Implemented Interfaces:

Positionable, Sizeable

Direct Known Subclasses:

CollisionPolygon
```
public class Polygon
extends Shape
```
Implements a rotatable polygon. Adds extra functionality to the default polygon implementation in LibGDX

Field Summary
- Fields inherited from class org.mini2Dx.core.geom.Shape
  geometry, positionChangeListeners, sizeChangeListeners

Constructor Summary

Constructors
Constructor and Description
`Polygon(float[] vertices)` Constructor.
`Polygon(Geometry geometry, float[] vertices)` Constructs a `Polygon` belonging to the `Geometry` pool
`Polygon(org.mini2Dx.gdx.math.Vector2[] points)` Constructor with vectors.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint(float x, float y)` Adds an additional point to this `Polygon`
`void`	`addPoint(org.mini2Dx.gdx.math.Vector2 point)` Adds an additional point to this `Polygon`
`boolean`	`contains(float x, float y)` Returns if a set of coordinates are contained inside this shape
`boolean`	`contains(Polygon polygon)`
`boolean`	`contains(Sizeable shape)` Returns if this shape contains the specified shape
`boolean`	`contains(org.mini2Dx.gdx.math.Vector2 vector2)` Returns if a `Vector2` is contained inside this shape
`Shape`	`copy()` Returns an exact copy of this `Shape`
`void`	`dispose()` Releases this `Shape` back to the `Geometry` pool (if it was created from the pool)
`void`	`draw(Graphics g)` Draws this shape using a `Graphics` instance
`EdgeIterator`	`edgeIterator()` Returns an `EdgeIterator` for looping over the edges of this `Shape`
`boolean`	`equals(java.lang.Object obj)`
`void`	`fill(Graphics g)` Fills this shape using a `Graphics` instance
`float`	`getCenterX()` Returns the center x coordinate of this object.
`float`	`getCenterY()` Returns the center y coordinate of this object.
`float`	`getDistanceTo(float x, float y)` Returns this distance between this object's x,y coordinates and the provided xy coordinates
`float`	`getHeight()` Returns the height of this object
`float`	`getMaxX()` Returns max X coordinate of this `Polygon`
`float`	`getMaxY()` Returns max Y coordinate of this `Polygon`
`float`	`getMinX()` Returns min X coordinate of this `Polygon`
`float`	`getMinY()` Returns min Y coordinate of this `Polygon`
`int`	`getNumberOfSides()` Returns the number of edges of this object
`Polygon`	`getPolygon()` Returns the `Polygon` representing this `Shape`
`float`	`getRotation()` Returns the rotation of this `Shape`
`org.mini2Dx.gdx.utils.ShortArray`	`getTriangles()` Returns an array of vertex indices that the define the triangles which make up this `Polygon`
`float[]`	`getVertices()`
`float`	`getWidth()` Returns the width of this object
`float`	`getX()` Returns the x coordinate
`float`	`getX(int index)` Returns the x coordinate of the corner at the specified index
`float`	`getY()` Returns the y coordinate
`float`	`getY(int index)` Returns the y coordinate of the corner at the specified index
`int`	`hashCode()`
`boolean`	`intersects(Circle circle)`
`boolean`	`intersects(LineSegment lineSegment)` Returns if this `Shape` intersects the specified `LineSegment`
`boolean`	`intersects(Polygon polygon)` Returns if this `Polygon` intersects another
`boolean`	`intersects(Rectangle rectangle)` Returns if the specified `Rectangle` intersects this `Polygon`
`boolean`	`intersects(Sizeable shape)` Returns if this shape intersects a shape
`boolean`	`intersects(Triangle triangle)` Returns if this `Polygon` intersects a `Triangle`
`boolean`	`intersectsLineSegment(float x1, float y1, float x2, float y2)` Returns if this shape intersects a line segment
`boolean`	`intersectsLineSegment(org.mini2Dx.gdx.math.Vector2 pointA, org.mini2Dx.gdx.math.Vector2 pointB)` Returns if this shape intersects a line segment
`boolean`	`isCircle()` Returns if this `Shape` is a `Circle`
`boolean`	`isEquilateral()`
`boolean`	`isEquilateral(float tolerance)`
`boolean`	`isRectangle()`
`boolean`	`isSameAs(Polygon polygon)` Returns if this `Polygon` is the same as another
`Polygon`	`lerp(Polygon target, float alpha)`
`void`	`removePoint(float x, float y)` Removes a point from this `Polygon`
`void`	`removePoint(org.mini2Dx.gdx.math.Vector2 point)` Removes a point from this `Polygon`
`void`	`rotate(float degrees)` Rotates this `Shape` by a specified amount of degrees with its first point as the origin
`void`	`rotateAround(float centerX, float centerY, float degrees)` Rotates this `Shape` by a specified amount of degrees around a specified point
`void`	`scale(float scale)` Scales the radius of this shape.
`void`	`set(Polygon polygon)`
`void`	`setCenter(float x, float y)` Sets the center x,y coordinate of this object
`void`	`setCenterX(float x)` Sets the center x coordinate
`void`	`setCenterY(float y)` Sets the center y coordianate
`void`	`setRadius(float radius)` Sets the radius of this shape.
`void`	`setRotation(float degrees)` Sets the rotation of this `Shape` with its first point as the origin
`void`	`setRotationAround(float centerX, float centerY, float degrees)` Sets the rotation of this `Shape` with a specified point as the origin
`void`	`setVertices(float[] vertices)`
`void`	`setVertices(org.mini2Dx.gdx.math.Vector2[] vertices)`
`void`	`setX(float x)` Sets the x coordinate of this object
`void`	`setXY(float x, float y)` Sets the x and y coordinate of this object
`void`	`setY(float y)` Sets the y coordinate of this object
`protected float`	`sign(float x, float y, float p1x, float p1y, float p2x, float p2y)`
`java.lang.String`	`toString()`
`void`	`translate(float translateX, float translateY)` Translates the x and y coordinate of this object
`protected boolean`	`triangleContains(float x, float y, float p1x, float p1y, float p2x, float p2y, float p3x, float p3y)`

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

- Constructor Detail
  - Polygon
```
public Polygon(Geometry geometry,
               float[] vertices)
```
    Constructs a Polygon belonging to the Geometry pool
    
    Parameters:
    
    geometry - The Geometry pool
    
    vertices - The vertices
  - Polygon
```
public Polygon(float[] vertices)
```
    Constructor. Note that vertices must be in a clockwise order for performance and accuracy.
    
    Parameters:
    
    vertices - All points in x,y pairs. E.g. x1,y1,x2,y2,etc.
  - Polygon
```
public Polygon(org.mini2Dx.gdx.math.Vector2[] points)
```
    Constructor with vectors. Note that vectors must be in a clockwise order for performance and accuracy.
    
    Parameters:
    
    points - All points in the polygon
- Method Detail
  - dispose
```
public void dispose()
```
    Description copied from class: Shape
    
    Releases this Shape back to the Geometry pool (if it was created from the pool)
    
    Specified by:
    
    dispose in class Shape
  - isSameAs
```
public boolean isSameAs(Polygon polygon)
```
    Returns if this Polygon is the same as another
    
    Parameters:
    
    polygon - The Polygon to compare to
    
    Returns:
    
    True if the vertices match
  - lerp
```
public Polygon lerp(Polygon target,
                    float alpha)
```
  - copy
```
public Shape copy()
```
    Description copied from class: Shape
    
    Returns an exact copy of this Shape
    
    Specified by:
    
    copy in class Shape
    
    Returns:
    
    A copy (new) instance of this Shape
  - triangleContains
```
protected boolean triangleContains(float x,
                                   float y,
                                   float p1x,
                                   float p1y,
                                   float p2x,
                                   float p2y,
                                   float p3x,
                                   float p3y)
```
  - sign
```
protected float sign(float x,
                     float y,
                     float p1x,
                     float p1y,
                     float p2x,
                     float p2y)
```
  - contains
```
public boolean contains(float x,
                        float y)
```
    Description copied from interface: Sizeable
    
    Returns if a set of coordinates are contained inside this shape
    
    Parameters:
    
    x - The x coordinate to check
    
    y - The y coordinate to check
    
    Returns:
    
    True if this shape contains the specified coordinates
  - contains
```
public boolean contains(org.mini2Dx.gdx.math.Vector2 vector2)
```
    Description copied from interface: Sizeable
    
    Returns if a Vector2 is contained inside this shape
    
    Parameters:
    
    vector2 - The Vector2 to check
    
    Returns:
    
    True if this shape contains the specified Vector2
  - contains
```
public boolean contains(Sizeable shape)
```
    Description copied from interface: Sizeable
    
    Returns if this shape contains the specified shape
    
    Parameters:
    
    shape - The Sizeable to check
    
    Returns:
    
    True if this Sizeable is inside this shape
  - contains
```
public boolean contains(Polygon polygon)
```
  - intersects
```
public boolean intersects(Sizeable shape)
```
    Description copied from interface: Sizeable
    
    Returns if this shape intersects a shape
    
    Parameters:
    
    shape - The Sizeable to check
    
    Returns:
    
    True if this shape intersects the specified Sizeable
  - intersects
```
public boolean intersects(Polygon polygon)
```
    Returns if this Polygon intersects another
    
    Parameters:
    
    polygon - The other Polygon
    
    Returns:
    
    True if the two Polygons intersect
  - intersects
```
public boolean intersects(Triangle triangle)
```
    Returns if this Polygon intersects a Triangle
    
    Parameters:
    
    triangle - The Triangle to check
    
    Returns:
    
    True if this Polygon and Triangle intersect
  - intersects
```
public boolean intersects(Rectangle rectangle)
```
    Returns if the specified Rectangle intersects this Polygon
    
    Parameters:
    
    rectangle - The Rectangle to check
    
    Returns:
    
    True if this Polygon and Rectangle intersect
  - intersects
```
public boolean intersects(Circle circle)
```
  - intersects
```
public boolean intersects(LineSegment lineSegment)
```
    Description copied from class: Shape
    
    Returns if this Shape intersects the specified LineSegment
    
    Specified by:
    
    intersects in interface Sizeable
    
    Overrides:
    
    intersects in class Shape
    
    Parameters:
    
    lineSegment - The LineSegment to check
    
    Returns:
    
    True if this Shape intersects the LineSegment
  - intersectsLineSegment
```
public boolean intersectsLineSegment(org.mini2Dx.gdx.math.Vector2 pointA,
                                     org.mini2Dx.gdx.math.Vector2 pointB)
```
    Description copied from interface: Sizeable
    
    Returns if this shape intersects a line segment
    
    Parameters:
    
    pointA - The first point in the line segment
    
    pointB - The second point in the line segment
    
    Returns:
    
    True if this shape intersects the line segment
  - intersectsLineSegment
```
public boolean intersectsLineSegment(float x1,
                                     float y1,
                                     float x2,
                                     float y2)
```
    Description copied from interface: Sizeable
    
    Returns if this shape intersects a line segment
    
    Parameters:
    
    x1 - The x coordinate of the first point
    
    y1 - The y coordinate of the first point
    
    x2 - The x coordinate of the second point
    
    y2 - The y coordinate of the second point
    
    Returns:
    
    True if this shape intersects the line segment
  - getWidth
```
public float getWidth()
```
    Description copied from interface: Sizeable
    
    Returns the width of this object
    
    Returns:
    
    0 by default
  - getHeight
```
public float getHeight()
```
    Description copied from interface: Sizeable
    
    Returns the height of this object
    
    Returns:
    
    0 by default
  - getDistanceTo
```
public float getDistanceTo(float x,
                           float y)
```
    Description copied from interface: Positionable
    
    Returns this distance between this object's x,y coordinates and the provided xy coordinates
    
    Parameters:
    
    x - The x coordinate to measure distance to
    
    y - The y coordinate to measure distance to
    
    Returns:
    
    0 if the xy coordinates are the same
  - addPoint
```
public void addPoint(float x,
                     float y)
```
    Adds an additional point to this Polygon
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
  - addPoint
```
public void addPoint(org.mini2Dx.gdx.math.Vector2 point)
```
    Adds an additional point to this Polygon
    
    Parameters:
    
    point - The point to add as a Vector2
  - removePoint
```
public void removePoint(float x,
                        float y)
```
    Removes a point from this Polygon
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
  - removePoint
```
public void removePoint(org.mini2Dx.gdx.math.Vector2 point)
```
    Removes a point from this Polygon
    
    Parameters:
    
    point - The point to remove as a Vector2
  - getNumberOfSides
```
public int getNumberOfSides()
```
    Description copied from class: Shape
    
    Returns the number of edges of this object
    
    Specified by:
    
    getNumberOfSides in interface Sizeable
    
    Specified by:
    
    getNumberOfSides in class Shape
    
    Returns:
    
    The number of sides/edges
  - draw
```
public void draw(Graphics g)
```
    Description copied from class: Shape
    
    Draws this shape using a Graphics instance
    
    Specified by:
    
    draw in class Shape
    
    Parameters:
    
    g - The Graphics context to render with
  - fill
```
public void fill(Graphics g)
```
    Description copied from class: Shape
    
    Fills this shape using a Graphics instance
    
    Specified by:
    
    fill in class Shape
    
    Parameters:
    
    g - The Graphics context to render with
  - getVertices
```
public float[] getVertices()
```
  - setVertices
```
public void setVertices(float[] vertices)
```
  - setVertices
```
public void setVertices(org.mini2Dx.gdx.math.Vector2[] vertices)
```
  - getRotation
```
public float getRotation()
```
    Description copied from class: Shape
    
    Returns the rotation of this Shape
    
    Specified by:
    
    getRotation in class Shape
    
    Returns:
    
    The rotation in degrees
  - setRotation
```
public void setRotation(float degrees)
```
    Description copied from class: Shape
    
    Sets the rotation of this Shape with its first point as the origin
    
    Specified by:
    
    setRotation in class Shape
    
    Parameters:
    
    degrees - The rotation in degrees
  - rotate
```
public void rotate(float degrees)
```
    Description copied from class: Shape
    
    Rotates this Shape by a specified amount of degrees with its first point as the origin
    
    Specified by:
    
    rotate in class Shape
    
    Parameters:
    
    degrees - The rotation in degrees
  - setRotationAround
```
public void setRotationAround(float centerX,
                              float centerY,
                              float degrees)
```
    Description copied from class: Shape
    
    Sets the rotation of this Shape with a specified point as the origin
    
    Specified by:
    
    setRotationAround in class Shape
    
    Parameters:
    
    centerX - The origin/center x coordinate
    
    centerY - The origin/center y coordinate
    
    degrees - The rotation in degrees
  - rotateAround
```
public void rotateAround(float centerX,
                         float centerY,
                         float degrees)
```
    Description copied from class: Shape
    
    Rotates this Shape by a specified amount of degrees around a specified point
    
    Specified by:
    
    rotateAround in class Shape
    
    Parameters:
    
    centerX - The origin/center x coordinate
    
    centerY - The origin/center y coordinate
    
    degrees - The rotation in degrees
  - getX
```
public float getX()
```
    Returns the x coordinate
    
    Returns:
    
    The x coordinate of the first point in this Polygon
  - getY
```
public float getY()
```
    Returns the y coordinate
    
    Returns:
    
    The y coordinate of the first point in this Polygon
  - getX
```
public float getX(int index)
```
    Returns the x coordinate of the corner at the specified index
    
    Parameters:
    
    index - The point index
    
    Returns:
    
    The x coordinate of the corner
  - getY
```
public float getY(int index)
```
    Returns the y coordinate of the corner at the specified index
    
    Parameters:
    
    index - The point index
    
    Returns:
    
    The y coordinate of the corner
  - getCenterX
```
public float getCenterX()
```
    Description copied from interface: Sizeable
    
    Returns the center x coordinate of this object. Note for Circle this is the same as x.
    
    Returns:
    
    0 by default
  - getCenterY
```
public float getCenterY()
```
    Description copied from interface: Sizeable
    
    Returns the center y coordinate of this object. Note for Circle this is the same as y.
    
    Returns:
    
    0 by default
  - setCenter
```
public void setCenter(float x,
                      float y)
```
    Description copied from interface: Sizeable
    
    Sets the center x,y coordinate of this object
    
    Parameters:
    
    x - The x coordinate of the shape's center
    
    y - The y coordinate of the shape's center
  - setCenterX
```
public void setCenterX(float x)
```
    Description copied from interface: Sizeable
    
    Sets the center x coordinate
    
    Parameters:
    
    x - The x coordinate of the shape's center
  - setCenterY
```
public void setCenterY(float y)
```
    Description copied from interface: Sizeable
    
    Sets the center y coordianate
    
    Parameters:
    
    y - The y coordinate of the shape's center
  - getMinX
```
public float getMinX()
```
    Returns min X coordinate of this Polygon
    
    Returns:
    
    The left-most x coordinate
  - getMinY
```
public float getMinY()
```
    Returns min Y coordinate of this Polygon
    
    Returns:
    
    The up-most y coordinate
  - getMaxX
```
public float getMaxX()
```
    Returns max X coordinate of this Polygon
    
    Returns:
    
    The right-most x coordinate
  - getMaxY
```
public float getMaxY()
```
    Returns max Y coordinate of this Polygon
    
    Returns:
    
    The bottom-most y coordinate
  - getTriangles
```
public org.mini2Dx.gdx.utils.ShortArray getTriangles()
```
    Returns an array of vertex indices that the define the triangles which make up this Polygon
    
    Returns:
    
    Array of triangle indices
  - setX
```
public void setX(float x)
```
    Description copied from interface: Positionable
    
    Sets the x coordinate of this object
    
    Parameters:
    
    x - The x coordinate
  - setY
```
public void setY(float y)
```
    Description copied from interface: Positionable
    
    Sets the y coordinate of this object
    
    Parameters:
    
    y - The y coordinate
  - setXY
```
public void setXY(float x,
                  float y)
```
    Description copied from interface: Positionable
    
    Sets the x and y coordinate of this object
    
    Parameters:
    
    x - The x coordinate
    
    y - The y coordinate
  - setRadius
```
public void setRadius(float radius)
```
    Description copied from interface: Sizeable
    
    Sets the radius of this shape. For Polygon shapes, this will stretch in/out the shape from its center. Note that Polygons must be equilateral.
    
    Parameters:
    
    radius - The radius in pixels
  - scale
```
public void scale(float scale)
```
    Description copied from interface: Sizeable
    
    Scales the radius of this shape. For Polygon shapes, this will stretch in/out the shape from its center. Note that Polygons must be equilateral.
    
    Parameters:
    
    scale - The amount to scale by (e.g. 2.0 = double the size)
  - set
```
public void set(Polygon polygon)
```
  - translate
```
public void translate(float translateX,
                      float translateY)
```
    Description copied from class: Shape
    
    Translates the x and y coordinate of this object
    
    Specified by:
    
    translate in class Shape
    
    Parameters:
    
    translateX - The x translation amount
    
    translateY - The y translation amount
  - edgeIterator
```
public EdgeIterator edgeIterator()
```
    Description copied from class: Shape
    
    Returns an EdgeIterator for looping over the edges of this Shape
    
    Specified by:
    
    edgeIterator in class Shape
    
    Returns:
    
    The EdgeIterator
  - isEquilateral
```
public boolean isEquilateral()
```
  - isEquilateral
```
public boolean isEquilateral(float tolerance)
```
  - isRectangle
```
public boolean isRectangle()
```
  - isCircle
```
public boolean isCircle()
```
    Description copied from class: Shape
    
    Returns if this Shape is a Circle
    
    Specified by:
    
    isCircle in interface Sizeable
    
    Specified by:
    
    isCircle in class Shape
    
    Returns:
    
    True if this Shape is a Circle
  - getPolygon
```
public Polygon getPolygon()
```
    Description copied from class: Shape
    
    Returns the Polygon representing this Shape
    
    Specified by:
    
    getPolygon in interface Sizeable
    
    Specified by:
    
    getPolygon in class Shape
    
    Returns:
    
    Null if this Shape is a Circle
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Shape
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class Shape
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Polygon

Field Summary

Fields inherited from class org.mini2Dx.core.geom.Shape

Constructor Summary

Method Summary

Methods inherited from class org.mini2Dx.core.geom.Shape

Methods inherited from class java.lang.Object

Constructor Detail

Polygon

Polygon

Polygon

Method Detail

dispose

isSameAs

lerp

copy

triangleContains

sign

contains

contains

contains

contains

intersects

intersects

intersects

intersects

intersects

intersects

intersectsLineSegment

intersectsLineSegment

getWidth

getHeight

getDistanceTo

addPoint

addPoint

removePoint

removePoint

getNumberOfSides

draw

fill

getVertices

setVertices

setVertices

getRotation

setRotation

rotate

setRotationAround

rotateAround

getX

getY

getX

getY

getCenterX

getCenterY

setCenter

setCenterX

setCenterY

getMinX

getMinY

getMaxX

getMaxY

getTriangles

setX

setY

setXY

setRadius

scale

set

translate

edgeIterator

isEquilateral

isEquilateral

isRectangle

isCircle

getPolygon

hashCode

equals

toString