org.cell2d.space

Class CircleHitbox

java.lang.Object

org.cell2d.space.Hitbox

org.cell2d.space.CircleHitbox

public class CircleHitbox
extends Hitbox

A CircleHitbox is a circular Hitbox with its origin at its center. A CircleHitbox's radius cannot be negative.

Constructor Summary

Constructors

Constructor and Description
CircleHitbox(CellVector relPosition, long radius) Constructs a CircleHitbox with the specified relative position and radius.
CircleHitbox(long relX, long relY, long radius) Constructs a CircleHitbox with the specified relative position and radius.

Method Summary

Modifier and Type	Method and Description
long	getBottomEdge() Returns the y-coordinate of this Hitbox's absolute bottom boundary.
CircleHitbox	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.
long	getRadius() Returns this CircleHitbox's radius.
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.
boolean	setRadius(long radius) Sets this CircleHitbox's radius 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

CircleHitbox

public CircleHitbox(CellVector relPosition,
                    long radius)

Constructs a CircleHitbox with the specified relative position and radius.

Parameters:

relPosition - This CircleHitbox's relative position

radius - This CircleHitbox's radius

CircleHitbox

public CircleHitbox(long relX,
                    long relY,
                    long radius)

Constructs a CircleHitbox with the specified relative position and radius.

Parameters:

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

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

radius - This CircleHitbox's radius

Method Detail

getCopy

public final CircleHitbox 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

getRadius

public final long getRadius()

Returns this CircleHitbox's radius.

Returns:

This CircleHitbox's radius

setRadius

public final boolean setRadius(long radius)

Sets this CircleHitbox's radius to the specified value.

Parameters:

radius - The new radius

Returns:

Whether the new radius was valid and the change was successful

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