org.mini2Dx.core.geom

Class RegularPolygon

java.lang.Object

org.mini2Dx.core.geom.Shape

org.mini2Dx.core.geom.RegularPolygon

Direct Known Subclasses:

EquilateralTriangle, RegularHexagon, RegularPentagon

public class RegularPolygon
extends Shape

A polygon that is both equilateral and equiangular. See Regular Polygon

Constructor Summary

Constructors

Constructor and Description
RegularPolygon(float centerX, float centerY, float radius, int totalSides, float rotationSymmetry) Constructor
RegularPolygon(RegularPolygon regularPolygon) Constructs a new RegularPolygon as a copy of another

Method Summary

Modifier and Type	Method and Description
boolean	contains(float x, float y) Returns if a set of coordinates are contained inside this Shape
boolean	contains(Shape shape) Returns if a Shape is contained inside this Shape
boolean	contains(com.badlogic.gdx.math.Vector2 vector2) Returns if a Vector2 is contained inside this Shape
Shape	copy() Returns an exact copy of this Shape
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 the distance from this Shape to a set of coordinates
float	getMaxX() Returns the right-most x coordinate
float	getMaxY() Returns the bottom-most y coordinate
float	getMinX() Returns the left-most x coordinate
float	getMinY() Returns the top-most y coordinate
int	getNumberOfSides() Returns the number of edges of this object
Polygon	getPolygon() Returns the Polygon representing this Shape
float	getRadius() Returns the radius of this RegularPolygon
float	getRotation() Returns the rotation of this Shape
float	getX() Returns the center X coordinate of this RegularPolygon
float	getX(int index) Returns the x coordinate of the corner at the specified index
float	getY() Returns the center Y coordinate of this RegularPolygon
float	getY(int index) Returns the y coordinate of the corner at the specified index
int	hashCode()
boolean	intersects(LineSegment lineSegment) Returns if this Shape intersects the specified LineSegment
boolean	intersects(Polygon polygon) Returns if this RegularPolygon intersects a Polygon
boolean	intersects(Rectangle rectangle) Returns if the specified Rectangle intersects this RegularPolygon
boolean	intersects(Shape shape) Returns if this Shape intersects another Shape
boolean	intersectsLineSegment(float x1, float y1, float x2, float y2) Returns if this Shape intersects a line segment
boolean	intersectsLineSegment(com.badlogic.gdx.math.Vector2 pointA, com.badlogic.gdx.math.Vector2 pointB) Returns if this Shape intersects a line segment
boolean	isCircle() Returns if this Shape is a Circle
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(float centerX, float centerY) Sets the center X and Y coordinates.
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 RegularPolygon Note: This operation is expensive
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	setX(float centerX) Sets the X coordinate of this RegularPolygon
void	setY(float centerY) Sets the Y coordinate of this RegularPolygon
void	translate(float translateX, float translateY) Translates the x and y coordinate of this object

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

add, getDistanceTo, subtract

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegularPolygon

public RegularPolygon(float centerX,
                      float centerY,
                      float radius,
                      int totalSides,
                      float rotationSymmetry)

Constructor

Parameters:

centerX - The center X coordinate

centerY - The center Y coordinate

radius - The distance from the center to the corner points

totalSides - The total sides of this shape

rotationSymmetry - The rotational symmetry of the corner points from the center

RegularPolygon

public RegularPolygon(RegularPolygon regularPolygon)

Constructs a new RegularPolygon as a copy of another

Parameters:

regularPolygon - The RegularPolygon to copy

Method Detail

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

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

intersects

public boolean intersects(Polygon polygon)

Returns if this RegularPolygon intersects a Polygon

Parameters:

polygon - The Polygon to check

Returns:

True if this RegularPolygon and Polygon intersect

intersects

public boolean intersects(Rectangle rectangle)

Returns if the specified Rectangle intersects this RegularPolygon

Parameters:

rectangle - The Rectangle to check

Returns:

True if this RegularPolygon and Rectangle intersect

contains

public boolean contains(float x,
                        float y)

Description copied from class: Shape

Returns if a set of coordinates are contained inside this Shape

Specified by:

contains in class 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(com.badlogic.gdx.math.Vector2 vector2)

Description copied from class: Shape

Returns if a Vector2 is contained inside this Shape

Specified by:

contains in class Shape

Parameters:

vector2 - The Vector2 to check

Returns:

True if this Shape contains the specified Vector2

contains

public boolean contains(Shape shape)

Description copied from class: Shape

Returns if a Shape is contained inside this Shape

Specified by:

contains in class Shape

Parameters:

shape - The Shape to check

Returns:

True if this Shape contains the specified Shape

intersects

public boolean intersects(Shape shape)

Description copied from class: Shape

Returns if this Shape intersects another Shape

Specified by:

intersects in class Shape

Parameters:

shape - The Shape to check

Returns:

True if this Shape intersects the specified Shape

intersects

public boolean intersects(LineSegment lineSegment)

Description copied from class: Shape

Returns if this Shape intersects the specified LineSegment

Overrides:

intersects in class Shape

Parameters:

lineSegment - The LineSegment to check

Returns:

True if this Shape intersects the LineSegment

intersectsLineSegment

public boolean intersectsLineSegment(com.badlogic.gdx.math.Vector2 pointA,
                                     com.badlogic.gdx.math.Vector2 pointB)

Description copied from class: Shape

Returns if this Shape intersects a line segment

Specified by:

intersectsLineSegment in class Shape

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 class: Shape

Returns if this Shape intersects a line segment

Specified by:

intersectsLineSegment in class Shape

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

getDistanceTo

public float getDistanceTo(float x,
                           float y)

Description copied from class: Shape

Returns the distance from this Shape to a set of coordinates

Specified by:

getDistanceTo in class Shape

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The distance

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

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

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

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 center X coordinate of this RegularPolygon

Specified by:

getX in class Shape

Returns:

The center X coordinate

setX

public void setX(float centerX)

Sets the X coordinate of this RegularPolygon

Specified by:

setX in class Shape

Parameters:

centerX - The center X coordinate

getY

public float getY()

Returns the center Y coordinate of this RegularPolygon

Specified by:

getY in class Shape

Returns:

The center Y coordinate

setY

public void setY(float centerY)

Sets the Y coordinate of this RegularPolygon

Specified by:

setY in class Shape

Parameters:

centerY - The center Y coordinate

set

public void set(float centerX,
                float centerY)

Sets the center X and Y coordinates. Faster than calling setX(float) and setY(float) separately.

Specified by:

set in class Shape

Parameters:

centerX - The center X coordinate

centerY - The center Y coordinate

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

getRadius

public float getRadius()

Returns the radius of this RegularPolygon

Returns:

The distance between the center and its corners

setRadius

public void setRadius(float radius)

Sets the radius of this RegularPolygon Note: This operation is expensive

Specified by:

setRadius in class Shape

Parameters:

radius - The distance between the center and its corners

scale

public void scale(float scale)

Description copied from class: Shape

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.

Specified by:

scale in class Shape

Parameters:

scale - The amount to scale by (e.g. 2.0 = double the size)

getX

public float getX(int index)

Returns the x coordinate of the corner at the specified index

Parameters:

index - The index where 0 = the top corner and increments in a clockwise method

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 index where 0 = the top corner and increments in a clockwise method

Returns:

The y coordinate of the corner

getNumberOfSides

public int getNumberOfSides()

Description copied from class: Shape

Returns the number of edges of this object

Specified by:

getNumberOfSides in class Shape

Returns:

The number of sides/edges

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

isCircle

public boolean isCircle()

Description copied from class: Shape

Returns if this Shape is a Circle

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 class Shape

Returns:

Null if this Shape is a Circle

getMinX

public float getMinX()

Description copied from class: Shape

Returns the left-most x coordinate

Specified by:

getMinX in class Shape

Returns:

getMinY

public float getMinY()

Description copied from class: Shape

Returns the top-most y coordinate

Specified by:

getMinY in class Shape

Returns:

getMaxX

public float getMaxX()

Description copied from class: Shape

Returns the right-most x coordinate

Specified by:

getMaxX in class Shape

Returns:

getMaxY

public float getMaxY()

Description copied from class: Shape

Returns the bottom-most y coordinate

Specified by:

getMaxY in class Shape

Returns:

getCenterX

public float getCenterX()

Description copied from class: Shape

Returns the center x coordinate of this object. Note for Circle this is the same as x.

Specified by:

getCenterX in class Shape

Returns:

0 by default

getCenterY

public float getCenterY()

Description copied from class: Shape

Returns the center y coordinate of this object. Note for Circle this is the same as y.

Specified by:

getCenterY in class Shape

Returns:

0 by default

setCenter

public void setCenter(float x,
                      float y)

Description copied from class: Shape

Sets the center x,y coordinate of this object

Specified by:

setCenter in class Shape

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 class: Shape

Sets the center x coordinate

Specified by:

setCenterX in class Shape

Parameters:

x - The x coordinate of the shape's center

setCenterY

public void setCenterY(float y)

Description copied from class: Shape

Sets the center y coordianate

Specified by:

setCenterY in class Shape

Parameters:

y - The y coordinate of the shape's center

hashCode

public int hashCode()

Overrides:

hashCode in class Shape

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Shape