FWorld (fisica 1.0.0-SNAPSHOT API)

java.lang.Object
- org.jbox2d.dynamics.World
- - fisica.FWorld

```
public class FWorld
extends org.jbox2d.dynamics.World
```
Represents the world where all the bodies live in. When we create a world it will have the size of the applet that it is created in. Once the world is created we can add bodies to it or remove bodies we have added. Once the world is created we may add or remove bodies to it using add and remove. We may also call step to advance one step the simulation. Finally we can draw the world and all the bodies living in it by using draw.
```
 
 FWorld world;

 void setup() {
   Fisica.init(this);

   world = new FWorld();
   world.setEdges();

   // Create and add bodies to the world here
   // ...
 }

 void draw() {
   world.step();
   world.draw();
 }

 
```
See Also:

FBody

Field Summary

Fields
Modifier and Type	Field and Description
`FBox`	`bottom` The bottom edge of the world.
`FBox`	`left` The left edge of the world.
`protected LinkedList`	`m_actions`
`protected float`	`m_bottomRightX`
`protected float`	`m_bottomRightY`
`protected ArrayList`	`m_contactResults`
`protected HashMap`	`m_contacts`
`protected float`	`m_edgesFriction`
`protected float`	`m_edgesRestitution`
`protected ArrayList`	`m_fbodies`
`protected boolean`	`m_grabbable`
`protected float`	`m_grabPositionX`
`protected float`	`m_grabPositionY`
`protected int`	`m_mouseButton`
`protected FMouseJoint`	`m_mouseJoint`
`protected float`	`m_topLeftX`
`protected float`	`m_topLeftY`
`FBox`	`right` The right edge of the world.
`FBox`	`top` The top edge of the world.

Constructor Summary

Constructors
Constructor and Description
`FWorld()`
`FWorld(float topLeftX, float topLeftY, float bottomRightX, float bottomRightY)` Constructs the world where all the bodies live in.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(FBody body)` Add a body to the world.
`void`	`add(FJoint joint)` Add a joint to the world.
`void`	`addBody(FBody body)`
`void`	`addJoint(FJoint joint)`
`void`	`clear()` Clear all bodies and joints from the world.
`void`	`dragBody(float x, float y)`
`void`	`draw()` Draws all the bodies in the world on the applet canvas.
`void`	`draw(def.processing.core.PGraphics graphics)` Draws all the bodies in the world.
`void`	`drawDebug()` Draws the debug version of all the bodies in the world on the applet canvas.
`void`	`drawDebug(def.processing.core.PGraphics graphics)` Draws the debug version of all the bodies in the world.
`ArrayList`	`getBodies()` Returns a list with all the bodies in the world
`ArrayList`	`getBodies(float x, float y)` Returns a list with the 10 first bodies found at the given position.
`ArrayList`	`getBodies(float x, float y, boolean getStatic)` Returns a list with the 10 first bodies found at the given position.
`ArrayList`	`getBodies(float x, float y, boolean getStatic, int count)` Returns a list with all the bodies found at the given position.
`FBody`	`getBody(float x, float y)` Returns the first object found at the given position.
`FBody`	`getBody(float x, float y, boolean getStatic)` Returns the first object found at the given position.
`FMouseJoint`	`getMouseJoint()` Returns the mouse joint that is used for interaction with the bodies in the world.
`void`	`grabBody(float x, float y)`
`void`	`mouseEvent(def.processing.event.MouseEvent event)` This is an internal method to handle mouse interaction and should not be used.
`void`	`processActions()`
`int`	`raycast(float x1, float y1, float x2, float y2, FBody[] bodies, int maxCount, boolean solidShapes)`
`int`	`raycast(org.jbox2d.collision.Segment segment, org.jbox2d.collision.shapes.Shape[] shapes, int maxCount, boolean solidShapes, Object userData)`
`FBody`	`raycastOne(float x1, float y1, float x2, float y2, FRaycastResult result, boolean solidShapes)`
`org.jbox2d.collision.shapes.Shape`	`raycastOne(org.jbox2d.collision.Segment segment, org.jbox2d.common.RaycastResult result, boolean solidShapes, Object userData)`
`void`	`releaseBody()`
`void`	`remove(FBody body)` Remove a body from the world.
`void`	`remove(FJoint joint)` Remove a joint from the world.
`void`	`removeBody(FBody body)`
`void`	`removeJoint(FJoint joint)`
`void`	`setContactListener(org.jbox2d.dynamics.ContactListener listener)`
`void`	`setContactListener(FContactListener listener)`
`void`	`setEdges()` Add black edges of Processing's canvas dimensions to the world.
`void`	`setEdges(float topLeftX, float topLeftY, float bottomRightX, float bottomRightY)` Add black edges of given dimensions to the world.
`void`	`setEdges(float topLeftX, float topLeftY, float bottomRightX, float bottomRightY, int color)` Add edges of given dimensions to the world.
`void`	`setEdges(int color)` Add edges of Processing's canvas dimensions to the world.
`void`	`setEdges(def.processing.core.PApplet applet, int color)` Add edges of given applet's dimensions to the world.
`void`	`setEdgesFriction(float friction)` Set the friction of all the edges.
`void`	`setEdgesRestitution(float restitution)` Set the restitution of all the edges.
`void`	`setGrabbable(boolean value)` Controls whether the bodies in the world can be grabbed by the mouse or not.
`void`	`setGravity(float gx, float gy)` Set the gravity of the world.
`void`	`setGravity(org.jbox2d.common.Vec2 vector)`
`void`	`step()` Advance the world simulation of 1/60th of a second.
`void`	`step(float dt)` Advance the world simulation of given time.
`void`	`step(float dt, int iterationCount)` Advance the world simulation of given time, with a given number of iterations.

Methods inherited from class org.jbox2d.dynamics.World
createBody, createController, createJoint, destroyBody, destroyController, destroyJoint, drawDebugData, drawJoint, drawShape, getBodyCount, getBodyList, getContactCount, getDebugDraw, getGravity, getGroundBody, getJointCount, getJointList, getPairCount, getProxyCount, getWorldAABB, inRange, isAutoDebugDraw, isDrawingDebugData, query, refilter, registerPostStep, setAutoDebugDraw, setBoundaryListener, setContactFilter, setContinuousPhysics, setDebugDraw, setDestructionListener, setDrawDebugData, setPositionCorrection, setWarmStarting, solve, solveTOI, unregisterPostStep, validate

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

- Field Detail
  - left
```
public FBox left
```
    The left edge of the world. For this edge to exist, the edges must have been created by calling setEdges().
    
    See Also:
    
    left, right, bottom, top
  - right
```
public FBox right
```
    The right edge of the world. For this edge to exist, the edges must have been created by calling setEdges().
    
    See Also:
    
    left, right, bottom, top
  - top
```
public FBox top
```
    The top edge of the world. For this edge to exist, the edges must have been created by calling setEdges().
    
    See Also:
    
    left, right, bottom, top
  - bottom
```
public FBox bottom
```
    The bottom edge of the world. For this edge to exist, the edges must have been created by calling setEdges().
    
    See Also:
    
    left, right, bottom, top
  - m_topLeftX
```
protected float m_topLeftX
```
  - m_topLeftY
```
protected float m_topLeftY
```
  - m_bottomRightX
```
protected float m_bottomRightX
```
  - m_bottomRightY
```
protected float m_bottomRightY
```
  - m_edgesFriction
```
protected float m_edgesFriction
```
  - m_edgesRestitution
```
protected float m_edgesRestitution
```
  - m_grabbable
```
protected boolean m_grabbable
```
  - m_grabPositionX
```
protected float m_grabPositionX
```
  - m_grabPositionY
```
protected float m_grabPositionY
```
  - m_mouseButton
```
protected int m_mouseButton
```
  - m_contacts
```
protected HashMap m_contacts
```
  - m_contactResults
```
protected ArrayList m_contactResults
```
  - m_actions
```
protected LinkedList m_actions
```
  - m_fbodies
```
protected ArrayList m_fbodies
```
  - m_mouseJoint
```
protected FMouseJoint m_mouseJoint
```
- Constructor Detail
  - FWorld
```
public FWorld(float topLeftX,
              float topLeftY,
              float bottomRightX,
              float bottomRightY)
```
    Constructs the world where all the bodies live in. We usually want to build the world larger than the actual screen, because when bodies exit the world they will appear stuck since they do not get update anymore. By default the world's width and height are three times larger than those of the Processing canvas. FWorld world; void setup() { size(200, 200); Fisica.init(this); world = new FWorld(-width, -height, 2*width, 2*height); }
    
    Parameters:
    
    topLeftX - the horizontal coordinate of the top left corner of the world
    
    topLeftY - the vertical coordinate of the top left corner of the world
    
    bottomRightX - the horizontal coordinate of the bottom right corner of the world
    
    bottomRightY - the vertical coordinate of the bottom right corner of the world
    
    See Also:
    
    FBody
  - FWorld
```
public FWorld()
```
- Method Detail
  - addBody
```
public void addBody(FBody body)
```
  - removeBody
```
public void removeBody(FBody body)
```
  - addJoint
```
public void addJoint(FJoint joint)
```
  - removeJoint
```
public void removeJoint(FJoint joint)
```
  - setContactListener
```
public void setContactListener(FContactListener listener)
```
  - setContactListener
```
public void setContactListener(org.jbox2d.dynamics.ContactListener listener)
```
    Overrides:
    
    setContactListener in class org.jbox2d.dynamics.World
  - grabBody
```
public void grabBody(float x,
                     float y)
```
  - dragBody
```
public void dragBody(float x,
                     float y)
```
  - releaseBody
```
public void releaseBody()
```
  - mouseEvent
```
public void mouseEvent(def.processing.event.MouseEvent event)
```
    This is an internal method to handle mouse interaction and should not be used.
  - getMouseJoint
```
public FMouseJoint getMouseJoint()
```
    Returns the mouse joint that is used for interaction with the bodies in the world.
    
    Returns:
    
    the mouse joint used for grabbing bodies
  - setGrabbable
```
public void setGrabbable(boolean value)
```
    Controls whether the bodies in the world can be grabbed by the mouse or not. By default the world bodies' are grabbable and draggable. world.setGrabbable(false);
    
    Parameters:
    
    value - if true the bodies that live in this world can be grabbed and dragged using the mouse
    
    See Also:
    
    FBody
  - processActions
```
public void processActions()
```
  - draw
```
public void draw(def.processing.core.PGraphics graphics)
```
    Draws all the bodies in the world. This method is often called in the draw method of the applet.
    
    Parameters:
    
    graphics - graphics to which to draw the world. Useful when trying to draw the world on other buffers, such as when using createGraphics
    
    See Also:
    
    FBody
  - drawDebug
```
public void drawDebug(def.processing.core.PGraphics graphics)
```
    Draws the debug version of all the bodies in the world. This method is often called in the draw method of the applet.
    
    Parameters:
    
    graphics - graphics to which to draw the world. Useful when trying to draw the world on other buffers, such as when using createGraphics
    
    See Also:
    
    FBody
  - draw
```
public void draw()
```
    Draws all the bodies in the world on the applet canvas. This method is often called in the draw method of the applet.
    
    See Also:
    
    FBody
  - drawDebug
```
public void drawDebug()
```
    Draws the debug version of all the bodies in the world on the applet canvas. This method is often called in the draw method of the applet.
    
    See Also:
    
    FBody
  - add
```
public void add(FBody body)
```
    Add a body to the world.
    
    Parameters:
    
    body - body to be added to the world
    
    See Also:
    
    remove(FBody)
  - remove
```
public void remove(FBody body)
```
    Remove a body from the world.
    
    Parameters:
    
    body - body to be removed from the world
    
    See Also:
    
    add(FBody)
  - add
```
public void add(FJoint joint)
```
    Add a joint to the world.
    
    Parameters:
    
    joint - joint to be added to the world
    
    See Also:
    
    remove(FJoint)
  - remove
```
public void remove(FJoint joint)
```
    Remove a joint from the world.
    
    Parameters:
    
    joint - joint to be removed from the world
    
    See Also:
    
    add(FJoint)
  - clear
```
public void clear()
```
    Clear all bodies and joints from the world. NOT IMPLEMENTED YET.
  - setEdges
```
public void setEdges(float topLeftX,
                     float topLeftY,
                     float bottomRightX,
                     float bottomRightY,
                     int color)
```
    Add edges of given dimensions to the world. This will create the bodies for left, right, bottom and top.
    
    Parameters:
    
    topLeftX - the horizontal coordinate of the top left corner of the edges
    
    topLeftY - the vertical coordinate of the top left corner of the edges
    
    bottomRightX - the horizontal coordinate of the bottom right corner of the edges
    
    bottomRightY - the vertical coordinate of the bottom right corner of the edges
    
    color - the color of the edges. This color must be passed using Processing's color() function
  - setEdges
```
public void setEdges(float topLeftX,
                     float topLeftY,
                     float bottomRightX,
                     float bottomRightY)
```
    Add black edges of given dimensions to the world. This will create the bodies for left, right, bottom and top.
    
    Parameters:
    
    topLeftX - the horizontal coordinate of the top left corner of the edges
    
    topLeftY - the vertical coordinate of the top left corner of the edges
    
    bottomRightX - the horizontal coordinate of the bottom right corner of the edges
    
    bottomRightY - the vertical coordinate of the bottom right corner of the edges
    
    color - the color of the edges. This color must be passed using Processing's color() function
  - setEdges
```
public void setEdges(def.processing.core.PApplet applet,
                     int color)
```
    Add edges of given applet's dimensions to the world. This will create the bodies for left, right, bottom and top.
    
    Parameters:
    
    applet - applet from where to get the dimensions for the edges
    
    color - the color of the edges. This color must be passed using Processing's color() function
  - setEdges
```
public void setEdges(int color)
```
    Add edges of Processing's canvas dimensions to the world. This will create the bodies for left, right, bottom and top.
    
    Parameters:
    
    color - the color of the edges. This color must be passed using Processing's color() function
  - setEdges
```
public void setEdges()
```
    Add black edges of Processing's canvas dimensions to the world. This will create the bodies for left, right, bottom and top.
  - setEdgesFriction
```
public void setEdgesFriction(float friction)
```
    Set the friction of all the edges.
    
    Parameters:
    
    friction - the friction of the edges
  - setEdgesRestitution
```
public void setEdgesRestitution(float restitution)
```
    Set the restitution of all the edges.
    
    Parameters:
    
    restitution - the restitution of the edges
  - setGravity
```
public void setGravity(float gx,
                       float gy)
```
    Set the gravity of the world. Use world.setGravity(0,0); to have a world without gravity.
    
    Parameters:
    
    gx - the horizontal component of the gravity
    
    gy - the vertical component of the gravity
  - setGravity
```
public void setGravity(org.jbox2d.common.Vec2 vector)
```
    Overrides:
    
    setGravity in class org.jbox2d.dynamics.World
  - step
```
public void step()
```
    Advance the world simulation of 1/60th of a second.
  - step
```
public void step(float dt)
```
    Advance the world simulation of given time.
    
    Parameters:
    
    dt - the time to advance the world simulation
  - step
```
public void step(float dt,
                 int iterationCount)
```
    Advance the world simulation of given time, with a given number of iterations. The larger the number of iterations, the more computationally expensive and precise it will be. The default is 10 iterations.
    
    Overrides:
    
    step in class org.jbox2d.dynamics.World
    
    Parameters:
    
    dt - the time to advance the world simulation
    
    iterationCount - the number of iterations for the world simulation step
  - getBody
```
public FBody getBody(float x,
                     float y)
```
    Returns the first object found at the given position.
    
    Parameters:
    
    x - the horizontal component of the position
    
    y - the vertical component of the position
    
    Returns:
    
    the body found at the given position
  - getBody
```
public FBody getBody(float x,
                     float y,
                     boolean getStatic)
```
    Returns the first object found at the given position.
    
    Parameters:
    
    x - the horizontal component of the position
    
    y - the vertical component of the position
    
    getStatic - if true it will also get static objects that can be found at that position
    
    Returns:
    
    the body found at the given position
  - getBodies
```
public ArrayList getBodies()
```
    Returns a list with all the bodies in the world
    
    Returns:
    
    an ArrayList (of FBody) of the bodies in the world
  - getBodies
```
public ArrayList getBodies(float x,
                           float y)
```
    Returns a list with the 10 first bodies found at the given position.
    
    Parameters:
    
    x - the horizontal component of the position
    
    y - the vertical component of the position
    
    Returns:
    
    an ArrayList (of FBody) of the 10 first bodies found at the given position
  - getBodies
```
public ArrayList getBodies(float x,
                           float y,
                           boolean getStatic)
```
    Returns a list with the 10 first bodies found at the given position.
    
    Parameters:
    
    x - the horizontal component of the position
    
    y - the vertical component of the position
    
    getStatic - if true it will also get static objects that can be found at that position
    
    Returns:
    
    an ArrayList (of FBody) of the 10 first bodies found at the given position
  - getBodies
```
public ArrayList getBodies(float x,
                           float y,
                           boolean getStatic,
                           int count)
```
    Returns a list with all the bodies found at the given position.
    
    Parameters:
    
    x - the horizontal component of the position
    
    y - the vertical component of the position
    
    getStatic - if true it will also get static objects that can be found at that position
    
    count - the maximum number of bodies to be retrieved
    
    Returns:
    
    an ArrayList (of FBody) of all bodies found at the given position
  - raycast
```
public int raycast(float x1,
                   float y1,
                   float x2,
                   float y2,
                   FBody[] bodies,
                   int maxCount,
                   boolean solidShapes)
```
  - raycast
```
public int raycast(org.jbox2d.collision.Segment segment,
                   org.jbox2d.collision.shapes.Shape[] shapes,
                   int maxCount,
                   boolean solidShapes,
                   Object userData)
```
    Overrides:
    
    raycast in class org.jbox2d.dynamics.World
  - raycastOne
```
public org.jbox2d.collision.shapes.Shape raycastOne(org.jbox2d.collision.Segment segment,
                                                    org.jbox2d.common.RaycastResult result,
                                                    boolean solidShapes,
                                                    Object userData)
```
    Overrides:
    
    raycastOne in class org.jbox2d.dynamics.World
  - raycastOne
```
public FBody raycastOne(float x1,
                        float y1,
                        float x2,
                        float y2,
                        FRaycastResult result,
                        boolean solidShapes)
```

Class FWorld

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.jbox2d.dynamics.World

Methods inherited from class java.lang.Object

Field Detail

left

right

top

bottom

m_topLeftX

m_topLeftY

m_bottomRightX

m_bottomRightY

m_edgesFriction

m_edgesRestitution

m_grabbable

m_grabPositionX

m_grabPositionY

m_mouseButton

m_contacts

m_contactResults

m_actions

m_fbodies

m_mouseJoint

Constructor Detail

FWorld

FWorld

Method Detail

addBody

removeBody

addJoint

removeJoint

setContactListener

setContactListener

grabBody

dragBody

releaseBody

mouseEvent

getMouseJoint

setGrabbable

processActions

draw

drawDebug

draw

drawDebug

add

remove

add

remove

clear

setEdges

setEdges

setEdges

setEdges

setEdges

setEdgesFriction

setEdgesRestitution

setGravity

setGravity

step

step

step

getBody

getBody

getBodies

getBodies

getBodies

getBodies

raycast

raycast

raycastOne

raycastOne