Hitbox

java.lang.Object
- org.cell2d.space.Hitbox

Direct Known Subclasses:

CircleHitbox, CompositeHitbox, LineHitbox, PointHitbox, PolygonHitbox, RectangleHitbox
```
public abstract class Hitbox
extends java.lang.Object
```
A Hitbox is a region of space that can be checked for intersection with other regions. A Hitbox has a position at a single point that acts as an origin point for the Hitbox's shape. This point is usually inside the Hitbox, but may not always be. Hitboxes can be rotated around their positions and flipped across horizontal and vertical axes through their positions. Rotating a Hitbox will also rotate the axes along which it is flipped. As with CellVectors, Hitboxes measure angles in degrees going counterclockwise from directly right and normalize them to be between 0 and 360.

If a Hitbox is a component of a CompositeHitbox, its position, flipped status, and angle of rotation are all relative to those of the CompositeHitbox. The same is true of a Hitbox being used by a SpaceObject, but not as its locator Hitbox, in relation to that SpaceObject's locator Hitbox. To avoid confusion, all spatial information about a Hitbox is specified as relative or absolute. For Hitboxes which are not located relative to other Hitboxes in this way, the two types of information are identical.

A Hitbox stores information on whether its surfaces in each Direction are solid, but this only affects its behavior when being used as a SpaceObject's solid Hitbox.

See Also:

SpaceObject, CompositeHitbox

Constructor Summary

Constructors
Constructor and Description
`Hitbox(CellVector relPosition)` Constructs a Hitbox with the specified relative position.
`Hitbox(long relX, long relY)` Constructs a Hitbox with the specified relative position.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`angleTo(Hitbox hitbox)` Returns the absolute angle from this Hitbox's position to the specified Hitbox's position.
`void`	`changeRelAngle(double relAngle)` Changes this Hitbox's relative angle of rotation by the specified amount.
`void`	`changeRelPosition(CellVector change)` Changes this Hitbox's relative position by the specified amount.
`void`	`changeRelPosition(long changeX, long changeY)` Changes the coordinates of this Hitbox's relative position by the specified amounts.
`void`	`changeRelX(long changeX)` Changes the x-coordinate of this Hitbox's relative position by the specified amount.
`void`	`changeRelY(long changeY)` Changes the y-coordinate of this Hitbox's relative position by the specified amount.
`long`	`distanceTo(Hitbox hitbox)` Returns the absolute distance from this Hitbox's position to the specified Hitbox's position.
`double`	`getAbsAngle()` Returns this Hitbox's absolute angle of rotation.
`long`	`getAbsAngleX()` Returns the x-coordinate of the unit vector that points in the direction of this Hitbox's absolute angle of rotation.
`long`	`getAbsAngleY()` Returns the y-coordinate of the unit vector that points in the direction of this Hitbox's absolute angle of rotation.
`CellVector`	`getAbsPosition()` Returns this Hitbox's absolute position.
`long`	`getAbsX()` Returns the x-coordinate of this Hitbox's absolute position.
`boolean`	`getAbsXFlip()` Returns whether this Hitbox is absolutely horizontally flipped.
`int`	`getAbsXSign()` Returns -1 if this Hitbox is absolutely horizontally flipped and 1 if it is not.
`long`	`getAbsY()` Returns the y-coordinate of this Hitbox's absolute position.
`boolean`	`getAbsYFlip()` Returns whether this Hitbox is absolutely vertically flipped.
`int`	`getAbsYSign()` Returns -1 if this Hitbox is absolutely vertically flipped and 1 if it is not.
`abstract long`	`getBottomEdge()` Returns the y-coordinate of this Hitbox's absolute bottom boundary.
`CompositeHitbox`	`getComponentOf()` Returns the CompositeHitbox that this Hitbox is a component of, or null if it is not a component of one.
`abstract Hitbox`	`getCopy()` Returns a copy of this Hitbox with its relative position at the origin that is not flipped or rotated.
`SpaceState`	`getGameState()` Returns the SpaceState of the SpaceObject that is using this Hitbox, or null if either the SpaceObject is not assigned to a SpaceState or this Hitbox is not being used by a SpaceObject.
`long`	`getHeight()` Returns the difference between the y-coordinates of this Hitbox's absolute bottom and top boundaries.
`abstract long`	`getLeftEdge()` Returns the x-coordinate of this Hitbox's absolute left boundary.
`SpaceObject`	`getObject()` Returns the SpaceObject that is using this Hitbox, directly or indirectly as part of a CompositeHitbox, or null if it is not being used by a SpaceObject.
`double`	`getRelAngle()` Returns this Hitbox's relative angle of rotation.
`long`	`getRelAngleX()` Returns the x-coordinate of the unit vector that points in the direction of this Hitbox's relative angle of rotation.
`long`	`getRelAngleY()` Returns the y-coordinate of the unit vector that points in the direction of this Hitbox's relative angle of rotation.
`CellVector`	`getRelPosition()` Returns this Hitbox's relative position.
`long`	`getRelX()` Returns the x-coordinate of this Hitbox's relative position.
`boolean`	`getRelXFlip()` Returns whether this Hitbox is relatively horizontally flipped.
`int`	`getRelXSign()` Returns -1 if this Hitbox is relatively horizontally flipped and 1 if it is not.
`long`	`getRelY()` Returns the y-coordinate of this Hitbox's relative position.
`boolean`	`getRelYFlip()` Returns whether this Hitbox is relatively vertically flipped.
`int`	`getRelYSign()` Returns -1 if this Hitbox is relatively vertically flipped and 1 if it is not.
`abstract long`	`getRightEdge()` Returns the x-coordinate of this Hitbox's absolute right boundary.
`abstract long`	`getTopEdge()` Returns the y-coordinate of this Hitbox's absolute top boundary.
`long`	`getWidth()` Returns the difference between the x-coordinates of this Hitbox's absolute right and left boundaries.
`boolean`	`isSolid()` Returns whether any of this Hitbox's surfaces are solid.
`static boolean`	`overlap(Hitbox hitbox1, Hitbox hitbox2)` Returns whether the two specified Hitboxes overlap.
`boolean`	`overlaps(Hitbox hitbox)` Returns whether this Hitbox overlaps the specified Hitbox.
`void`	`relFlipX()` Flips this Hitbox relatively horizontally, making it flipped if it was not before and not flipped if it was before.
`void`	`relFlipY()` Flips this Hitbox relatively vertically, making it flipped if it was not before and not flipped if it was before.
`void`	`setRelAngle(double relAngle)` Sets this Hitbox's relative angle of rotation to the specified value.
`void`	`setRelPosition(CellVector relPosition)` Sets this Hitbox's relative position to the specified value.
`void`	`setRelPosition(long relX, long relY)` Sets this Hitbox's relative position to the specified coordinates.
`void`	`setRelX(long relX)` Sets the x-coordinate of this Hitbox's relative position to the specified value.
`void`	`setRelXFlip(boolean relXFlip)` Sets whether this Hitbox is relatively horizontally flipped.
`void`	`setRelY(long relY)` Sets the y-coordinate of this Hitbox's relative position to the specified value.
`void`	`setRelYFlip(boolean relYFlip)` Sets whether this Hitbox is relatively vertically flipped.
`void`	`setSolid(boolean solid)` Sets whether this Hitbox's surfaces in every direction are solid.
`void`	`setSurfaceSolid(Direction direction, boolean solid)` Sets whether this Hitbox's surface in the specified Direction is solid.
`boolean`	`surfaceIsSolid(Direction direction)` Returns whether this Hitbox's surface in the specified Direction is solid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Hitbox
```
public Hitbox(CellVector relPosition)
```
    Constructs a Hitbox with the specified relative position.
    
    Parameters:
    
    relPosition - This Hitbox's relative position
  - Hitbox
```
public Hitbox(long relX,
              long relY)
```
    Constructs a Hitbox with the specified relative position.
    
    Parameters:
    
    relX - The x-coordinate of this Hitbox's relative position
    
    relY - The y-coordinate of this Hitbox's relative position
- Method Detail
  - getCopy
```
public abstract Hitbox getCopy()
```
    Returns a copy of this Hitbox with its relative position at the origin that is not flipped or rotated.
    
    Returns:
    
    A copy of this Hitbox
  - getComponentOf
```
public final CompositeHitbox getComponentOf()
```
    Returns the CompositeHitbox that this Hitbox is a component of, or null if it is not a component of one.
    
    Returns:
    
    The CompositeHitbox that this Hitbox is a component of
  - isSolid
```
public final boolean isSolid()
```
    Returns whether any of this Hitbox's surfaces are solid.
    
    Returns:
    
    Whether any of this Hitbox's surfaces are solid
  - surfaceIsSolid
```
public final boolean surfaceIsSolid(Direction direction)
```
    Returns whether this Hitbox's surface in the specified Direction is solid.
    
    Parameters:
    
    direction - The Direction of the surface to examine
    
    Returns:
    
    Whether the surface in the specified Direction is solid
  - setSurfaceSolid
```
public final void setSurfaceSolid(Direction direction,
                                  boolean solid)
```
    Sets whether this Hitbox's surface in the specified Direction is solid.
    
    Parameters:
    
    direction - The Direction of the surface whose solidity is to be set
    
    solid - Whether the surface in the specified Direction should be solid
  - setSolid
```
public final void setSolid(boolean solid)
```
    Sets whether this Hitbox's surfaces in every direction are solid.
    
    Parameters:
    
    solid - Whether this Hitbox's surfaces in every direction should be solid
  - getObject
```
public final SpaceObject getObject()
```
    Returns the SpaceObject that is using this Hitbox, directly or indirectly as part of a CompositeHitbox, or null if it is not being used by a SpaceObject.
    
    Returns:
    
    This Hitbox's SpaceObject
  - getGameState
```
public final SpaceState getGameState()
```
    Returns the SpaceState of the SpaceObject that is using this Hitbox, or null if either the SpaceObject is not assigned to a SpaceState or this Hitbox is not being used by a SpaceObject.
    
    Returns:
    
    This Hitbox's SpaceObject's SpaceState
  - getRelPosition
```
public final CellVector getRelPosition()
```
    Returns this Hitbox's relative position.
    
    Returns:
    
    This Hitbox's relative position
  - getRelX
```
public final long getRelX()
```
    Returns the x-coordinate of this Hitbox's relative position.
    
    Returns:
    
    The x-coordinate of this Hitbox's relative position
  - getRelY
```
public final long getRelY()
```
    Returns the y-coordinate of this Hitbox's relative position.
    
    Returns:
    
    The y-coordinate of this Hitbox's relative position
  - setRelPosition
```
public final void setRelPosition(CellVector relPosition)
```
    Sets this Hitbox's relative position to the specified value.
    
    Parameters:
    
    relPosition - The new relative position
  - setRelPosition
```
public final void setRelPosition(long relX,
                                 long relY)
```
    Sets this Hitbox's relative position to the specified coordinates.
    
    Parameters:
    
    relX - The x-coordinate of the new relative position
    
    relY - The y-coordinate of the new relative position
  - setRelX
```
public final void setRelX(long relX)
```
    Sets the x-coordinate of this Hitbox's relative position to the specified value.
    
    Parameters:
    
    relX - The x-coordinate of the new relative position
  - setRelY
```
public final void setRelY(long relY)
```
    Sets the y-coordinate of this Hitbox's relative position to the specified value.
    
    Parameters:
    
    relY - The y-coordinate of the new relative position
  - changeRelPosition
```
public final void changeRelPosition(CellVector change)
```
    Changes this Hitbox's relative position by the specified amount.
    
    Parameters:
    
    change - The amount to change the relative position by
  - changeRelPosition
```
public final void changeRelPosition(long changeX,
                                    long changeY)
```
    Changes the coordinates of this Hitbox's relative position by the specified amounts.
    
    Parameters:
    
    changeX - The amount to change the relative position's x-coordinate by
    
    changeY - The amount to change the relative position's y-coordinate by
  - changeRelX
```
public final void changeRelX(long changeX)
```
    Changes the x-coordinate of this Hitbox's relative position by the specified amount.
    
    Parameters:
    
    changeX - The amount to change the relative position's x-coordinate by
  - changeRelY
```
public final void changeRelY(long changeY)
```
    Changes the y-coordinate of this Hitbox's relative position by the specified amount.
    
    Parameters:
    
    changeY - The amount to change the relative position's y-coordinate by
  - getAbsPosition
```
public final CellVector getAbsPosition()
```
    Returns this Hitbox's absolute position.
    
    Returns:
    
    This Hitbox's absolute position
  - getAbsX
```
public final long getAbsX()
```
    Returns the x-coordinate of this Hitbox's absolute position.
    
    Returns:
    
    The x-coordinate of this Hitbox's absolute position
  - getAbsY
```
public final long getAbsY()
```
    Returns the y-coordinate of this Hitbox's absolute position.
    
    Returns:
    
    The y-coordinate of this Hitbox's absolute position
  - getRelXFlip
```
public final boolean getRelXFlip()
```
    Returns whether this Hitbox is relatively horizontally flipped.
    
    Returns:
    
    Whether this Hitbox is relatively horizontally flipped
  - getRelXSign
```
public final int getRelXSign()
```
    Returns -1 if this Hitbox is relatively horizontally flipped and 1 if it is not.
    
    Returns:
    
    -1 if this Hitbox is relatively horizontally flipped and 1 if it is not
  - setRelXFlip
```
public final void setRelXFlip(boolean relXFlip)
```
    Sets whether this Hitbox is relatively horizontally flipped.
    
    Parameters:
    
    relXFlip - Whether this Hitbox should be relatively horizontally flipped
  - relFlipX
```
public final void relFlipX()
```
    Flips this Hitbox relatively horizontally, making it flipped if it was not before and not flipped if it was before.
  - getAbsXFlip
```
public final boolean getAbsXFlip()
```
    Returns whether this Hitbox is absolutely horizontally flipped.
    
    Returns:
    
    Whether this Hitbox is absolutely horizontally flipped
  - getAbsXSign
```
public final int getAbsXSign()
```
    Returns -1 if this Hitbox is absolutely horizontally flipped and 1 if it is not.
    
    Returns:
    
    -1 if this Hitbox is absolutely horizontally flipped and 1 if it is not
  - getRelYFlip
```
public final boolean getRelYFlip()
```
    Returns whether this Hitbox is relatively vertically flipped.
    
    Returns:
    
    Whether this Hitbox is relatively vertically flipped
  - getRelYSign
```
public final int getRelYSign()
```
    Returns -1 if this Hitbox is relatively vertically flipped and 1 if it is not.
    
    Returns:
    
    -1 if this Hitbox is relatively vertically flipped and 1 if it is not
  - setRelYFlip
```
public final void setRelYFlip(boolean relYFlip)
```
    Sets whether this Hitbox is relatively vertically flipped.
    
    Parameters:
    
    relYFlip - Whether this Hitbox should be relatively vertically flipped
  - relFlipY
```
public final void relFlipY()
```
    Flips this Hitbox relatively vertically, making it flipped if it was not before and not flipped if it was before.
  - getAbsYFlip
```
public final boolean getAbsYFlip()
```
    Returns whether this Hitbox is absolutely vertically flipped.
    
    Returns:
    
    Whether this Hitbox is absolutely vertically flipped
  - getAbsYSign
```
public final int getAbsYSign()
```
    Returns -1 if this Hitbox is absolutely vertically flipped and 1 if it is not.
    
    Returns:
    
    -1 if this Hitbox is absolutely vertically flipped and 1 if it is not
  - getRelAngle
```
public final double getRelAngle()
```
    Returns this Hitbox's relative angle of rotation.
    
    Returns:
    
    This Hitbox's relative angle of rotation
  - getRelAngleX
```
public final long getRelAngleX()
```
    Returns the x-coordinate of the unit vector that points in the direction of this Hitbox's relative angle of rotation. This is equal to the cosine of the angle.
    
    Returns:
    
    The x-coordinate of this Hitbox's relative angle of rotation
  - getRelAngleY
```
public final long getRelAngleY()
```
    Returns the y-coordinate of the unit vector that points in the direction of this Hitbox's relative angle of rotation. Since y-coordinates increase going downward, this is equal to the negative sine of the angle.
    
    Returns:
    
    The y-coordinate of this Hitbox's relative angle of rotation
  - setRelAngle
```
public final void setRelAngle(double relAngle)
```
    Sets this Hitbox's relative angle of rotation to the specified value.
    
    Parameters:
    
    relAngle - The new relative angle of rotation
  - changeRelAngle
```
public final void changeRelAngle(double relAngle)
```
    Changes this Hitbox's relative angle of rotation by the specified amount.
    
    Parameters:
    
    relAngle - The amount to change the relative angle of rotation by
  - getAbsAngle
```
public final double getAbsAngle()
```
    Returns this Hitbox's absolute angle of rotation.
    
    Returns:
    
    This Hitbox's absolute angle of rotation
  - getAbsAngleX
```
public final long getAbsAngleX()
```
    Returns the x-coordinate of the unit vector that points in the direction of this Hitbox's absolute angle of rotation. This is equal to the cosine of the angle.
    
    Returns:
    
    The x-coordinate of this Hitbox's absolute angle of rotation
  - getAbsAngleY
```
public final long getAbsAngleY()
```
    Returns the y-coordinate of the unit vector that points in the direction of this Hitbox's absolute angle of rotation. Since y-coordinates increase going downward, this is equal to the negative sine of the angle.
    
    Returns:
    
    The y-coordinate of this Hitbox's absolute angle of rotation
  - getLeftEdge
```
public abstract long getLeftEdge()
```
    Returns the x-coordinate of this Hitbox's absolute left boundary.
    
    Returns:
    
    The x-coordinate of this Hitbox's absolute left boundary
  - getRightEdge
```
public abstract long getRightEdge()
```
    Returns the x-coordinate of this Hitbox's absolute right boundary.
    
    Returns:
    
    The x-coordinate of this Hitbox's absolute right boundary
  - getTopEdge
```
public abstract long getTopEdge()
```
    Returns the y-coordinate of this Hitbox's absolute top boundary.
    
    Returns:
    
    The y-coordinate of this Hitbox's absolute top boundary
  - getBottomEdge
```
public abstract long getBottomEdge()
```
    Returns the y-coordinate of this Hitbox's absolute bottom boundary.
    
    Returns:
    
    The y-coordinate of this Hitbox's absolute bottom boundary
  - getWidth
```
public final long getWidth()
```
    Returns the difference between the x-coordinates of this Hitbox's absolute right and left boundaries. This is equal to getRightEdge() - getLeftEdge().
    
    Returns:
    
    The difference between the x-coordinates of this Hitbox's absolute right and left boundaries
  - getHeight
```
public final long getHeight()
```
    Returns the difference between the y-coordinates of this Hitbox's absolute bottom and top boundaries. This is equal to getBottomEdge() - getTopEdge().
    
    Returns:
    
    The difference between the y-coordinates of this Hitbox's absolute bottom and top boundaries
  - distanceTo
```
public final long distanceTo(Hitbox hitbox)
```
    Returns the absolute distance from this Hitbox's position to the specified Hitbox's position.
    
    Parameters:
    
    hitbox - The Hitbox to return the distance to
    
    Returns:
    
    The absolute distance from this Hitbox's position to the specified Hitbox's position
  - angleTo
```
public final double angleTo(Hitbox hitbox)
```
    Returns the absolute angle from this Hitbox's position to the specified Hitbox's position.
    
    Parameters:
    
    hitbox - The Hitbox to return the angle to
    
    Returns:
    
    The absolute angle from this Hitbox's position to the specified Hitbox's position
  - overlaps
```
public final boolean overlaps(Hitbox hitbox)
```
    Returns whether this Hitbox overlaps the specified Hitbox. Two Hitboxes overlap if they share any points that are in the interior of at least one of them. If both Hitboxes are PointHitboxes or otherwise consist only of single points, then they have no interiors and thus cannot overlap. Two Hitboxes are not considered to overlap if they are both being used by the same SpaceObject.
    
    Parameters:
    
    hitbox - The Hitbox to check for an overlap
    
    Returns:
    
    Whether this Hitbox overlaps the specified Hitbox
  - overlap
```
public static boolean overlap(Hitbox hitbox1,
                              Hitbox hitbox2)
```
    Returns whether the two specified Hitboxes overlap. Two Hitboxes overlap if they share any points that are in the interior of at least one of them. If both Hitboxes are PointHitboxes or otherwise consist only of single points, then they have no interiors and thus cannot overlap. Two Hitboxes are not considered to overlap if they are both being used by the same SpaceObject.
    
    Parameters:
    
    hitbox1 - The first Hitbox
    
    hitbox2 - The second Hitbox
    
    Returns:
    
    Whether the two Hitboxes overlap

Class Hitbox

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Hitbox

Hitbox

Method Detail

getCopy

getComponentOf

isSolid

surfaceIsSolid

setSurfaceSolid

setSolid

getObject

getGameState

getRelPosition

getRelX

getRelY

setRelPosition

setRelPosition

setRelX

setRelY

changeRelPosition

changeRelPosition

changeRelX

changeRelY

getAbsPosition

getAbsX

getAbsY

getRelXFlip

getRelXSign

setRelXFlip

relFlipX

getAbsXFlip

getAbsXSign

getRelYFlip

getRelYSign

setRelYFlip

relFlipY

getAbsYFlip

getAbsYSign

getRelAngle

getRelAngleX

getRelAngleY

setRelAngle

changeRelAngle

getAbsAngle

getAbsAngleX

getAbsAngleY

getLeftEdge

getRightEdge

getTopEdge

getBottomEdge

getWidth

getHeight

distanceTo

angleTo

overlaps

overlap