libGDX 1.14.2 · com.badlogic.gdx.math.Polygon · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Rectangle	bounds
private boolean	dirty
private float[]	localVertices
private float	originX
private float	originY
private float	rotation
private float	scaleX
private float	scaleY
private float[]	worldVertices
private float	x
private float	y

Access	Constructor and Description
public	Polygon() Constructs a new polygon with no vertices.
public	Polygon(float[] an array where every even element represents the horizontal part of a point, and the following element representing the vertical part vertices) Constructs a new polygon from a float array of parts of vertex points.

Method Summary

Modifier and Type	Method and Description
public float	area() Returns the area contained within the polygon.
public boolean	contains(float x, float y) Implements com.badlogic.gdx.math.Shape2D.contains. Returns whether an x, y pair is contained within the polygon.
public boolean	contains(Vector2 point) Implements com.badlogic.gdx.math.Shape2D.contains. Returns whether the given point is contained within the shape.
public void	dirty() Sets the polygon's world vertices to be recalculated when calling `getTransformedVertices`.
public Rectangle	Returns: this polygon's bounding box `Rectangle` getBoundingRectangle() Returns an axis-aligned bounding box of this polygon.
public Vector2	getCentroid(Vector2 centroid)
public float	getOriginX() Returns the x-coordinate of the polygon's origin point.
public float	getOriginY() Returns the y-coordinate of the polygon's origin point.
public float	getRotation() Returns the total rotation applied to the polygon.
public float	getScaleX() Returns the total horizontal scaling applied to the polygon.
public float	getScaleY() Returns the total vertical scaling applied to the polygon.
public float[]	Returns: vertices scaled, rotated, and offset by the polygon position. getTransformedVertices() Calculates and returns the vertices of the polygon after scaling, rotation, and positional translations have been applied, as they are position within the world.
public Vector2	getVertex(int vertexNum, Vector2 pos) Returns: Position(transformed) of vertex
public int	getVertexCount()
public float[]	getVertices() Returns the polygon's local vertices without scaling or rotation and without being offset by the polygon position.
public float	getX() Returns the x-coordinate of the polygon's position within the world.
public float	getY() Returns the y-coordinate of the polygon's position within the world.
public void	resetTransformations()
public void	rotate(float degrees) Applies additional rotation to the polygon by the supplied degrees.
public void	scale(float amount) Applies additional scaling to the polygon by the supplied amount.
public void	setOrigin(float originX, float originY) Sets the origin point to which all of the polygon's local vertices are relative to.
public void	setPosition(float x, float y) Sets the polygon's position within the world.
public void	setRotation(float degrees) Sets the polygon to be rotated by the supplied degrees.
public void	setScale(float scaleX, float scaleY) Sets the amount of scaling to be applied to the polygon.
public void	setVertex(int min=0, max=vertices.length/2-1 vertexNum, float x, float y) Set vertex position
public void	setVertices(float[] float array where every even element represents the x-coordinate of a vertex, and the proceeding element representing the y-coordinate. vertices) Sets the polygon's local vertices relative to the origin point, without any scaling, rotating or translations being applied.
public void	translate(float x, float y) Translates the polygon's position by the specified horizontal and vertical amounts.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

bounds	back to summary
private Rectangle bounds

dirty	back to summary
private boolean dirty

localVertices	back to summary
private float[] localVertices

originX	back to summary
private float originX

originY	back to summary
private float originY

rotation	back to summary
private float rotation

scaleX	back to summary
private float scaleX

scaleY	back to summary
private float scaleY

worldVertices	back to summary
private float[] worldVertices

x	back to summary
private float x

y	back to summary
private float y

Polygon	back to summary
public Polygon() Constructs a new polygon with no vertices.

Polygon	back to summary
public Polygon(float[] vertices) Constructs a new polygon from a float array of parts of vertex points. Parameters vertices:float[] an array where every even element represents the horizontal part of a point, and the following element representing the vertical part Exceptions IllegalArgumentException: if less than 6 elements, representing 3 points, are provided

Method Detail

area	back to summary
public float area() Returns the area contained within the polygon.

contains	back to summary
public boolean contains(float x, float y) Implements com.badlogic.gdx.math.Shape2D.contains. Returns whether an x, y pair is contained within the polygon. Annotations @Override

contains

back to summary

public boolean contains(float x, float y)

Implements com.badlogic.gdx.math.Shape2D.contains.

Returns whether an x, y pair is contained within the polygon.

Annotations

@Override

contains	back to summary
public boolean contains(Vector2 point) Implements com.badlogic.gdx.math.Shape2D.contains. Doc from com.badlogic.gdx.math.Shape2D.contains. Returns whether the given point is contained within the shape. Annotations @Override

contains

back to summary

public boolean contains(Vector2 point)

Implements com.badlogic.gdx.math.Shape2D.contains.

Doc from com.badlogic.gdx.math.Shape2D.contains.

Returns whether the given point is contained within the shape.

Annotations

@Override

dirty	back to summary
public void dirty() Sets the polygon's world vertices to be recalculated when calling `getTransformedVertices`.

getBoundingRectangle back to summary

getBoundingRectangle	back to summary
public Rectangle getBoundingRectangle() Returns an axis-aligned bounding box of this polygon. Note the returned Rectangle is cached in this polygon, and will be reused if this Polygon is changed. Returns:Rectangle this polygon's bounding box `Rectangle`

public Rectangle getBoundingRectangle()

Returns an axis-aligned bounding box of this polygon. Note the returned Rectangle is cached in this polygon, and will be reused if this Polygon is changed.

Returns:Rectangle: this polygon's bounding box Rectangle

getCentroid	back to summary
public Vector2 getCentroid(Vector2 centroid)

getOriginX	back to summary
public float getOriginX() Returns the x-coordinate of the polygon's origin point.

getOriginY	back to summary
public float getOriginY() Returns the y-coordinate of the polygon's origin point.

getRotation	back to summary
public float getRotation() Returns the total rotation applied to the polygon.

getScaleX	back to summary
public float getScaleX() Returns the total horizontal scaling applied to the polygon.

getScaleY	back to summary
public float getScaleY() Returns the total vertical scaling applied to the polygon.

getTransformedVertices	back to summary
public float[] getTransformedVertices() Calculates and returns the vertices of the polygon after scaling, rotation, and positional translations have been applied, as they are position within the world. Returns:float[] vertices scaled, rotated, and offset by the polygon position.

getTransformedVertices

back to summary

public float[] getTransformedVertices()

Calculates and returns the vertices of the polygon after scaling, rotation, and positional translations have been applied, as they are position within the world.

Returns:float[]: vertices scaled, rotated, and offset by the polygon position.

getVertex	back to summary
public Vector2 getVertex(int vertexNum, Vector2 pos) Returns:Vector2 Position(transformed) of vertex

getVertexCount	back to summary
public int getVertexCount()

getVertices	back to summary
public float[] getVertices() Returns the polygon's local vertices without scaling or rotation and without being offset by the polygon position.

getX	back to summary
public float getX() Returns the x-coordinate of the polygon's position within the world.

getY	back to summary
public float getY() Returns the y-coordinate of the polygon's position within the world.

resetTransformations	back to summary
public void resetTransformations()

rotate	back to summary
public void rotate(float degrees) Applies additional rotation to the polygon by the supplied degrees.

scale	back to summary
public void scale(float amount) Applies additional scaling to the polygon by the supplied amount.

setOrigin	back to summary
public void setOrigin(float originX, float originY) Sets the origin point to which all of the polygon's local vertices are relative to.

setPosition	back to summary
public void setPosition(float x, float y) Sets the polygon's position within the world.

setRotation	back to summary
public void setRotation(float degrees) Sets the polygon to be rotated by the supplied degrees.

setScale	back to summary
public void setScale(float scaleX, float scaleY) Sets the amount of scaling to be applied to the polygon.

setVertex	back to summary
public void setVertex(int vertexNum, float x, float y) Set vertex position Parameters vertexNum:int min=0, max=vertices.length/2-1 Exceptions IllegalArgumentException: if vertex doesnt exist

setVertex

back to summary

public void setVertex(int vertexNum, float x, float y)

Set vertex position

Parameters

vertexNum:int: min=0, max=vertices.length/2-1

Exceptions

IllegalArgumentException:: if vertex doesnt exist

setVertices	back to summary
public void setVertices(float[] vertices) Sets the polygon's local vertices relative to the origin point, without any scaling, rotating or translations being applied. Parameters vertices:float[] float array where every even element represents the x-coordinate of a vertex, and the proceeding element representing the y-coordinate. Exceptions IllegalArgumentException: if less than 6 elements, representing 3 points, are provided

setVertices

back to summary

public void setVertices(float[] vertices)

Sets the polygon's local vertices relative to the origin point, without any scaling, rotating or translations being applied.

Parameters

vertices:float[]: float array where every even element represents the x-coordinate of a vertex, and the proceeding element representing the y-coordinate.

Exceptions

IllegalArgumentException:: if less than 6 elements, representing 3 points, are provided

translate	back to summary
public void translate(float x, float y) Translates the polygon's position by the specified horizontal and vertical amounts.

public Class Polygon

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail