Module org.dyn4j

Package org.dyn4j.collision

Class AbstractCollisionBody<T extends Fixture>

Object

AbstractCollisionBody<T>

Type Parameters:

T - the Fixture type

All Implemented Interfaces:

CollisionBody<T>, DataContainer, Rotatable, Shiftable, Transformable, Translatable, Ownable

Direct Known Subclasses:

AbstractCollidable, AbstractPhysicsBody

public abstract class AbstractCollisionBody<T extends Fixture>
extends Object
implements CollisionBody<T>, Transformable, DataContainer, Ownable

A base implementation of the CollisionBody interface.

Since:

4.0.0

Version:

4.0.0

Author:

William Bittle

Field Summary

Fields inherited from interface CollisionBody

TYPICAL_FIXTURE_COUNT

Constructor Summary

Constructors

Constructor	Description
AbstractCollisionBody()	Default constructor.
AbstractCollisionBody(int fixtureCount)	Optional constructor.

Method Summary

Modifier and Type	Method	Description
CollisionBody<T>	addFixture(T fixture)	Adds the given Fixture to this CollisionBody.
boolean	contains(Vector2 point)	Returns true if the given world space point is contained in this CollisionBody.
boolean	containsFixture(T fixture)	Returns true if this CollisionBody contains the given Fixture.
AABB	createAABB()	Creates an AABB from this CollisionBody's attached Fixtures.
AABB	createAABB(Transform transform)	Creates an AABB from this CollisionBody's attached Fixtures using the given world space Transform.
T	getFixture(int index)	Returns the Fixture at the given index.
T	getFixture(Vector2 point)	Returns the first Fixture in this CollisionBody, determined by the order in which they were added, that contains the given point.
int	getFixtureCount()	Returns the number of Fixtures attached to this CollisionBody object.
Iterator<T>	getFixtureIterator()	Returns an iterator for this body's fixtures.
FixtureModificationHandler<T>	getFixtureModificationHandler()	Returns the FixtureModificationHandler for this body.
List<T>	getFixtures()	Returns an unmodifiable list containing the Fixtures attached to this CollisionBody.
List<T>	getFixtures(Vector2 point)	Returns all the Fixtures in this CollisionBody that contain the given point.
Vector2	getLocalPoint(Vector2 worldPoint)	Returns a new point in local coordinates of this CollisionBody given a point in world coordinates.
Vector2	getLocalVector(Vector2 worldVector)	Returns a new vector in local coordinates of this CollisionBody given a vector in world coordinates.
Object	getOwner()	Returns the owner for this body.
Transform	getPreviousTransform()	Returns the transform of the last iteration.
double	getRotationDiscRadius()	Returns the maximum radius of the disk that the CollisionBody creates if rotated 360 degrees about its center.
Transform	getTransform()	Returns the local to world space Transform of this CollisionBody.
Object	getUserData()	Gets the custom user data.
Vector2	getWorldCenter()	Returns the center for this CollisionBody in world coordinates.
Vector2	getWorldPoint(Vector2 localPoint)	Returns a new point in world coordinates given a point in the local coordinates of this CollisionBody.
Vector2	getWorldVector(Vector2 localVector)	Returns a new vector in world coordinates given a vector in the local coordinates of this CollisionBody.
boolean	isEnabled()	Returns true if this CollisionBody is enabled.
List<T>	removeAllFixtures()	Removes all fixtures from this CollisionBody and returns them.
T	removeFixture(int index)	Removes the Fixture at the given index.
T	removeFixture(Vector2 point)	Removes the first Fixture in this CollisionBody, determined by the order in which they were added, that contains the given point and returns it.
boolean	removeFixture(T fixture)	Removes the given Fixture from this CollisionBody.
List<T>	removeFixtures(Vector2 point)	Removes all the Fixtures in this CollisionBody that contain the given point and returns them.
void	rotate(double theta)	Rotates the object about the origin.
void	rotate(double theta, double x, double y)	Rotates the object about the given coordinates.
void	rotate(double theta, Vector2 point)	Rotates the object about the given point.
void	rotate(Rotation rotation)	Rotates the object about the origin.
void	rotate(Rotation rotation, double x, double y)	Rotates the object about the given point.
void	rotate(Rotation rotation, Vector2 point)	Rotates the object about the given point.
void	rotateAboutCenter(double theta)	Rotates the CollisionBody about its center.
void	setEnabled(boolean enabled)	Sets the CollisionBody enabled or not.
void	setFixtureModificationHandler(FixtureModificationHandler<T> handler)	Sets the FixtureModificationHandler for this body.
void	setOwner(Object owner)	Sets the owner of this body.
void	setTransform(Transform transform)	Sets this CollisionBody's local to world space Transform.
void	setUserData(Object userData)	Sets the custom user data to the given data.
void	shift(Vector2 shift)	Translates the object to match the given coordinate shift.
void	translate(double x, double y)	Translates the object the given amounts in the respective directions.
void	translate(Vector2 vector)	Translates the object along the given vector.
void	translateToOrigin()	Translates the center of the CollisionBody to the world space origin (0,0).

Methods inherited from class Object

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

Methods inherited from interface CollisionBody

addFixture, getLocalCenter

Constructor Detail

AbstractCollisionBody

public AbstractCollisionBody()

Default constructor.

AbstractCollisionBody

public AbstractCollisionBody(int fixtureCount)

Optional constructor.

Creates a new AbstractCollisionBody using the given estimated fixture count. Assignment of the initial fixture count allows sizing of internal structures for optimal memory/performance. This estimated fixture count is not a limit on the number of fixtures.

Parameters:

fixtureCount - the estimated number of fixtures

Method Detail

addFixture

public CollisionBody<T> addFixture(T fixture)

Description copied from interface: CollisionBody

Adds the given Fixture to this CollisionBody.

Specified by:

addFixture in interface CollisionBody<T extends Fixture>

Parameters:

fixture - the Fixture to add

Returns:

CollisionBody this body

removeFixture

public boolean removeFixture(T fixture)

Description copied from interface: CollisionBody

Removes the given Fixture from this CollisionBody.

Specified by:

removeFixture in interface CollisionBody<T extends Fixture>

Parameters:

fixture - the Fixture

Returns:

boolean true if the Fixture was removed from this CollisionBody

removeFixture

public T removeFixture(int index)

Description copied from interface: CollisionBody

Removes the Fixture at the given index.

Specified by:

removeFixture in interface CollisionBody<T extends Fixture>

Parameters:

index - the index

Returns:

T the fixture removed

removeAllFixtures

public List<T> removeAllFixtures()

Description copied from interface: CollisionBody

Removes all fixtures from this CollisionBody and returns them.

Specified by:

removeAllFixtures in interface CollisionBody<T extends Fixture>

Returns:

List<T>

removeFixture

public T removeFixture(Vector2 point)

Description copied from interface: CollisionBody

Removes the first Fixture in this CollisionBody, determined by the order in which they were added, that contains the given point and returns it.

Returns null if the point is not contained in any Fixture in this CollisionBody.

Specified by:

removeFixture in interface CollisionBody<T extends Fixture>

Parameters:

point - a world space point

Returns:

T the fixture or null

removeFixtures

public List<T> removeFixtures(Vector2 point)

Description copied from interface: CollisionBody

Removes all the Fixtures in this CollisionBody that contain the given point and returns them.

Returns an empty list if the point is not contained in any Fixture in this CollisionBody.

Specified by:

removeFixtures in interface CollisionBody<T extends Fixture>

Parameters:

point - a world space point

Returns:

List<T>

containsFixture

public boolean containsFixture(T fixture)

Description copied from interface: CollisionBody

Returns true if this CollisionBody contains the given Fixture.

Specified by:

containsFixture in interface CollisionBody<T extends Fixture>

Parameters:

fixture - the fixture

Returns:

boolean

getFixture

public T getFixture(int index)

Description copied from interface: CollisionBody

Returns the Fixture at the given index.

Specified by:

getFixture in interface CollisionBody<T extends Fixture>

Parameters:

index - the index of the Fixture

Returns:

T the fixture

getFixture

public T getFixture(Vector2 point)

Description copied from interface: CollisionBody

Returns the first Fixture in this CollisionBody, determined by the order in which they were added, that contains the given point.

Returns null if the point is not contained in any fixture in this CollisionBody.

Specified by:

getFixture in interface CollisionBody<T extends Fixture>

Parameters:

point - a world space point

Returns:

T the fixture or null

getFixtures

public List<T> getFixtures(Vector2 point)

Description copied from interface: CollisionBody

Returns all the Fixtures in this CollisionBody that contain the given point.

Returns an empty list if the point is not contained in any fixture in this CollisionBody.

Specified by:

getFixtures in interface CollisionBody<T extends Fixture>

Parameters:

point - a world space point

Returns:

List<T>

getFixtureCount

public int getFixtureCount()

Description copied from interface: CollisionBody

Returns the number of Fixtures attached to this CollisionBody object.

Specified by:

getFixtureCount in interface CollisionBody<T extends Fixture>

Returns:

int

getFixtures

public List<T> getFixtures()

Description copied from interface: CollisionBody

Returns an unmodifiable list containing the Fixtures attached to this CollisionBody.

The returned list is backed by the internal list, therefore adding or removing fixtures while iterating through the returned list is not permitted. Use the CollisionBody.getFixtureIterator() method instead.

Specified by:

getFixtures in interface CollisionBody<T extends Fixture>

Returns:

List<T>

See Also:

CollisionBody.getFixtureIterator()

getFixtureIterator

public Iterator<T> getFixtureIterator()

Description copied from interface: CollisionBody

Returns an iterator for this body's fixtures.

The returned iterator supports the remove method.

Specified by:

getFixtureIterator in interface CollisionBody<T extends Fixture>

Returns:

Iterator<T>

rotate

public void rotate(double theta,
                   double x,
                   double y)

Description copied from interface: Rotatable

Rotates the object about the given coordinates.

Specified by:

rotate in interface Rotatable

Parameters:

theta - the angle of rotation in radians

x - the x coordinate to rotate about

y - the y coordinate to rotate about

rotate

public void rotate(Rotation rotation,
                   double x,
                   double y)

Description copied from interface: Rotatable

Rotates the object about the given point.

Specified by:

rotate in interface Rotatable

Parameters:

rotation - the Rotation representing the rotation amount

x - the x coordinate to rotate about

y - the y coordinate to rotate about

rotate

public void rotate(double theta,
                   Vector2 point)

Description copied from interface: Rotatable

Rotates the object about the given point.

Specified by:

rotate in interface Rotatable

Parameters:

theta - the angle of rotation in radians

point - the point to rotate about

rotate

public void rotate(Rotation rotation,
                   Vector2 point)

Description copied from interface: Rotatable

Rotates the object about the given point.

Specified by:

rotate in interface Rotatable

Parameters:

rotation - the Rotation representing the rotation amount

point - the point to rotate about

rotate

public void rotate(double theta)

Description copied from interface: Rotatable

Rotates the object about the origin.

Specified by:

rotate in interface Rotatable

Parameters:

theta - the angle of rotation in radians

rotate

public void rotate(Rotation rotation)

Description copied from interface: Rotatable

Rotates the object about the origin.

Specified by:

rotate in interface Rotatable

Parameters:

rotation - the Rotation representing the rotation amount

rotateAboutCenter

public void rotateAboutCenter(double theta)

Description copied from interface: CollisionBody

Rotates the CollisionBody about its center.

Specified by:

rotateAboutCenter in interface CollisionBody<T extends Fixture>

Parameters:

theta - the angle of rotation in radians

translate

public void translate(double x,
                      double y)

Description copied from interface: Translatable

Translates the object the given amounts in the respective directions.

Specified by:

translate in interface Translatable

Parameters:

x - the translation in the x direction

y - the translation in the y direction

translate

public void translate(Vector2 vector)

Description copied from interface: Translatable

Translates the object along the given vector.

Specified by:

translate in interface Translatable

Parameters:

vector - the translation along a vector

translateToOrigin

public void translateToOrigin()

Description copied from interface: CollisionBody

Translates the center of the CollisionBody to the world space origin (0,0).

This method is useful if bodies have a number of fixtures and the center is not at the origin. This method will reposition this CollisionBody so that the center is at the origin.

Specified by:

translateToOrigin in interface CollisionBody<T extends Fixture>

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

getTransform

public Transform getTransform()

Description copied from interface: CollisionBody

Returns the local to world space Transform of this CollisionBody.

Specified by:

getTransform in interface CollisionBody<T extends Fixture>

Returns:

Transform

getPreviousTransform

public Transform getPreviousTransform()

Description copied from interface: CollisionBody

Returns the transform of the last iteration.

This transform represents the last frame's position and orientation.

Specified by:

getPreviousTransform in interface CollisionBody<T extends Fixture>

Returns:

Transform

getRotationDiscRadius

public double getRotationDiscRadius()

Description copied from interface: CollisionBody

Returns the maximum radius of the disk that the CollisionBody creates if rotated 360 degrees about its center.

Specified by:

getRotationDiscRadius in interface CollisionBody<T extends Fixture>

Returns:

double the maximum radius of the rotation disk

setTransform

public void setTransform(Transform transform)

Description copied from interface: CollisionBody

Sets this CollisionBody's local to world space Transform.

If the given transform is null, nothing is done and this method returns immediately.

Specified by:

setTransform in interface CollisionBody<T extends Fixture>

Parameters:

transform - the transform

getUserData

public Object getUserData()

Description copied from interface: DataContainer

Gets the custom user data.

Specified by:

getUserData in interface DataContainer

Returns:

Object will return null if not set

setUserData

public void setUserData(Object userData)

Description copied from interface: DataContainer

Sets the custom user data to the given data.

Specified by:

setUserData in interface DataContainer

Parameters:

userData - the user data

createAABB

public AABB createAABB()

Description copied from interface: CollisionBody

Creates an AABB from this CollisionBody's attached Fixtures.

If there are no fixtures attached, a degenerate AABB, (0.0, 0.0) to (0.0, 0.0), is returned.

Specified by:

createAABB in interface CollisionBody<T extends Fixture>

Returns:

AABB

createAABB

public AABB createAABB(Transform transform)

Description copied from interface: CollisionBody

Creates an AABB from this CollisionBody's attached Fixtures using the given world space Transform.

If there are no fixtures attached, a degenerate AABB, (0.0, 0.0) to (0.0, 0.0), is returned.

Specified by:

createAABB in interface CollisionBody<T extends Fixture>

Parameters:

transform - the world space Transform

Returns:

AABB

getLocalPoint

public Vector2 getLocalPoint(Vector2 worldPoint)

Description copied from interface: CollisionBody

Returns a new point in local coordinates of this CollisionBody given a point in world coordinates.

Specified by:

getLocalPoint in interface CollisionBody<T extends Fixture>

Parameters:

worldPoint - a world space point

Returns:

Vector2 local space point

getWorldPoint

public Vector2 getWorldPoint(Vector2 localPoint)

Description copied from interface: CollisionBody

Returns a new point in world coordinates given a point in the local coordinates of this CollisionBody.

Specified by:

getWorldPoint in interface CollisionBody<T extends Fixture>

Parameters:

localPoint - a point in the local coordinates of this CollisionBody

Returns:

Vector2 world space point

getLocalVector

public Vector2 getLocalVector(Vector2 worldVector)

Description copied from interface: CollisionBody

Returns a new vector in local coordinates of this CollisionBody given a vector in world coordinates.

Specified by:

getLocalVector in interface CollisionBody<T extends Fixture>

Parameters:

worldVector - a world space vector

Returns:

Vector2 local space vector

getWorldVector

public Vector2 getWorldVector(Vector2 localVector)

Description copied from interface: CollisionBody

Returns a new vector in world coordinates given a vector in the local coordinates of this CollisionBody.

Specified by:

getWorldVector in interface CollisionBody<T extends Fixture>

Parameters:

localVector - a vector in the local coordinates of this CollisionBody

Returns:

Vector2 world space vector

getWorldCenter

public Vector2 getWorldCenter()

Description copied from interface: CollisionBody

Returns the center for this CollisionBody in world coordinates.

Specified by:

getWorldCenter in interface CollisionBody<T extends Fixture>

Returns:

Vector2 the center in world coordinates

contains

public boolean contains(Vector2 point)

Description copied from interface: CollisionBody

Returns true if the given world space point is contained in this CollisionBody.

The point is contained in this CollisionBody if and only if the point is contained in one of this CollisionBody's Fixtures.

Specified by:

contains in interface CollisionBody<T extends Fixture>

Parameters:

point - the world space test point

Returns:

boolean

isEnabled

public boolean isEnabled()

Description copied from interface: CollisionBody

Returns true if this CollisionBody is enabled.

Specified by:

isEnabled in interface CollisionBody<T extends Fixture>

Returns:

boolean

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: CollisionBody

Sets the CollisionBody enabled or not.

A disabled CollisionBody is completely ignored by the engine.

A CollisionBody will be disabled by only one condition from within the engine - when it's out of bounds. If there's no bounds detection set, then this state will never be set automatically.

Specified by:

setEnabled in interface CollisionBody<T extends Fixture>

Parameters:

enabled - true if the CollisionBody should be enabled

getOwner

public Object getOwner()

Description copied from interface: Ownable

Returns the owner for this body.

Specified by:

getOwner in interface Ownable

Returns:

Object

setOwner

public void setOwner(Object owner)

Description copied from interface: Ownable

Sets the owner of this body.

Specified by:

setOwner in interface Ownable

Parameters:

owner - the owner

getFixtureModificationHandler

public FixtureModificationHandler<T> getFixtureModificationHandler()

Description copied from interface: CollisionBody

Returns the FixtureModificationHandler for this body.

Specified by:

getFixtureModificationHandler in interface CollisionBody<T extends Fixture>

Returns:

FixtureModificationHandler

setFixtureModificationHandler

public void setFixtureModificationHandler(FixtureModificationHandler<T> handler)

Description copied from interface: CollisionBody

Sets the FixtureModificationHandler for this body.

Specified by:

setFixtureModificationHandler in interface CollisionBody<T extends Fixture>

Parameters:

handler - the handler