com.almasb.fxgl.physics

Class CollisionHandler

java.lang.Object

com.almasb.fxgl.physics.CollisionHandler

public abstract class CollisionHandler
extends Object

Handler for a collision that occurred between two entities. Subclasses should override only those callbacks they are interested in.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Constructor Summary

Constructors

Constructor and Description
CollisionHandler(Object a, Object b) The order of types determines the order of entities in callbacks.

Method Summary

Modifier and Type	Method and Description
CollisionHandler	copyFor(Object a, Object b) Returns a copy of the collision handler with different entity types.
boolean	equal(T a, T b) Note: order doesn't matter.
boolean	equals(Object o)
int	hashCode()
protected void	onCollision(com.almasb.ents.Entity a, com.almasb.ents.Entity b) Called if entities A and B are currently colliding.
protected void	onCollisionBegin(com.almasb.ents.Entity a, com.almasb.ents.Entity b) Called when entities A and B have just collided and weren't colliding in the last tick.
protected void	onCollisionEnd(com.almasb.ents.Entity a, com.almasb.ents.Entity b) Called when entities A and B have just stopped colliding and were colliding in the last tick.
protected void	onHitBoxTrigger(com.almasb.ents.Entity a, com.almasb.ents.Entity b, HitBox boxA, HitBox boxB) Called once per collision during the same tick when collision occurred.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollisionHandler

public CollisionHandler(Object a,
                        Object b)

The order of types determines the order of entities in callbacks.

Parameters:

a - entity type of the first entity

b - entity type of the second entity

Method Detail

onHitBoxTrigger

protected void onHitBoxTrigger(com.almasb.ents.Entity a,
                               com.almasb.ents.Entity b,
                               HitBox boxA,
                               HitBox boxB)

Called once per collision during the same tick when collision occurred. Only the first hit box in the collision is passed.

Parameters:

a - first entity

b - second entity

boxA - hit box of first entity

boxB - hit box of second entity

onCollisionBegin

protected void onCollisionBegin(com.almasb.ents.Entity a,
                                com.almasb.ents.Entity b)

Called when entities A and B have just collided and weren't colliding in the last tick.

Parameters:

a - first entity

b - second entity

onCollision

protected void onCollision(com.almasb.ents.Entity a,
                           com.almasb.ents.Entity b)

Called if entities A and B are currently colliding.

Parameters:

a - first entity

b - second entity

onCollisionEnd

protected void onCollisionEnd(com.almasb.ents.Entity a,
                              com.almasb.ents.Entity b)

Called when entities A and B have just stopped colliding and were colliding in the last tick.

Parameters:

a - first entity

b - second entity

copyFor

public final CollisionHandler copyFor(Object a,
                                      Object b)

Returns a copy of the collision handler with different entity types. This allows convenient use of the same handler code for multiple entity types.

Parameters:

a - entity type A

b - entity type B

Returns:

copy of collision handler

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equal

public boolean equal(T a,
                     T b)

Note: order doesn't matter.

Parameters:

a - pair element

b - pair element

Returns:

true iff this pair equals given pair elements