Module org.dyn4j

Package org.dyn4j.collision.narrowphase

Class FallbackNarrowphaseDetector

Object

FallbackNarrowphaseDetector

All Implemented Interfaces:

NarrowphaseDetector

public class FallbackNarrowphaseDetector
extends Object
implements NarrowphaseDetector

Represents a delegating NarrowphaseDetector that uses a primary NarrowphaseDetector and fallback NarrowphaseDetector.

The fallback NarrowphaseDetector is used when any of the FallbackConditions added have been met.

FallbackConditions will be checked in order and will stop on the first matched condition. By default the conditions are ordered in the order they are added unless a condition specifies a sortIndex.

For example, when the Sat algorithm is used, some shapes are not supported. A TypedFallbackCondition can be used to fallback to the Gjk algorithm:

 FallbackNarrowphaseDetector detector = new FallbackNarrowphaseDetector(new Sat(), new Gjk());
 // any Slice collisions will be handled by Gjk instead of Sat
 detector.addCondition(new SingleTypedFallbackCondition(Slice.class));

New condition types can be added by implementing the FallbackCondition interface. Doing so can lead to interesting options like custom collision detectors for specific cases or custom shapes.

The primary and fallback detectors can also be FallbackNarrowphaseDetectors as well allowing for a chain of fallbacks.

Since:

3.1.5

Version:

3.2.0

Author:

William Bittle

Constructor Summary

Constructors

Constructor	Description
FallbackNarrowphaseDetector(NarrowphaseDetector primaryNarrowphaseDetector, NarrowphaseDetector fallbackNarrowphaseDetector)	Minimal constructor.
FallbackNarrowphaseDetector(NarrowphaseDetector primaryNarrowphaseDetector, NarrowphaseDetector fallbackNarrowphaseDetector, List<FallbackCondition> conditions)	Full constructor.

Method Summary

Modifier and Type	Method	Description
void	addCondition(FallbackCondition condition)	Adds the given condition to the list of fallback conditions.
boolean	containsCondition(FallbackCondition condition)	Returns true if the given condition is contained in this detector.
boolean	detect(Convex convex1, Transform transform1, Convex convex2, Transform transform2)	Returns true if the two Convex Shapes intersect.
boolean	detect(Convex convex1, Transform transform1, Convex convex2, Transform transform2, Penetration penetration)	Returns true if the two Convex Shapes intersect and fills the Penetration object with the penetration vector and depth.
FallbackCondition	getCondition(int index)	Returns the fallback condition at the given index.
int	getConditionCount()	Returns the number of fallback conditions.
NarrowphaseDetector	getFallbackNarrowphaseDetector()	Returns the fallback NarrowphaseDetector.
NarrowphaseDetector	getPrimaryNarrowphaseDetector()	Returns the primary NarrowphaseDetector.
boolean	isFallbackRequired(Convex convex1, Convex convex2)	Returns true if the fallback NarrowphaseDetector should be used rather than the primary.
boolean	removeCondition(FallbackCondition condition)	Removes the given condition to the list of fallback conditions and returns true if the operation was successful.

Methods inherited from class Object

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

Constructor Detail

FallbackNarrowphaseDetector

public FallbackNarrowphaseDetector(NarrowphaseDetector primaryNarrowphaseDetector,
                                   NarrowphaseDetector fallbackNarrowphaseDetector)

Minimal constructor.

Parameters:

primaryNarrowphaseDetector - the primary NarrowphaseDetector

fallbackNarrowphaseDetector - the fallback NarrowphaseDetector

Throws:

NullPointerException - if either the primary or fallback NarrowphaseDetectors are null

FallbackNarrowphaseDetector

public FallbackNarrowphaseDetector(NarrowphaseDetector primaryNarrowphaseDetector,
                                   NarrowphaseDetector fallbackNarrowphaseDetector,
                                   List<FallbackCondition> conditions)

Full constructor.

Parameters:

primaryNarrowphaseDetector - the primary NarrowphaseDetector

fallbackNarrowphaseDetector - the fallback NarrowphaseDetector

conditions - the fallback conditions

Throws:

NullPointerException - if either the primary or fallback NarrowphaseDetectors are null

Method Detail

addCondition

public void addCondition(FallbackCondition condition)

Adds the given condition to the list of fallback conditions.

Parameters:

condition - the condition

removeCondition

public boolean removeCondition(FallbackCondition condition)

Removes the given condition to the list of fallback conditions and returns true if the operation was successful.

Parameters:

condition - the condition

Returns:

boolean

containsCondition

public boolean containsCondition(FallbackCondition condition)

Returns true if the given condition is contained in this detector.

Parameters:

condition - the fallback condition

Returns:

boolean

getConditionCount

public int getConditionCount()

Returns the number of fallback conditions.

Returns:

int

getCondition

public FallbackCondition getCondition(int index)

Returns the fallback condition at the given index.

Parameters:

index - the index

Returns:

FallbackCondition

Throws:

IndexOutOfBoundsException - if index is not between 0 and getConditionCount()

isFallbackRequired

public boolean isFallbackRequired(Convex convex1,
                                  Convex convex2)

Returns true if the fallback NarrowphaseDetector should be used rather than the primary.

Parameters:

convex1 - the first convex

convex2 - the second convex

Returns:

boolean

detect

public boolean detect(Convex convex1,
                      Transform transform1,
                      Convex convex2,
                      Transform transform2)

Description copied from interface: NarrowphaseDetector

Returns true if the two Convex Shapes intersect.

Used to quickly test if two Convex Shapes intersect without incurring the cost of determining Penetration.

Specified by:

detect in interface NarrowphaseDetector

Parameters:

convex1 - the first Convex Shape

transform1 - the first Shape's Transform

convex2 - the second Convex Shape

transform2 - the second Shape's Transform

Returns:

boolean

detect

public boolean detect(Convex convex1,
                      Transform transform1,
                      Convex convex2,
                      Transform transform2,
                      Penetration penetration)

Description copied from interface: NarrowphaseDetector

Returns true if the two Convex Shapes intersect and fills the Penetration object with the penetration vector and depth.

Specified by:

detect in interface NarrowphaseDetector

Parameters:

convex1 - the first Convex Shape

transform1 - the first Shape's Transform

convex2 - the second Convex Shape

transform2 - the second Shape's Transform

penetration - the Penetration object to fill

Returns:

boolean

getPrimaryNarrowphaseDetector

public NarrowphaseDetector getPrimaryNarrowphaseDetector()

Returns the primary NarrowphaseDetector.

Returns:

NarrowphaseDetector

getFallbackNarrowphaseDetector

public NarrowphaseDetector getFallbackNarrowphaseDetector()

Returns the fallback NarrowphaseDetector.

Returns:

NarrowphaseDetector