org.cell2d.space

Class CompositeHitbox

java.lang.Object

org.cell2d.space.Hitbox

org.cell2d.space.CompositeHitbox

public class CompositeHitbox
extends Hitbox

A CompositeHitbox is a Hitbox that is composed of other Hitboxes whose positions, flipped statuses, and angles of rotation are all relative to those of the CompositeHitbox itself. Each of a CompositeHitbox's component Hitboxes is assigned to it with an integer ID that is unique in the context of the CompositeHitbox. Only one Hitbox may be assigned to a given CompositeHitbox with a given ID at once. A CompositeHitbox with no component Hitboxes is a point at its absolute position that cannot overlap other Hitboxes.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearComponents() Removes all of this CompositeHitbox's component Hitboxes from it.
long	getBottomEdge() Returns the y-coordinate of this Hitbox's absolute bottom boundary.
Hitbox	getComponent(int id) Returns the component Hitbox that is assigned to this CompositeHitbox with the specified ID.
java.util.Map<java.lang.Integer,Hitbox>	getComponents() Returns an unmodifiable Map to this CompositeHitbox's components from their respective IDs.
CompositeHitbox	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	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	setComponent(int id, Hitbox hitbox) Sets the component Hitbox that is assigned to this CompositeHitbox with the specified ID to the specified Hitbox.

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

CompositeHitbox

public CompositeHitbox(CellVector relPosition)

Constructs a CompositeHitbox with the specified relative position.

Parameters:

relPosition - This CompositeHitbox's relative position

CompositeHitbox

public CompositeHitbox(long relX,
                       long relY)

Constructs a CompositeHitbox with the specified relative position.

Parameters:

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

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

Method Detail

getCopy

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

getComponents

public final java.util.Map<java.lang.Integer,Hitbox> getComponents()

Returns an unmodifiable Map to this CompositeHitbox's components from their respective IDs.

Returns:

A Map to this CompositeHitbox's components from their IDs

getComponent

public final Hitbox getComponent(int id)

Returns the component Hitbox that is assigned to this CompositeHitbox with the specified ID.

Parameters:

id - The ID of the component Hitbox to be returned

Returns:

The component Hitbox that is assigned to this CompositeHitbox with the specified ID

setComponent

public final boolean setComponent(int id,
                                  Hitbox hitbox)

Sets the component Hitbox that is assigned to this CompositeHitbox with the specified ID to the specified Hitbox. The specified Hitbox cannot be in use by a SpaceObject, and this CompositeHitbox cannot be its component, direct or indirect, or vice versa. If there is already a component Hitbox assigned with the specified ID, it will be removed from this CompositeHitbox. If the specified Hitbox is null, the component Hitbox with the specified ID will be removed if there is one, but it will not be replaced with anything.

Parameters:

id - The ID with which to assign the specified Hitbox

hitbox - The Hitbox to add as a component with the specified ID

Returns:

Whether the addition occurred

clearComponents

public final void clearComponents()

Removes all of this CompositeHitbox's component Hitboxes from it.

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