AbstractCollidable

java.lang.Object
- org.dyn4j.collision.AbstractCollidable<T>

Type Parameters:

T - the Fixture type

All Implemented Interfaces:

Collidable<T>, DataContainer, Rotatable, Shiftable, Transformable, Translatable

Direct Known Subclasses:

Body
```
public abstract class AbstractCollidable<T extends Fixture>
extends java.lang.Object
implements Collidable<T>, Transformable, DataContainer
```
A base implementation of the Collidable interface.

Since:

3.2.0

Version:

3.2.0

Author:

William Bittle

Field Summary
- Fields inherited from interface org.dyn4j.collision.Collidable
  TYPICAL_FIXTURE_COUNT

Constructor Summary

Constructors
Constructor Description

AbstractCollidable()
Default constructor.

AbstractCollidable(int fixtureCount)
Optional constructor.

Constructors
Constructor	Description
`AbstractCollidable()`	Default constructor.
`AbstractCollidable(int fixtureCount)`	Optional constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`contains(Vector2 point)`	Returns true if the given world space point is contained in this `Collidable`.
`boolean`	`containsFixture(T fixture)`	Returns true if this `Collidable` contains the given `Fixture`.
`AABB`	`createAABB()`	Creates an `AABB` from this `Collidable`'s attached `Fixture`s.
`AABB`	`createAABB(Transform transform)`	Creates an `AABB` from this `Collidable`'s attached `Fixture`s using the given world space `Transform`.
`boolean`	`equals(java.lang.Object obj)`
`T`	`getFixture(int index)`	Returns the `Fixture` at the given index.
`T`	`getFixture(Vector2 point)`	Returns the first `Fixture` in this `Collidable`, determined by the order in which they were added, that contains the given point.
`int`	`getFixtureCount()`	Returns the number of `Fixture`s attached to this `Collidable` object.
`java.util.Iterator<T>`	`getFixtureIterator()`	Returns an iterator for this collidable's fixtures.
`java.util.List<T>`	`getFixtures()`	Returns an unmodifiable list containing the `Fixture`s attached to this `Collidable`.
`java.util.List<T>`	`getFixtures(Vector2 point)`	Returns all the `Fixture`s in this `Collidable` that contain the given point.
`java.util.UUID`	`getId()`	Returns a unique identifier for this `Collidable`.
`Vector2`	`getLocalPoint(Vector2 worldPoint)`	Returns a new point in local coordinates of this `Collidable` given a point in world coordinates.
`Vector2`	`getLocalVector(Vector2 worldVector)`	Returns a new vector in local coordinates of this `Collidable` given a vector in world coordinates.
`double`	`getRotationDiscRadius()`	Returns the maximum radius of the disk that the `Collidable` creates if rotated 360 degrees about its center.
`Transform`	`getTransform()`	Returns the local to world space `Transform` of this `Collidable`.
`java.lang.Object`	`getUserData()`	Gets the custom user data.
`Vector2`	`getWorldPoint(Vector2 localPoint)`	Returns a new point in world coordinates given a point in the local coordinates of this `Collidable`.
`Vector2`	`getWorldVector(Vector2 localVector)`	Returns a new vector in world coordinates given a vector in the local coordinates of this `Collidable`.
`int`	`hashCode()`
`java.util.List<T>`	`removeAllFixtures()`	Removes all fixtures from this `Collidable` and returns them.
`T`	`removeFixture(int index)`	Removes the `Fixture` at the given index.
`T`	`removeFixture(Vector2 point)`	Removes the first `Fixture` in this `Collidable`, 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 `Collidable`.
`java.util.List<T>`	`removeFixtures(Vector2 point)`	Removes all the `Fixture`s in this `Collidable` 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`	`rotateAboutCenter(double theta)`	Rotates the `Collidable` about its center of mass.
`void`	`setTransform(Transform transform)`	Sets this `Collidable`'s local to world space `Transform`.
`void`	`setUserData(java.lang.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 `Collidable` to the world space origin (0,0).

Methods inherited from interface org.dyn4j.collision.Collidable
addFixture, addFixture, getLocalCenter, getWorldCenter

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractCollidable
```
public AbstractCollidable()
```
    Default constructor.
  - AbstractCollidable
```
public AbstractCollidable(int fixtureCount)
```
    Optional constructor.
    Creates a new AbstractCollidable 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
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - removeFixture
```
public boolean removeFixture(T fixture)
```
    Description copied from interface: Collidable
    
    Removes the given Fixture from this Collidable.
    
    Specified by:
    
    removeFixture in interface Collidable<T extends Fixture>
    
    Parameters:
    
    fixture - the Fixture
    
    Returns:
    
    boolean true if the Fixture was removed from this Collidable
  - removeFixture
```
public T removeFixture(int index)
```
    Description copied from interface: Collidable
    
    Removes the Fixture at the given index.
    
    Specified by:
    
    removeFixture in interface Collidable<T extends Fixture>
    
    Parameters:
    
    index - the index
    
    Returns:
    
    T the fixture removed
  - removeAllFixtures
```
public java.util.List<T> removeAllFixtures()
```
    Description copied from interface: Collidable
    
    Removes all fixtures from this Collidable and returns them.
    
    Specified by:
    
    removeAllFixtures in interface Collidable<T extends Fixture>
    
    Returns:
    
    List<T>
  - containsFixture
```
public boolean containsFixture(T fixture)
```
    Description copied from interface: Collidable
    
    Returns true if this Collidable contains the given Fixture.
    
    Specified by:
    
    containsFixture in interface Collidable<T extends Fixture>
    
    Parameters:
    
    fixture - the fixture
    
    Returns:
    
    boolean
  - 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(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(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
  - rotateAboutCenter
```
public void rotateAboutCenter(double theta)
```
    Rotates the Collidable about its center of mass.
    
    Specified by:
    
    rotateAboutCenter in interface Collidable<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: Collidable
    
    Translates the center of the Collidable 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 Collidable so that the center is at the origin.
    
    Specified by:
    
    translateToOrigin in interface Collidable<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
  - getFixture
```
public T getFixture(int index)
```
    Description copied from interface: Collidable
    
    Returns the Fixture at the given index.
    
    Specified by:
    
    getFixture in interface Collidable<T extends Fixture>
    
    Parameters:
    
    index - the index of the Fixture
    
    Returns:
    
    T the fixture
  - getFixture
```
public T getFixture(Vector2 point)
```
    Description copied from interface: Collidable
    
    Returns the first Fixture in this Collidable, 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 Collidable.
    
    Specified by:
    
    getFixture in interface Collidable<T extends Fixture>
    
    Parameters:
    
    point - a world space point
    
    Returns:
    
    T the fixture or null
  - getFixtures
```
public java.util.List<T> getFixtures(Vector2 point)
```
    Description copied from interface: Collidable
    
    Returns all the Fixtures in this Collidable that contain the given point.
    Returns an empty list if the point is not contained in any fixture in this Collidable.
    
    Specified by:
    
    getFixtures in interface Collidable<T extends Fixture>
    
    Parameters:
    
    point - a world space point
    
    Returns:
    
    List<T>
  - removeFixture
```
public T removeFixture(Vector2 point)
```
    Description copied from interface: Collidable
    
    Removes the first Fixture in this Collidable, 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 Collidable.
    
    Specified by:
    
    removeFixture in interface Collidable<T extends Fixture>
    
    Parameters:
    
    point - a world space point
    
    Returns:
    
    T the fixture or null
  - removeFixtures
```
public java.util.List<T> removeFixtures(Vector2 point)
```
    Description copied from interface: Collidable
    
    Removes all the Fixtures in this Collidable that contain the given point and returns them.
    Returns an empty list if the point is not contained in any Fixture in this Collidable.
    
    Specified by:
    
    removeFixtures in interface Collidable<T extends Fixture>
    
    Parameters:
    
    point - a world space point
    
    Returns:
    
    List<T>
  - getFixtureCount
```
public int getFixtureCount()
```
    Description copied from interface: Collidable
    
    Returns the number of Fixtures attached to this Collidable object.
    
    Specified by:
    
    getFixtureCount in interface Collidable<T extends Fixture>
    
    Returns:
    
    int
  - getFixtures
```
public java.util.List<T> getFixtures()
```
    Description copied from interface: Collidable
    
    Returns an unmodifiable list containing the Fixtures attached to this Collidable.
    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 Collidable.getFixtureIterator() method instead.
    
    Specified by:
    
    getFixtures in interface Collidable<T extends Fixture>
    
    Returns:
    
    List<T>
    
    See Also:
    
    Collidable.getFixtureIterator()
  - getFixtureIterator
```
public java.util.Iterator<T> getFixtureIterator()
```
    Description copied from interface: Collidable
    
    Returns an iterator for this collidable's fixtures.
    The returned iterator supports the remove method.
    
    Specified by:
    
    getFixtureIterator in interface Collidable<T extends Fixture>
    
    Returns:
    
    Iterator<T>
  - getTransform
```
public Transform getTransform()
```
    Description copied from interface: Collidable
    
    Returns the local to world space Transform of this Collidable.
    
    Specified by:
    
    getTransform in interface Collidable<T extends Fixture>
    
    Returns:
    
    Transform
  - getRotationDiscRadius
```
public double getRotationDiscRadius()
```
    Description copied from interface: Collidable
    
    Returns the maximum radius of the disk that the Collidable creates if rotated 360 degrees about its center.
    
    Specified by:
    
    getRotationDiscRadius in interface Collidable<T extends Fixture>
    
    Returns:
    
    double the maximum radius of the rotation disk
  - setTransform
```
public void setTransform(Transform transform)
```
    Description copied from interface: Collidable
    
    Sets this Collidable's local to world space Transform.
    If the given transform is null, this method returns immediately.
    
    Specified by:
    
    setTransform in interface Collidable<T extends Fixture>
    
    Parameters:
    
    transform - the transform
  - getUserData
```
public java.lang.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(java.lang.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
  - getId
```
public java.util.UUID getId()
```
    Description copied from interface: Collidable
    
    Returns a unique identifier for this Collidable.
    This identifier is constant for the life of this Collidable.
    
    Specified by:
    
    getId in interface Collidable<T extends Fixture>
    
    Returns:
    
    UUID the unique id
  - createAABB
```
public AABB createAABB()
```
    Description copied from interface: Collidable
    
    Creates an AABB from this Collidable'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 Collidable<T extends Fixture>
    
    Returns:
    
    AABB
  - createAABB
```
public AABB createAABB(Transform transform)
```
    Description copied from interface: Collidable
    
    Creates an AABB from this Collidable'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 Collidable<T extends Fixture>
    
    Parameters:
    
    transform - the world space Transform
    
    Returns:
    
    AABB
  - getLocalPoint
```
public Vector2 getLocalPoint(Vector2 worldPoint)
```
    Description copied from interface: Collidable
    
    Returns a new point in local coordinates of this Collidable given a point in world coordinates.
    
    Specified by:
    
    getLocalPoint in interface Collidable<T extends Fixture>
    
    Parameters:
    
    worldPoint - a world space point
    
    Returns:
    
    Vector2 local space point
  - getWorldPoint
```
public Vector2 getWorldPoint(Vector2 localPoint)
```
    Description copied from interface: Collidable
    
    Returns a new point in world coordinates given a point in the local coordinates of this Collidable.
    
    Specified by:
    
    getWorldPoint in interface Collidable<T extends Fixture>
    
    Parameters:
    
    localPoint - a point in the local coordinates of this Collidable
    
    Returns:
    
    Vector2 world space point
  - getLocalVector
```
public Vector2 getLocalVector(Vector2 worldVector)
```
    Description copied from interface: Collidable
    
    Returns a new vector in local coordinates of this Collidable given a vector in world coordinates.
    
    Specified by:
    
    getLocalVector in interface Collidable<T extends Fixture>
    
    Parameters:
    
    worldVector - a world space vector
    
    Returns:
    
    Vector2 local space vector
  - getWorldVector
```
public Vector2 getWorldVector(Vector2 localVector)
```
    Description copied from interface: Collidable
    
    Returns a new vector in world coordinates given a vector in the local coordinates of this Collidable.
    
    Specified by:
    
    getWorldVector in interface Collidable<T extends Fixture>
    
    Parameters:
    
    localVector - a vector in the local coordinates of this Collidable
    
    Returns:
    
    Vector2 world space vector
  - contains
```
public boolean contains(Vector2 point)
```
    Description copied from interface: Collidable
    
    Returns true if the given world space point is contained in this Collidable.
    The point is contained in this Collidable if and only if the point is contained in one of this Collidable's Fixtures.
    
    Specified by:
    
    contains in interface Collidable<T extends Fixture>
    
    Parameters:
    
    point - the world space test point
    
    Returns:
    
    boolean

Class AbstractCollidable<T extends Fixture>

Field Summary

Fields inherited from interface org.dyn4j.collision.Collidable

Constructor Summary

Method Summary

Methods inherited from interface org.dyn4j.collision.Collidable

Methods inherited from class java.lang.Object

Constructor Detail

AbstractCollidable

AbstractCollidable

Method Detail

equals

hashCode

removeFixture

removeFixture

removeAllFixtures

containsFixture

rotate

rotate

rotate

rotateAboutCenter

translate

translate

translateToOrigin

shift

getFixture

getFixture

getFixtures

removeFixture

removeFixtures

getFixtureCount

getFixtures

getFixtureIterator

getTransform

getRotationDiscRadius

setTransform

getUserData

setUserData

getId

createAABB

createAABB

getLocalPoint

getWorldPoint

getLocalVector

getWorldVector

contains