org.cell2d.space

Class LineHitbox

java.lang.Object

org.cell2d.space.Hitbox

org.cell2d.space.LineHitbox

public class LineHitbox
extends Hitbox

A LineHitbox is a Hitbox shaped like a line segment, with one endpoint being its position and the other being the sum of its position and a vector called its difference.

Constructor Summary

Constructors

Constructor and Description
LineHitbox(CellVector relPosition, CellVector relDifference) Constructs a LineHitbox with the specified relative position and difference.
LineHitbox(long relX, long relY, long relDX, long relDY) Constructs a LineHitbox with the specified relative position and difference.

Method Summary

Modifier and Type	Method and Description
CellVector	getAbsDifference() Returns this LineHitbox's absolute difference.
long	getAbsDX() Returns the x-coordinate of this LineHitbox's relative difference.
long	getAbsDY() Returns the y-coordinate of this LineHitbox's relative difference.
long	getBottomEdge() Returns the y-coordinate of this Hitbox's absolute bottom boundary.
LineHitbox	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.
CellVector	getPosition2() Returns the position of this LineHitbox's second endpoint, the sum of its absolute position and absolute difference.
CellVector	getRelDifference() Returns this LineHitbox's relative difference.
long	getRelDX() Returns the x-coordinate of this LineHitbox's relative difference.
long	getRelDY() Returns the y-coordinate of this LineHitbox's relative difference.
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.
long	getX2() Returns the x-coordinate of this LineHitbox's second endpoint, the sum of its absolute position and absolute difference.
long	getY2() Returns the y-coordinate of this LineHitbox's second endpoint, the sum of its absolute position and absolute difference.
void	setRelDifference(CellVector difference) Sets this LineHitbox's relative difference to the specified value.
void	setRelDifference(long relDX, long relDY) Sets this LineHitbox's relative difference to the specified value.
void	setRelDX(long relDX) Sets the x-coordinate of this LineHitbox's relative difference to the specified value.
void	setRelDY(long relDY) Sets the y-coordinate of this LineHitbox's relative difference 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

LineHitbox

public LineHitbox(CellVector relPosition,
                  CellVector relDifference)

Constructs a LineHitbox with the specified relative position and difference.

Parameters:

relPosition - This LineHitbox's relative position

relDifference - This LineHitbox's relative difference

LineHitbox

public LineHitbox(long relX,
                  long relY,
                  long relDX,
                  long relDY)

Constructs a LineHitbox with the specified relative position and difference.

Parameters:

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

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

relDX - The x-coordinate of this LineHitbox's relative difference

relDY - The y-coordinate of this LineHitbox's relative difference

Method Detail

getCopy

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

getRelDifference

public final CellVector getRelDifference()

Returns this LineHitbox's relative difference.

Returns:

This LineHitbox's relative difference

getRelDX

public final long getRelDX()

Returns the x-coordinate of this LineHitbox's relative difference.

Returns:

The x-coordinate of this LineHitbox's relative difference

getRelDY

public final long getRelDY()

Returns the y-coordinate of this LineHitbox's relative difference.

Returns:

The y-coordinate of this LineHitbox's relative difference

setRelDifference

public final void setRelDifference(CellVector difference)

Sets this LineHitbox's relative difference to the specified value.

Parameters:

difference - The new relative difference

setRelDifference

public final void setRelDifference(long relDX,
                                   long relDY)

Sets this LineHitbox's relative difference to the specified value.

Parameters:

relDX - The x-coordinate of the new relative difference

relDY - The y-coordinate of the new relative difference

setRelDX

public final void setRelDX(long relDX)

Sets the x-coordinate of this LineHitbox's relative difference to the specified value.

Parameters:

relDX - The x-coordinate of the new relative difference

setRelDY

public final void setRelDY(long relDY)

Sets the y-coordinate of this LineHitbox's relative difference to the specified value.

Parameters:

relDY - The y-coordinate of the new relative difference

getAbsDifference

public final CellVector getAbsDifference()

Returns this LineHitbox's absolute difference.

Returns:

This LineHitbox's absolute difference

getAbsDX

public final long getAbsDX()

Returns the x-coordinate of this LineHitbox's relative difference.

Returns:

The x-coordinate of this LineHitbox's relative difference

getAbsDY

public final long getAbsDY()

Returns the y-coordinate of this LineHitbox's relative difference.

Returns:

The y-coordinate of this LineHitbox's relative difference

getPosition2

public final CellVector getPosition2()

Returns the position of this LineHitbox's second endpoint, the sum of its absolute position and absolute difference.

Returns:

The position of this LineHitbox's second endpoint

getX2

public final long getX2()

Returns the x-coordinate of this LineHitbox's second endpoint, the sum of its absolute position and absolute difference.

Returns:

The x-coordinate of this LineHitbox's second endpoint

getY2

public final long getY2()

Returns the y-coordinate of this LineHitbox's second endpoint, the sum of its absolute position and absolute difference.

Returns:

The y-coordinate of this LineHitbox's second endpoint

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