Body

java.lang.Object
- city.cs.engine.Body

Direct Known Subclasses:

DynamicBody, StaticBody
```
public abstract class Body
extends Object
```
A rigid body, consisting of one or more Fixtures in a fixed configuration. Each body belongs to a particular World in which it is simulated. A world typically contains many bodies, which interact with each other.
The simulation handles bodies bouncing off each other and sliding past each other with friction. Other effects can be obtained by using addCollisionListener() to arrange for application code to be called when this body collides with any other body in the world.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCollisionListener(CollisionListener listener)` Register a listener for collisions with this body.
`void`	`addDestructionListener(DestructionListener listener)` Register a listener for destruction of this body.
`AttachedImage`	`addImage(BodyImage image)` Convenience method to attach an instance of an image.
`boolean`	`contains(Vec2 p)` Is the point inside any of the fixtures of this body?
`void`	`destroy()` Remove this body from the world and notify all registered `DestructionListener`s.
`float`	`getAngle()` The angle of rotation of this body relative to its original state.
`float`	`getAngleDegrees()` The angle of rotation of this body relative to its original state.
`float`	`getAngularVelocity()` The angular (rotational) velocity of this body about its centre of mass.
`List<Body>`	`getBodiesInContact()` A list of all the other bodies currently in contact with this body.
`Color`	`getFillColor()` Get the colour used to paint the interior of this body's composite shape when no image is attached.
`List<Fixture>`	`getFixtureList()` Get the constituent fixtures of this body.
`List<AttachedImage>`	`getImages()` The images used to display this body.
`Vec2`	`getLinearVelocity()` The linear (straight line) velocity of the centre of mass of this body.
`Color`	`getLineColor()` Get the colour used to paint the outline of this body's composite shape when no image is attached (or if alwaysOutline is true).
`float`	`getMass()` The total mass of this body.
`String`	`getName()` Get the name for this body (used mostly for debugging).
`Vec2`	`getPosition()` The current position in the world of this body's origin point.
`World`	`getWorld()` The world in which this body exists.
`boolean`	`intersects(Body b)` Do any of the fixtures attached to this body currently overlap any of the fixtures attached to a given other body.
`boolean`	`intersects(Vec2 centre, float halfWidth, float halfHeight)` Do any of the fixtures attached to this body currently overlap a given axis-aligned rectangle.
`boolean`	`isAlwaysOutline()` Should the outline composite shape of this body always be drawn, even when an image is attached?
`boolean`	`isClipped()` Whether the images will be clipped to the body's composite shape or displayed in full (the default).
`void`	`move(Vec2 dp)` Move this body relative to its current position in the world.
`void`	`putOn(Body other)` Put this body on top of another body.
`void`	`putOn(float x, Body other)` Put this body at the specified x-coordinate on top of another body.
`void`	`removeAllCollisionListeners()` Deregister all collision listeners.
`void`	`removeAllDestructionListeners()` Deregister all destruction listeners.
`void`	`removeAllImages()` Remove all images from this body.
`void`	`removeAttachedImage(AttachedImage image)` Remove an image instance from this body.
`void`	`removeCollisionListener(CollisionListener listener)` Deregister a listener for collisions with this body.
`void`	`removeDestructionListener(DestructionListener listener)` Deregister a listener for destruction of this body.
`void`	`rotate(float dTheta)` Rotate this body from its current orientation around its origin.
`void`	`rotate(Vec2 p, float dTheta)` Rotate this body from its current orientation around a specified point.
`void`	`rotateDegrees(float dTheta)` Rotate this body from its current orientation around its origin.
`void`	`rotateDegrees(Vec2 p, float dTheta)` Rotate this body from its current orientation around a specified point.
`void`	`setAlwaysOutline(boolean b)` Set the alwaysOutline attribute.
`void`	`setAngle(float theta)` Set the angle of rotation of this body relative to its original state.
`void`	`setAngleDegrees(float theta)` Set the angle of rotation of this body relative to its original state.
`void`	`setClipped(boolean clipped)` Determine whether the images will be clipped to the body's composite shape or displayed in full (the default).
`void`	`setFillColor(Color fillColor)` Set the colour used to paint the interior of this body's composite shape when no image is attached.
`void`	`setLineColor(Color lineColor)` Set the colour used to paint the outline of this body's composite shape when no image is attached (or if alwaysOutline is true).
`void`	`setName(String name)` Set a name for this body.
`void`	`setPosition(Vec2 position)` Set the position in the world of this body's origin point.
`String`	`toString()` A string describing this body.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - addCollisionListener
```
public void addCollisionListener(CollisionListener listener)
```
    Register a listener for collisions with this body. When solid fixtures of two bodies collide, the collision listeners on each of the bodies are notified. Collision events are dispatched to registered listeners after the simulation step in which the collision occurs.
    
    Parameters:
    
    listener - the listener to add
  - removeCollisionListener
```
public void removeCollisionListener(CollisionListener listener)
```
    Deregister a listener for collisions with this body. Does nothing if the listener is not registered.
    
    Parameters:
    
    listener - the listener to remove
  - removeAllCollisionListeners
```
public void removeAllCollisionListeners()
```
    Deregister all collision listeners. Does nothing if no listeners are registered.
  - addImage
```
public AttachedImage addImage(BodyImage image)
```
    Convenience method to attach an instance of an image. The invocation
```
    b.addImage(image)
```
    is equivalent to
```
    new AttachedImage(b, image, 1f, 0f, new Vec2())
```
    If a body has more than one image, an image added later will be drawn in front of any added earlier.
    Parameters:
    
    image - the image of which to attach an instance
    
    Returns:
    
    the attached image
    
    See Also:
    
    AttachedImage.AttachedImage(Body, BodyImage, float, float, org.jbox2d.common.Vec2)
  - removeAttachedImage
```
public void removeAttachedImage(AttachedImage image)
```
    Remove an image instance from this body.
    
    Parameters:
    
    image - the image instance to remove
  - removeAllImages
```
public void removeAllImages()
```
    Remove all images from this body.
  - getImages
```
public List<AttachedImage> getImages()
```
    The images used to display this body. If this is empty, the body will be displayed filled with a solid colour.
    
    Returns:
    
    a copy of the list of currently attached images
  - setClipped
```
public void setClipped(boolean clipped)
```
    Determine whether the images will be clipped to the body's composite shape or displayed in full (the default).
    
    Parameters:
    
    clipped - the new value of the clipped attribute
  - isClipped
```
public boolean isClipped()
```
    Whether the images will be clipped to the body's composite shape or displayed in full (the default).
    
    Returns:
    
    the value of the clipped attribute
  - setName
```
public void setName(String name)
```
    Set a name for this body. Useful mostly for debugging.
    
    Parameters:
    
    name - the new name
  - getName
```
public String getName()
```
    Get the name for this body (used mostly for debugging).
    
    Returns:
    
    the name
  - addDestructionListener
```
public void addDestructionListener(DestructionListener listener)
```
    Register a listener for destruction of this body.
    
    Parameters:
    
    listener - the listener to add
  - removeDestructionListener
```
public void removeDestructionListener(DestructionListener listener)
```
    Deregister a listener for destruction of this body. Does nothing if the listener is not registered.
    
    Parameters:
    
    listener - the listener to remove
  - removeAllDestructionListeners
```
public void removeAllDestructionListeners()
```
    Deregister all destruction listeners. Does nothing if no listeners are registered.
  - destroy
```
public void destroy()
```
    Remove this body from the world and notify all registered DestructionListeners. Destruction listeners are notified immediately (before any additional cleanup actions are performed and before the body is removed from the World). This body must not be accessed after being destroyed.
  - getFixtureList
```
public List<Fixture> getFixtureList()
```
    Get the constituent fixtures of this body.
    
    Returns:
    
    a copy of the list of fixtures attached to this body
  - toString
```
public String toString()
```
    A string describing this body.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string including the name of the body
  - getWorld
```
public World getWorld()
```
    The world in which this body exists.
    
    Returns:
    
    the world
  - getPosition
```
public Vec2 getPosition()
```
    The current position in the world of this body's origin point.
    
    Returns:
    
    this body's position
  - move
```
public void move(Vec2 dp)
```
    Move this body relative to its current position in the world. The parameter is a pair of values (dp.x, dp.y) where the first component says how much to move along the x-axis and the second component says how much to move along the y-axis.
    
    Parameters:
    
    dp - the vector to add to this body's current position
  - setPosition
```
public void setPosition(Vec2 position)
```
    Set the position in the world of this body's origin point. The first component of the parameter is x, the second component is y.
    
    Parameters:
    
    position - the new position
  - getLinearVelocity
```
public Vec2 getLinearVelocity()
```
    The linear (straight line) velocity of the centre of mass of this body. The result is a vector; the first component is the speed along the x-axis, the second component is the speed along the y-axis. For a static body, this will always be zero.
    
    Returns:
    
    the linear velocity of this body (first component in x-direction, second component in y-direction)
  - getAngularVelocity
```
public float getAngularVelocity()
```
    The angular (rotational) velocity of this body about its centre of mass. For a static body, this will always be zero.
    
    Returns:
    
    this body's angular velocity (in radians per second; positive is counter-clockwise)
  - getAngle
```
public float getAngle()
```
    The angle of rotation of this body relative to its original state.
    
    Returns:
    
    the angle of rotation (in radians; positive is counter-clockwise)
  - getAngleDegrees
```
public float getAngleDegrees()
```
    The angle of rotation of this body relative to its original state.
    
    Returns:
    
    the angle of rotation (in degrees; positive is counter-clockwise)
  - setAngle
```
public void setAngle(float theta)
```
    Set the angle of rotation of this body relative to its original state.
    
    Parameters:
    
    theta - the new angle (in radians; positive is counter-clockwise)
  - setAngleDegrees
```
public void setAngleDegrees(float theta)
```
    Set the angle of rotation of this body relative to its original state.
    
    Parameters:
    
    theta - the new angle (in degrees; positive is counter-clockwise)
  - rotate
```
public void rotate(Vec2 p,
                   float dTheta)
```
    Rotate this body from its current orientation around a specified point.
    
    Parameters:
    
    p - the point about which to rotate
    
    dTheta - the angle by which to rotate (in radians; positive is counter-clockwise)
  - rotate
```
public void rotate(float dTheta)
```
    Rotate this body from its current orientation around its origin.
    
    Parameters:
    
    dTheta - the angle by which to rotate (in radians; positive is counter-clockwise)
  - rotateDegrees
```
public void rotateDegrees(Vec2 p,
                          float dTheta)
```
    Rotate this body from its current orientation around a specified point.
    
    Parameters:
    
    p - the point about which to rotate the body
    
    dTheta - the angle by which to rotate (in degrees; positive is counter-clockwise)
  - rotateDegrees
```
public void rotateDegrees(float dTheta)
```
    Rotate this body from its current orientation around its origin.
    
    Parameters:
    
    dTheta - the angle by which to rotate (in degrees; positive is counter-clockwise)
  - putOn
```
public void putOn(Body other)
```
    Put this body on top of another body. This body will be rotated so that its bottom edge matches the edge it is being placed on.
    
    Parameters:
    
    other - the body this one is to be placed on
    
    Throws:
    
    IllegalArgumentException - if either body is empty (no solid fixtures), in which case the body is not moved
  - putOn
```
public void putOn(float x,
                  Body other)
```
    Put this body at the specified x-coordinate on top of another body. This body will be rotated so that its bottom edge matches the edge it is being placed on.
    
    Parameters:
    
    x - the x-coordinate of the point of contact
    
    other - the body this one is to be placed on
    
    Throws:
    
    IllegalArgumentException - if either body is empty (no solid fixtures), in which case the body is not moved
  - getFillColor
```
public Color getFillColor()
```
    Get the colour used to paint the interior of this body's composite shape when no image is attached. The default colour is grey for static bodies and light brown for dynamic ones.
    
    Returns:
    
    the fill colour
  - setFillColor
```
public void setFillColor(Color fillColor)
```
    Set the colour used to paint the interior of this body's composite shape when no image is attached. The default colour is grey for static bodies and light brown for dynamic ones.
    
    Parameters:
    
    fillColor - the fill colour
  - getLineColor
```
public Color getLineColor()
```
    Get the colour used to paint the outline of this body's composite shape when no image is attached (or if alwaysOutline is true).
    
    Returns:
    
    the line colour
    
    See Also:
    
    isAlwaysOutline()
  - setLineColor
```
public void setLineColor(Color lineColor)
```
    Set the colour used to paint the outline of this body's composite shape when no image is attached (or if alwaysOutline is true).
    
    Parameters:
    
    lineColor - the line colour
    
    See Also:
    
    setAlwaysOutline(boolean)
  - isAlwaysOutline
```
public boolean isAlwaysOutline()
```
    Should the outline composite shape of this body always be drawn, even when an image is attached?
    
    Returns:
    
    the value of the alwaysOutline attribute
  - setAlwaysOutline
```
public void setAlwaysOutline(boolean b)
```
    Set the alwaysOutline attribute. When alwaysOutline is set to true, the composite shape outline for this body will always be drawn, even if an image is attached. Default false.
    
    Parameters:
    
    b - the new value for the alwaysOutline attribute
  - contains
```
public boolean contains(Vec2 p)
```
    Is the point inside any of the fixtures of this body?
    
    Parameters:
    
    p - a point in world coordinates
    
    Returns:
    
    true if p is inside any of the fixtures of this body
  - intersects
```
public boolean intersects(Body b)
```
    Do any of the fixtures attached to this body currently overlap any of the fixtures attached to a given other body.
    
    Parameters:
    
    b - the other body
    
    Returns:
    
    true if any of the fixtures of this body overlap any of the fixtures of the other body
  - intersects
```
public boolean intersects(Vec2 centre,
                          float halfWidth,
                          float halfHeight)
```
    Do any of the fixtures attached to this body currently overlap a given axis-aligned rectangle.
    
    Parameters:
    
    centre - the centre of the rectangle in world coordinates
    
    halfWidth - the half width of the rectangle in world units
    
    halfHeight - the half height of the rectangle in world units
    
    Returns:
    
    true if any of the fixtures of this body overlap the rectangle
  - getMass
```
public float getMass()
```
    The total mass of this body.
    
    Returns:
    
    the total mass of this body in kg
  - getBodiesInContact
```
public List<Body> getBodiesInContact()
```
    A list of all the other bodies currently in contact with this body.
    
    Returns:
    
    the list of other bodies in contact

Class Body

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addCollisionListener

removeCollisionListener

removeAllCollisionListeners

addImage

removeAttachedImage

removeAllImages

getImages

setClipped

isClipped

setName

getName

addDestructionListener

removeDestructionListener

removeAllDestructionListeners

destroy

getFixtureList

toString

getWorld

getPosition

move

setPosition

getLinearVelocity

getAngularVelocity

getAngle

getAngleDegrees

setAngle

setAngleDegrees

rotate

rotate

rotateDegrees

rotateDegrees

putOn

putOn

getFillColor

setFillColor

getLineColor

setLineColor

isAlwaysOutline

setAlwaysOutline

contains

intersects

intersects

getMass

getBodiesInContact