Module org.dyn4j

Package org.dyn4j.world

Interface CollisionData<T extends CollisionBody<E>,E extends Fixture>

Type Parameters:

T - the CollisionBody type

E - the Fixture type

All Superinterfaces:

BroadphaseCollisionData<T,E>, ManifoldCollisionData<T,E>, NarrowphaseCollisionData<T,E>, Shiftable

All Known Subinterfaces:

ContactCollisionData<T>

All Known Implementing Classes:

WorldCollisionData

public interface CollisionData<T extends CollisionBody<E>,E extends Fixture>
extends ManifoldCollisionData<T,E>, NarrowphaseCollisionData<T,E>, BroadphaseCollisionData<T,E>, Shiftable

Represents a container for all the collision information between a CollisionPair.

Since:

4.0.0

Version:

4.0.0

Author:

William Bittle

Method Summary

Modifier and Type	Method	Description
boolean	isBroadphaseCollision()	Returns true if the CollisionPair is a broadphase collision.
boolean	isManifoldCollision()	Returns true if the CollisionPair is a manifold collision.
boolean	isNarrowphaseCollision()	Returns true if the CollisionPair is a narrowphase collision.
void	reset()	Resets the data in this object to prepare for use in the next detection step.
void	setBroadphaseCollision(boolean flag)	Set to true if the CollisionPair was detected by the BroadphaseDetector and it was allowed to continue to the NarrowphaseDetector stage.
void	setManifoldCollision(boolean flag)	Set to true if the CollisionPair was detected by the ManifoldSolver.
void	setNarrowphaseCollision(boolean flag)	Set to true if the CollisionPair was detected by the NarrowphaseDetector and it was allowed to continue to the ManifoldSolver stage.

Methods inherited from interface BroadphaseCollisionData

getBody1, getBody2, getFixture1, getFixture2, getPair

Methods inherited from interface ManifoldCollisionData

getManifold

Methods inherited from interface NarrowphaseCollisionData

getPenetration

Methods inherited from interface Shiftable

shift

Method Detail

isBroadphaseCollision

boolean isBroadphaseCollision()

Returns true if the CollisionPair is a broadphase collision.

Returns:

boolean

See Also:

setBroadphaseCollision(boolean)

setBroadphaseCollision

void setBroadphaseCollision(boolean flag)

Set to true if the CollisionPair was detected by the BroadphaseDetector and it was allowed to continue to the NarrowphaseDetector stage.

More specifically, set to true if all of the following conditions were met:

• The CollisionPair was detected by the BroadphaseDetector or was detected in a prior iteration
• The CollisionPair was confirmed to have their AABBs still overlapping
• The CollisionPair was NOT filtered by the BroadphaseFilter
• The CollisionPair was NOT filtered by any of the CollisionListener.collision(BroadphaseCollisionData) method calls

Parameters:

flag - true if the above conditions are met

isNarrowphaseCollision

boolean isNarrowphaseCollision()

Returns true if the CollisionPair is a narrowphase collision.

Returns:

boolean

See Also:

setNarrowphaseCollision(boolean)

setNarrowphaseCollision

void setNarrowphaseCollision(boolean flag)

Set to true if the CollisionPair was detected by the NarrowphaseDetector and it was allowed to continue to the ManifoldSolver stage.

More specifically, set to true if all of the following conditions were met:

• The CollisionPair was detected by the NarrowphaseDetector to be overlapping
• The CollisionPair's Penetration.getDepth() is greater than zero
• The CollisionPair was NOT filtered by any of the CollisionListener.collision(NarrowphaseCollisionData) method calls

Parameters:

flag - true if the above conditions are met

isManifoldCollision

boolean isManifoldCollision()

Returns true if the CollisionPair is a manifold collision.

Returns:

boolean

See Also:

setManifoldCollision(boolean)

setManifoldCollision

void setManifoldCollision(boolean flag)

Set to true if the CollisionPair was detected by the ManifoldSolver.

More specifically, set to true if all of the following conditions were met:

• The CollisionPair was detected by the ManifoldSolver
• The CollisionPair's Manifold has at least one point
• The CollisionPair was NOT filtered by any of the CollisionListener.collision(ManifoldCollisionData) method calls

Parameters:

flag - true if the above conditions are met

reset

void reset()

Resets the data in this object to prepare for use in the next detection step.