Module org.dyn4j

Package org.dyn4j.world

Class WorldCollisionData<T extends PhysicsBody>

Object

WorldCollisionData<T>

Type Parameters:

T - the PhysicsBody type

All Implemented Interfaces:

Shiftable, BroadphaseCollisionData<T,BodyFixture>, CollisionData<T,BodyFixture>, ContactCollisionData<T>, ManifoldCollisionData<T,BodyFixture>, NarrowphaseCollisionData<T,BodyFixture>

public class WorldCollisionData<T extends PhysicsBody>
extends Object
implements ContactCollisionData<T>

Represents the collision data for the World class.

This will track the broadphase, narrowphase, manifold generation, and contact constraint stages of collision detection. Use the isBroadphaseCollision() and similar methods to determine the progress of the collision.

Since:

4.0.0

Version:

4.0.0

Author:

William Bittle

Constructor Summary

Constructors

Constructor	Description
WorldCollisionData(CollisionPair<T,BodyFixture> pair)	Minimal constructor.

Method Summary

Modifier and Type	Method	Description
T	getBody1()	Returns the first CollisionBody.
T	getBody2()	Returns the second CollisionBody.
ContactConstraint<T>	getContactConstraint()	Returns the ContactConstraint.
BodyFixture	getFixture1()	Returns the first Fixture.
BodyFixture	getFixture2()	Returns the second Fixture.
Manifold	getManifold()	Returns the Manifold of the collision.
CollisionPair<T,BodyFixture>	getPair()	Returns the collision pair.
Penetration	getPenetration()	Returns the Penetration.
boolean	isBroadphaseCollision()	Returns true if the CollisionPair is a broadphase collision.
boolean	isContactConstraintCollision()	Returns true if the CollisionPair is a contact constraint 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	setContactConstraintCollision(boolean flag)	Set to true if the CollisionPair created a ContactConstraint and interaction edge.
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.
void	shift(Vector2 shift)	Translates the object to match the given coordinate shift.

Methods inherited from class Object

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

Constructor Detail

WorldCollisionData

public WorldCollisionData(CollisionPair<T,BodyFixture> pair)

Minimal constructor.

Parameters:

pair - the collision pair

Method Detail

getPair

public CollisionPair<T,BodyFixture> getPair()

Description copied from interface: BroadphaseCollisionData

Returns the collision pair.

Specified by:

getPair in interface BroadphaseCollisionData<T extends PhysicsBody,BodyFixture>

Returns:

CollisionPair

getBody1

public T getBody1()

Description copied from interface: BroadphaseCollisionData

Returns the first CollisionBody.

Specified by:

getBody1 in interface BroadphaseCollisionData<T extends PhysicsBody,BodyFixture>

Returns:

T

getFixture1

public BodyFixture getFixture1()

Description copied from interface: BroadphaseCollisionData

Returns the first Fixture.

Specified by:

getFixture1 in interface BroadphaseCollisionData<T extends PhysicsBody,BodyFixture>

Returns:

E

getBody2

public T getBody2()

Description copied from interface: BroadphaseCollisionData

Returns the second CollisionBody.

Specified by:

getBody2 in interface BroadphaseCollisionData<T extends PhysicsBody,BodyFixture>

Returns:

T

getFixture2

public BodyFixture getFixture2()

Description copied from interface: BroadphaseCollisionData

Returns the second Fixture.

Specified by:

getFixture2 in interface BroadphaseCollisionData<T extends PhysicsBody,BodyFixture>

Returns:

E

shift

public void shift(Vector2 shift)

Description copied from interface: Shiftable

Translates the object to match the given coordinate shift.

Specified by:

shift in interface Shiftable

Parameters:

shift - the amount to shift along the x and y axes

getManifold

public Manifold getManifold()

Description copied from interface: ManifoldCollisionData

Returns the Manifold of the collision.

Specified by:

getManifold in interface ManifoldCollisionData<T extends PhysicsBody,BodyFixture>

Returns:

Manifold

getPenetration

public Penetration getPenetration()

Description copied from interface: NarrowphaseCollisionData

Returns the Penetration.

Specified by:

getPenetration in interface NarrowphaseCollisionData<T extends PhysicsBody,BodyFixture>

Returns:

Penetration

getContactConstraint

public ContactConstraint<T> getContactConstraint()

Description copied from interface: ContactCollisionData

Returns the ContactConstraint.

Specified by:

getContactConstraint in interface ContactCollisionData<T extends PhysicsBody>

Returns:

ContactConstraint

isBroadphaseCollision

public boolean isBroadphaseCollision()

Description copied from interface: CollisionData

Returns true if the CollisionPair is a broadphase collision.

Specified by:

isBroadphaseCollision in interface CollisionData<T extends PhysicsBody,BodyFixture>

Returns:

boolean

See Also:

CollisionData.setBroadphaseCollision(boolean)

setBroadphaseCollision

public void setBroadphaseCollision(boolean flag)

Description copied from interface: CollisionData

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

Specified by:

setBroadphaseCollision in interface CollisionData<T extends PhysicsBody,BodyFixture>

Parameters:

flag - true if the above conditions are met

isNarrowphaseCollision

public boolean isNarrowphaseCollision()

Description copied from interface: CollisionData

Returns true if the CollisionPair is a narrowphase collision.

Specified by:

isNarrowphaseCollision in interface CollisionData<T extends PhysicsBody,BodyFixture>

Returns:

boolean

See Also:

CollisionData.setNarrowphaseCollision(boolean)

setNarrowphaseCollision

public void setNarrowphaseCollision(boolean flag)

Description copied from interface: CollisionData

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

Specified by:

setNarrowphaseCollision in interface CollisionData<T extends PhysicsBody,BodyFixture>

Parameters:

flag - true if the above conditions are met

isManifoldCollision

public boolean isManifoldCollision()

Description copied from interface: CollisionData

Returns true if the CollisionPair is a manifold collision.

Specified by:

isManifoldCollision in interface CollisionData<T extends PhysicsBody,BodyFixture>

Returns:

boolean

See Also:

CollisionData.setManifoldCollision(boolean)

setManifoldCollision

public void setManifoldCollision(boolean flag)

Description copied from interface: CollisionData

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

Specified by:

setManifoldCollision in interface CollisionData<T extends PhysicsBody,BodyFixture>

Parameters:

flag - true if the above conditions are met

isContactConstraintCollision

public boolean isContactConstraintCollision()

Description copied from interface: ContactCollisionData

Returns true if the CollisionPair is a contact constraint collision.

Specified by:

isContactConstraintCollision in interface ContactCollisionData<T extends PhysicsBody>

Returns:

boolean

See Also:

ContactCollisionData.setContactConstraintCollision(boolean)

setContactConstraintCollision

public void setContactConstraintCollision(boolean flag)

Description copied from interface: ContactCollisionData

Set to true if the CollisionPair created a ContactConstraint and interaction edge.

This will always be true if CollisionData.isManifoldCollision() is true.

Specified by:

setContactConstraintCollision in interface ContactCollisionData<T extends PhysicsBody>

Parameters:

flag - true if the above conditions are met

See Also:

CollisionData.setManifoldCollision(boolean)

reset

public void reset()

Description copied from interface: CollisionData

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

Specified by:

reset in interface CollisionData<T extends PhysicsBody,BodyFixture>