org.cell2d.space

Class RectangleHitbox

java.lang.Object

org.cell2d.space.Hitbox

org.cell2d.space.RectangleHitbox

public class RectangleHitbox
extends Hitbox

A RectangleHitbox is a rectangular Hitbox with sides that remain orthogonal regardless of its angle of rotation. Horizontal and vertical flipping will flip a RectangleHitbox across axes through its position that are absolutely horizontal and vertical, respectively, but its angle of rotation affects only any other Hitboxes that are relative to it. A RectangleHitbox cannot have a negative width or height.

Constructor Summary

Constructors

Constructor and Description
RectangleHitbox(CellVector relPosition, long relLeft, long relRight, long relTop, long relBottom) Constructs a RectangleHitbox with the specified relative position and dimensions.
RectangleHitbox(long relX, long relY, long relLeft, long relRight, long relTop, long relBottom) Constructs a RectangleHitbox with the specified relative position and dimensions.

Method Summary

Modifier and Type	Method and Description
long	getAbsBottom() Returns the difference of the y-coordinates of this RectangleHitbox's absolute bottom edge and absolute position.
long	getAbsLeft() Returns the difference of the x-coordinates of this RectangleHitbox's absolute left edge and absolute position.
long	getAbsRight() Returns the difference of the x-coordinates of this RectangleHitbox's absolute right edge and absolute position.
long	getAbsTop() Returns the difference of the y-coordinates of this RectangleHitbox's absolute top edge and absolute position.
long	getBottomEdge() Returns the y-coordinate of this Hitbox's absolute bottom boundary.
RectangleHitbox	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	getRelBottom() Returns the difference of the y-coordinates of this RectangleHitbox's relative bottom edge and relative position.
long	getRelLeft() Returns the difference of the x-coordinates of this RectangleHitbox's relative left edge and relative position.
long	getRelRight() Returns the difference of the x-coordinates of this RectangleHitbox's relative right edge and relative position.
long	getRelTop() Returns the difference of the y-coordinates of this RectangleHitbox's relative top edge and relative position.
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	setRelBottom(long relBottom) Sets the difference of the y-coordinates of this RectangleHitbox's relative bottom edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's height to be negative.
boolean	setRelLeft(long relLeft) Sets the difference of the x-coordinates of this RectangleHitbox's relative left edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's width to be negative.
boolean	setRelRight(long relRight) Sets the difference of the x-coordinates of this RectangleHitbox's relative right edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's width to be negative.
boolean	setRelTop(long relTop) Sets the difference of the y-coordinates of this RectangleHitbox's relative top edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's height to be negative.

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

RectangleHitbox

public RectangleHitbox(CellVector relPosition,
                       long relLeft,
                       long relRight,
                       long relTop,
                       long relBottom)

Constructs a RectangleHitbox with the specified relative position and dimensions.

Parameters:

relPosition - This RectangleHitbox's relative position

relLeft - The difference of the x-coordinates of this RectangleHitbox's relative left edge and relative position

relRight - The difference of the x-coordinates of this RectangleHitbox's relative right edge and relative position

relTop - The difference of the y-coordinates of this RectangleHitbox's relative top edge and relative position

relBottom - The difference of the y-coordinates of this RectangleHitbox's relative bottom edge and relative position

RectangleHitbox

public RectangleHitbox(long relX,
                       long relY,
                       long relLeft,
                       long relRight,
                       long relTop,
                       long relBottom)

Constructs a RectangleHitbox with the specified relative position and dimensions.

Parameters:

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

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

relLeft - The difference of the x-coordinates of this RectangleHitbox's relative left edge and relative position

relRight - The difference of the x-coordinates of this RectangleHitbox's relative right edge and relative position

relTop - The difference of the y-coordinates of this RectangleHitbox's relative top edge and relative position

relBottom - The difference of the y-coordinates of this RectangleHitbox's relative bottom edge and relative position

Method Detail

getCopy

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

getRelLeft

public final long getRelLeft()

Returns the difference of the x-coordinates of this RectangleHitbox's relative left edge and relative position.

Returns:

This RectangleHitbox's relative left-side difference

setRelLeft

public final boolean setRelLeft(long relLeft)

Sets the difference of the x-coordinates of this RectangleHitbox's relative left edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's width to be negative.

Parameters:

relLeft - The new relative left-side difference

Returns:

Whether the change occurred

getAbsLeft

public final long getAbsLeft()

Returns the difference of the x-coordinates of this RectangleHitbox's absolute left edge and absolute position.

Returns:

This RectangleHitbox's absolute left-side difference

getRelRight

public final long getRelRight()

Returns the difference of the x-coordinates of this RectangleHitbox's relative right edge and relative position.

Returns:

This RectangleHitbox's relative right-side difference

setRelRight

public final boolean setRelRight(long relRight)

Sets the difference of the x-coordinates of this RectangleHitbox's relative right edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's width to be negative.

Parameters:

relRight - The new relative right-side difference

Returns:

Whether the change occurred

getAbsRight

public final long getAbsRight()

Returns the difference of the x-coordinates of this RectangleHitbox's absolute right edge and absolute position.

Returns:

This RectangleHitbox's absolute right-side difference

getRelTop

public final long getRelTop()

Returns the difference of the y-coordinates of this RectangleHitbox's relative top edge and relative position.

Returns:

This RectangleHitbox's relative top-side difference

setRelTop

public final boolean setRelTop(long relTop)

Sets the difference of the y-coordinates of this RectangleHitbox's relative top edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's height to be negative.

Parameters:

relTop - The new relative top-side difference

Returns:

Whether the change occurred

getAbsTop

public final long getAbsTop()

Returns the difference of the y-coordinates of this RectangleHitbox's absolute top edge and absolute position.

Returns:

This RectangleHitbox's absolute top-side difference

getRelBottom

public final long getRelBottom()

Returns the difference of the y-coordinates of this RectangleHitbox's relative bottom edge and relative position.

Returns:

This RectangleHitbox's relative bottom-side difference

setRelBottom

public final boolean setRelBottom(long relBottom)

Sets the difference of the y-coordinates of this RectangleHitbox's relative bottom edge and relative position to the specified value, if doing so would not cause this RectangleHitbox's height to be negative.

Parameters:

relBottom - The new relative bottom-side difference

Returns:

Whether the change occurred

getAbsBottom

public final long getAbsBottom()

Returns the difference of the y-coordinates of this RectangleHitbox's absolute bottom edge and absolute position.

Returns:

This RectangleHitbox's absolute bottom-side difference

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