Module org.dyn4j

Package org.dyn4j.collision

Interface Bounds

All Superinterfaces:

Shiftable, Translatable

All Known Implementing Classes:

AbstractBounds, AxisAlignedBounds

public interface Bounds
extends Translatable, Shiftable

Represents the Bounds of a simulation.

By default all bounds are Translatable but not Rotatable.

Though not part of the bounds contract, a bounds object should only return true from the isOutside(CollisionBody) method when a CollisionBody is fully outside the bounds. This applies to the isOutside(AABB) and isOutside(AABB, Transform, Fixture) methods as well.

NOTE: isOutside(AABB, Transform, Fixture) method is called from the world implementations to provide the most flexibility. The isOutside(CollisionBody) and isOutside(AABB) methods are NOT called internally.

Since:

1.0.0

Version:

4.2.1

Author:

William Bittle

Method Summary

Modifier and Type	Method	Description
Vector2	getTranslation()	Returns the translation of the bounds.
boolean	isOutside(CollisionBody<?> body)	Returns true if the given CollisionBody is fully outside the bounds.
boolean	isOutside(AABB aabb)	Returns true if the given AABB is fully outside the bounds.
boolean	isOutside(AABB aabb, Transform transform, Fixture fixture)	Returns true if the given AABB or Fixture is fully outside the bounds.

Methods inherited from interface Shiftable

shift

Methods inherited from interface Translatable

translate, translate

Method Detail

getTranslation

Vector2 getTranslation()

Returns the translation of the bounds.

Returns:

Vector2

Since:

3.2.0

isOutside

boolean isOutside(CollisionBody<?> body)

Returns true if the given CollisionBody is fully outside the bounds.

If the CollisionBody contains zero Fixtures then CollisionBody is considered to be outside the bounds.

Parameters:

body - the CollisionBody to test

Returns:

boolean true if outside the bounds

isOutside

boolean isOutside(AABB aabb)

Returns true if the given AABB is fully outside the bounds.

If the AABB is a degenerate AABB (has zero area) then it's considered to be outside the bounds.

Parameters:

aabb - the AABB to test

Returns:

boolean true if outside the bounds

Since:

4.0.0

isOutside

boolean isOutside(AABB aabb,
                  Transform transform,
                  Fixture fixture)

Returns true if the given AABB or Fixture is fully outside the bounds.

The implementation can use any of the provided information. For example, the AxisAlignedBounds class only uses the provided AABB. For implementations of complex bounds, you can use the Transform and shape contained in the Fixture.

Parameters:

aabb - the AABB to test

transform - the Transform for the fixture

fixture - the Fixture (shape)

Returns:

boolean true if outside the bounds

Since:

4.2.1