com.almasb.fxgl.physics

Class CollisionResult

java.lang.Object

com.almasb.fxgl.physics.CollisionResult

All Implemented Interfaces:

Poolable

public final class CollisionResult
extends Object
implements Poolable

Data structure for holding info about collision result. hasCollided() will return true if a collision has occurred, false otherwise.

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Field Summary

Fields

Modifier and Type	Field and Description
static CollisionResult	COLLISION Constant for reporting collision.
static CollisionResult	NO_COLLISION Constant for reporting no collision.

Constructor Summary

Constructors

Constructor and Description
CollisionResult()

Method Summary

Modifier and Type	Method and Description
HitBox	getBoxA()
HitBox	getBoxB()
boolean	hasCollided()
void	init(HitBox boxA, HitBox boxB) Init CollisionResult with positive result, i.e.
void	reset() Resets the object for reuse.

Methods inherited from class java.lang.Object

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

Field Detail

NO_COLLISION

public static final CollisionResult NO_COLLISION

Constant for reporting no collision. getBoxA() and getBoxB() return null and hasCollided() returns false.

COLLISION

public static final CollisionResult COLLISION

Constant for reporting collision. Used when caller doesn't care about hit boxes. getBoxA() and getBoxB() return null and hasCollided() returns true.

Constructor Detail

CollisionResult

public CollisionResult()

Method Detail

init

public void init(HitBox boxA,
                 HitBox boxB)

Init CollisionResult with positive result, i.e. hasCollided() returns true.

Parameters:

boxA - hit box of first entity

boxB - hit box of second entity

getBoxA

public HitBox getBoxA()

Returns:

hit box of first entity

getBoxB

public HitBox getBoxB()

Returns:

hit box of second entity

hasCollided

public boolean hasCollided()

Returns:

true if collision occurred, false otherwise

reset

public void reset()

Description copied from interface: Poolable

Resets the object for reuse. Object references should be nulled and fields may be set to default values.

Specified by:

reset in interface Poolable