org.cell2d.space

Class PolygonHitbox

java.lang.Object

org.cell2d.space.Hitbox

org.cell2d.space.PolygonHitbox

public class PolygonHitbox
extends Hitbox

A PolygonHitbox is a polygonal Hitbox defined by a List of vertices. A PolygonHitbox occupies the area enclosed by a loop of line segments between each of its vertices and the next, and between the first and last vertices. It is the responsibility of the creators and modifiers of a PolygonHitbox to ensure that its vertices are not positioned in such a way that this loop crosses itself. Both relative and absolute vertices are relative to their PolygonHitbox's position. A PolygonHitbox with no vertices is a point at its absolute position that cannot overlap other Hitboxes.

Constructor Summary

Constructors

Constructor and Description
PolygonHitbox(CellVector relPosition) Constructs a PolygonHitbox with the specified relative position and no vertices.
PolygonHitbox(CellVector relPosition, CellVector... relVertices) Constructs a PolygonHitbox with the specified relative position and sequence of relative vertices.
PolygonHitbox(long relX, long relY) Constructs a PolygonHitbox with the specified relative position and no vertices.
PolygonHitbox(long relX, long relY, CellVector... relVertices) Constructs a PolygonHitbox with the specified relative position and sequence of relative vertices.

Method Summary

Modifier and Type	Method and Description
void	addVertex(CellVector relVertex) Adds the specified relative vertex to this PolygonHitbox at the index after its last one, between its last and first relative vertices.
void	addVertex(int index, CellVector relVertex) Adds the specified relative vertex to this PolygonHitbox at the specified index.
void	addVertex(int index, long relX, long relY) Adds the specified relative vertex to this PolygonHitbox at the specified index.
void	addVertex(long relX, long relY) Adds the specified relative vertex to this PolygonHitbox at the index after its last one, between its last and first relative vertices.
void	clearVertices() Removes all of this PolygonHitbox's vertices.
CellVector	getAbsVertex(int index) Returns this PolygonHitbox's absolute vertex at the specified index.
long	getAbsVertexX(int index) Returns the x-coordinate of this PolygonHitbox's absolute vertex at the specified index.
long	getAbsVertexY(int index) Returns the y-coordinate of this PolygonHitbox's absolute vertex at the specified index.
java.util.List<CellVector>	getAbsVertices() Returns the List of this PolygonHitbox's absolute vertices.
long	getBottomEdge() Returns the y-coordinate of this Hitbox's absolute bottom boundary.
PolygonHitbox	getCopy() Returns a copy of this Hitbox with its relative position at the origin that is not flipped or rotated.
long	getLeftEdge() Returns the x-coordinate of this Hitbox's absolute left boundary.
int	getNumVertices() Returns how many vertices this PolygonHitbox has.
CellVector	getRelVertex(int index) Returns this PolygonHitbox's relative vertex at the specified index.
long	getRelVertexX(int index) Returns the x-coordinate of this PolygonHitbox's relative vertex at the specified index.
long	getRelVertexY(int index) Returns the y-coordinate of this PolygonHitbox's relative vertex at the specified index.
java.util.List<CellVector>	getRelVertices() Returns the List of this PolygonHitbox's relative vertices.
long	getRightEdge() Returns the x-coordinate of this Hitbox's absolute right boundary.
long	getTopEdge() Returns the y-coordinate of this Hitbox's absolute top boundary.
static PolygonHitbox	regularPolygon(long relX, long relY, int numVertices, long radius, double angle) Returns a new PolygonHitbox in the shape of a regular polygon.
void	removeVertex(int index) Removes this PolygonHitbox's vertex at the specified index.
void	scale(long scaleFactor) Multiplies the coordinates of all of this PolygonHitbox's relative vertices by the specified factor.
void	setRelVertex(int index, CellVector relVertex) Sets this PolygonHitbox's relative vertex at the specified index to the specified value.
void	setRelVertex(int index, long relX, long relY) Sets this PolygonHitbox's relative vertex at the specified index to the specified value.
void	setRelVertexX(int index, long relX) Sets the x-coordinate of this PolygonHitbox's relative vertex at the specified index to the specified value.
void	setRelVertexY(int index, long relY) Sets the y-coordinate of this PolygonHitbox's relative vertex at the specified index to the specified value.

Methods inherited from class org.cell2d.space.Hitbox

angleTo, changeRelAngle, changeRelPosition, changeRelPosition, changeRelX, changeRelY, distanceTo, getAbsAngle, getAbsAngleX, getAbsAngleY, getAbsPosition, getAbsX, getAbsXFlip, getAbsXSign, getAbsY, getAbsYFlip, getAbsYSign, getComponentOf, getGameState, getHeight, getObject, getRelAngle, getRelAngleX, getRelAngleY, getRelPosition, getRelX, getRelXFlip, getRelXSign, getRelY, getRelYFlip, getRelYSign, getWidth, isSolid, overlap, overlaps, relFlipX, relFlipY, setRelAngle, setRelPosition, setRelPosition, setRelX, setRelXFlip, setRelY, setRelYFlip, setSolid, setSurfaceSolid, surfaceIsSolid

Methods inherited from class java.lang.Object

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

Constructor Detail

PolygonHitbox

public PolygonHitbox(CellVector relPosition,
                     CellVector... relVertices)

Constructs a PolygonHitbox with the specified relative position and sequence of relative vertices.

Parameters:

relPosition - This PolygonHitbox's relative position

relVertices - The sequence of this PolygonHitbox's relative vertices

PolygonHitbox

public PolygonHitbox(long relX,
                     long relY,
                     CellVector... relVertices)

Constructs a PolygonHitbox with the specified relative position and sequence of relative vertices.

Parameters:

relX - The x-coordinate of this PolygonHitbox's relative position

relY - The y-coordinate of this PolygonHitbox's relative position

relVertices - The sequence of this PolygonHitbox's relative vertices

PolygonHitbox

public PolygonHitbox(CellVector relPosition)

Constructs a PolygonHitbox with the specified relative position and no vertices.

Parameters:

relPosition - This PolygonHitbox's relative position

PolygonHitbox

public PolygonHitbox(long relX,
                     long relY)

Constructs a PolygonHitbox with the specified relative position and no vertices.

Parameters:

relX - The x-coordinate of this PolygonHitbox's relative position

relY - The y-coordinate of this PolygonHitbox's relative position

Method Detail

regularPolygon

public static PolygonHitbox regularPolygon(long relX,
                                           long relY,
                                           int numVertices,
                                           long radius,
                                           double angle)

Returns a new PolygonHitbox in the shape of a regular polygon.

Parameters:

relX - The x-coordinate of the new PolygonHitbox's relative position

relY - The y-coordinate of the new PolygonHitbox's relative position

numVertices - The new PolygonHitbox's number of vertices. This must be at least 3.

radius - The distance from the new PolygonHitbox's position to each of its vertices

angle - The angle from the origin to the new PolygonHitbox's first relative vertex

Returns:

The new PolygonHitbox

getCopy

public final PolygonHitbox getCopy()

Description copied from class: Hitbox

Returns a copy of this Hitbox with its relative position at the origin that is not flipped or rotated.

Specified by:

getCopy in class Hitbox

Returns:

A copy of this Hitbox

getRelVertices

public final java.util.List<CellVector> getRelVertices()

Returns the List of this PolygonHitbox's relative vertices. Changes to the returned List will not be reflected in this PolygonHitbox.

Returns:

The List of this PolygonHitbox's relative vertices

getAbsVertices

public final java.util.List<CellVector> getAbsVertices()

Returns the List of this PolygonHitbox's absolute vertices. Changes to the returned List will not be reflected in this PolygonHitbox.

Returns:

The List of this PolygonHitbox's absolute vertices

getNumVertices

public final int getNumVertices()

Returns how many vertices this PolygonHitbox has.

Returns:

How many vertices this PolygonHitbox has

getRelVertex

public final CellVector getRelVertex(int index)

Returns this PolygonHitbox's relative vertex at the specified index.

Parameters:

index - The index of the relative vertex

Returns:

The relative vertex at the specified index

getRelVertexX

public final long getRelVertexX(int index)

Returns the x-coordinate of this PolygonHitbox's relative vertex at the specified index.

Parameters:

index - The index of the relative vertex

Returns:

The x-coordinate of the relative vertex at the specified index

getRelVertexY

public final long getRelVertexY(int index)

Returns the y-coordinate of this PolygonHitbox's relative vertex at the specified index.

Parameters:

index - The index of the relative vertex

Returns:

The y-coordinate of the relative vertex at the specified index

getAbsVertex

public final CellVector getAbsVertex(int index)

Returns this PolygonHitbox's absolute vertex at the specified index.

Parameters:

index - The index of the absolute vertex

Returns:

The absolute vertex at the specified index

getAbsVertexX

public final long getAbsVertexX(int index)

Returns the x-coordinate of this PolygonHitbox's absolute vertex at the specified index.

Parameters:

index - The index of the absolute vertex

Returns:

The x-coordinate of the absolute vertex at the specified index

getAbsVertexY

public final long getAbsVertexY(int index)

Returns the y-coordinate of this PolygonHitbox's absolute vertex at the specified index.

Parameters:

index - The index of the absolute vertex

Returns:

The y-coordinate of the absolute vertex at the specified index

addVertex

public final void addVertex(CellVector relVertex)

Adds the specified relative vertex to this PolygonHitbox at the index after its last one, between its last and first relative vertices.

Parameters:

relVertex - The new relative vertex

addVertex

public final void addVertex(long relX,
                            long relY)

Adds the specified relative vertex to this PolygonHitbox at the index after its last one, between its last and first relative vertices.

Parameters:

relX - The x-coordinate of the new relative vertex

relY - The y-coordinate of the new relative vertex

addVertex

public final void addVertex(int index,
                            CellVector relVertex)

Adds the specified relative vertex to this PolygonHitbox at the specified index.

Parameters:

index - The index at which to add the new relative vertex

relVertex - The new relative vertex

addVertex

public final void addVertex(int index,
                            long relX,
                            long relY)

Adds the specified relative vertex to this PolygonHitbox at the specified index.

Parameters:

index - The index at which to add the new relative vertex

relX - The x-coordinate of the new relative vertex

relY - The y-coordinate of the new relative vertex

setRelVertex

public final void setRelVertex(int index,
                               CellVector relVertex)

Sets this PolygonHitbox's relative vertex at the specified index to the specified value.

Parameters:

index - The index of the relative vertex to be changed

relVertex - The new relative vertex

setRelVertex

public final void setRelVertex(int index,
                               long relX,
                               long relY)

Sets this PolygonHitbox's relative vertex at the specified index to the specified value.

Parameters:

index - The index of the relative vertex to be changed

relX - The x-coordinate of the new relative vertex

relY - The y-coordinate of the new relative vertex

setRelVertexX

public final void setRelVertexX(int index,
                                long relX)

Sets the x-coordinate of this PolygonHitbox's relative vertex at the specified index to the specified value.

Parameters:

index - The index of the relative vertex to be changed

relX - The relative vertex's new x-coordinate

setRelVertexY

public final void setRelVertexY(int index,
                                long relY)

Sets the y-coordinate of this PolygonHitbox's relative vertex at the specified index to the specified value.

Parameters:

index - The index of the relative vertex to be changed

relY - The relative vertex's new y-coordinate

removeVertex

public final void removeVertex(int index)

Removes this PolygonHitbox's vertex at the specified index.

Parameters:

index - The index of the vertex to be removed

clearVertices

public final void clearVertices()

Removes all of this PolygonHitbox's vertices.

scale

public final void scale(long scaleFactor)

Multiplies the coordinates of all of this PolygonHitbox's relative vertices by the specified factor.

Parameters:

scaleFactor - The factor by which to scale this PolygonHitbox

getLeftEdge

public final long getLeftEdge()

Description copied from class: Hitbox

Returns the x-coordinate of this Hitbox's absolute left boundary.

Specified by:

getLeftEdge in class Hitbox

Returns:

The x-coordinate of this Hitbox's absolute left boundary

getRightEdge

public final long getRightEdge()

Description copied from class: Hitbox

Returns the x-coordinate of this Hitbox's absolute right boundary.

Specified by:

getRightEdge in class Hitbox

Returns:

The x-coordinate of this Hitbox's absolute right boundary

getTopEdge

public final long getTopEdge()

Description copied from class: Hitbox

Returns the y-coordinate of this Hitbox's absolute top boundary.

Specified by:

getTopEdge in class Hitbox

Returns:

The y-coordinate of this Hitbox's absolute top boundary

getBottomEdge

public final long getBottomEdge()

Description copied from class: Hitbox

Returns the y-coordinate of this Hitbox's absolute bottom boundary.

Specified by:

getBottomEdge in class Hitbox

Returns:

The y-coordinate of this Hitbox's absolute bottom boundary