PhysicsWorld (fxgl 0.3.9 API)

java.lang.Object
- com.almasb.fxgl.physics.PhysicsWorld

All Implemented Interfaces:

EntityWorldListener, ContactListener
```
public final class PhysicsWorld
extends Object
implements EntityWorldListener, ContactListener
```
Manages physics entities, collision handling and performs the physics tick.
Contains several static and instance methods to convert pixels coordinates to meters and vice versa.
Collision handling unifies how they are processed.

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Constructor Summary

Constructors
Constructor and Description

PhysicsWorld(int appHeight, double ppm)

Constructors
Constructor and Description
`PhysicsWorld(int appHeight, double ppm)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCollisionHandler(CollisionHandler handler)` Registers a collision handler.
`void`	`beginContact(Contact contact)` Called when two fixtures begin to touch.
`void`	`clear()` Clears collidable entities and active collisions.
`void`	`clearCollisionHandlers()`
`void`	`endContact(Contact contact)` Called when two fixtures cease to touch.
`int`	`getAppHeight()`
`World`	`getJBox2DWorld()` Note: certain modifications to the jbox2d world directly may not be recognized by FXGL.
`void`	`onEntityAdded(Entity entity)` Called after entity was added to the world.
`void`	`onEntityRemoved(Entity entity)` Called after entity was removed from the world but before entity has been cleaned.
`void`	`onUpdate(double tpf)`
`void`	`postSolve(Contact contact, ContactImpulse impulse)` This lets you inspect a contact after the solver is finished.
`void`	`preSolve(Contact contact, Manifold oldManifold)` This is called after a contact is updated.
`RaycastResult`	`raycast(javafx.geometry.Point2D start, javafx.geometry.Point2D end)` Performs a ray cast from start point to end point.
`void`	`removeCollisionHandler(CollisionHandler handler)` Removes a collision handler
`void`	`setGravity(double x, double y)` Set global world gravity.
`float`	`toMeters(double pixels)` Converts pixels to meters
`float`	`toPixels(double meters)` Converts meters to pixels
`Vec2`	`toPoint(javafx.geometry.Point2D p)` Converts a point in pixel space to a point in physics space.
`javafx.geometry.Point2D`	`toPoint(Vec2 p)` Converts a point in physics space to a point in pixel space.
`Vec2`	`toVector(javafx.geometry.Point2D v)` Converts a vector of type Point2D to vector of type Vec2
`javafx.geometry.Point2D`	`toVector(Vec2 v)` Converts a vector of type Vec2 to vector of type Point2D

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

- Constructor Detail
  - PhysicsWorld
```
public PhysicsWorld(int appHeight,
                    double ppm)
```
- Method Detail
  - getJBox2DWorld
```
public World getJBox2DWorld()
```
    Note: certain modifications to the jbox2d world directly may not be recognized by FXGL.
    
    Returns:
    
    raw jbox2d physics world
  - getAppHeight
```
public int getAppHeight()
```
  - onEntityAdded
```
public void onEntityAdded(Entity entity)
```
    Description copied from interface: EntityWorldListener
    
    Called after entity was added to the world.
    
    Specified by:
    
    onEntityAdded in interface EntityWorldListener
    
    Parameters:
    
    entity - the entity
  - onEntityRemoved
```
public void onEntityRemoved(Entity entity)
```
    Description copied from interface: EntityWorldListener
    
    Called after entity was removed from the world but before entity has been cleaned. This allows other parties to free resources before doing final entity clean.
    
    Specified by:
    
    onEntityRemoved in interface EntityWorldListener
    
    Parameters:
    
    entity - the entity
  - onUpdate
```
public void onUpdate(double tpf)
```
  - clear
```
public void clear()
```
    Clears collidable entities and active collisions. Does not clear collision handlers.
  - clearCollisionHandlers
```
public void clearCollisionHandlers()
```
  - beginContact
```
public void beginContact(Contact contact)
```
    Description copied from interface: ContactListener
    
    Called when two fixtures begin to touch.
    
    Specified by:
    
    beginContact in interface ContactListener
    
    Parameters:
    
    contact - contact info
  - endContact
```
public void endContact(Contact contact)
```
    Description copied from interface: ContactListener
    
    Called when two fixtures cease to touch.
    
    Specified by:
    
    endContact in interface ContactListener
    
    Parameters:
    
    contact - contact info
  - preSolve
```
public void preSolve(Contact contact,
                     Manifold oldManifold)
```
    Description copied from interface: ContactListener
    This is called after a contact is updated. This allows you to inspect a contact before it goes to the solver. If you are careful, you can modify the contact manifold (e.g. disable contact). A copy of the old manifold is provided so that you can detect changes.
    Note:
    - This is called only for awake bodies.
    - This is called even when the number of contact points is zero.
    - This is not called for sensors.
    - If you set the number of contact points to zero, you will not get an EndContact callback. However, you may get a BeginContact callback the next step.
    - The oldManifold parameter is pooled, so it will be the same object for every callback for each thread.
    Specified by:
    
    preSolve in interface ContactListener
    
    Parameters:
    
    contact - contact info
    
    oldManifold - the old manifold
  - postSolve
```
public void postSolve(Contact contact,
                      ContactImpulse impulse)
```
    Description copied from interface: ContactListener
    This lets you inspect a contact after the solver is finished. This is useful for inspecting impulses.
    Note:
    - The contact manifold does not include time of impact impulses, which can be arbitrarily large if the sub-step is small. Hence the impulse is provided explicitly in a separate data structure.
    - This is only called for contacts that are touching, solid, and awake.
    - The impulse parameter is usually a pooled variable, so it will be modified after this call.
    Specified by:
    
    postSolve in interface ContactListener
    
    Parameters:
    
    contact - contact info
    
    impulse - contact impulse
  - addCollisionHandler
```
public void addCollisionHandler(CollisionHandler handler)
```
    Registers a collision handler. The order in which the types are passed to this method decides the order of objects being passed into the collision handler
```
 Example:
 PhysicsWorld physics = ...
 physics.addCollisionHandler(new CollisionHandler(Type.PLAYER, Type.ENEMY) {
      public void onCollisionBegin(Entity a, Entity b) {
          // called when entities start touching
      }
      public void onCollision(Entity a, Entity b) {
          // called when entities are touching
      }
      public void onCollisionEnd(Entity a, Entity b) {
          // called when entities are separated and no longer touching
      }
 });

 
```
    Parameters:
    
    handler - collision handler
  - removeCollisionHandler
```
public void removeCollisionHandler(CollisionHandler handler)
```
    Removes a collision handler
    
    Parameters:
    
    handler - collision handler to remove
  - setGravity
```
public void setGravity(double x,
                       double y)
```
    Set global world gravity.
    
    Parameters:
    
    x - x component
    
    y - y component
  - raycast
```
public RaycastResult raycast(javafx.geometry.Point2D start,
                             javafx.geometry.Point2D end)
```
    Performs a ray cast from start point to end point.
    
    Parameters:
    
    start - start point
    
    end - end point
    
    Returns:
    
    ray cast result
  - toMeters
```
public float toMeters(double pixels)
```
    Converts pixels to meters
    
    Parameters:
    
    pixels - value in pixels
    
    Returns:
    
    value in meters
  - toPixels
```
public float toPixels(double meters)
```
    Converts meters to pixels
    
    Parameters:
    
    meters - value in meters
    
    Returns:
    
    value in pixels
  - toVector
```
public Vec2 toVector(javafx.geometry.Point2D v)
```
    Converts a vector of type Point2D to vector of type Vec2
    
    Parameters:
    
    v - vector in pixels
    
    Returns:
    
    vector in meters
  - toVector
```
public javafx.geometry.Point2D toVector(Vec2 v)
```
    Converts a vector of type Vec2 to vector of type Point2D
    
    Parameters:
    
    v - vector in meters
    
    Returns:
    
    vector in pixels
  - toPoint
```
public Vec2 toPoint(javafx.geometry.Point2D p)
```
    Converts a point in pixel space to a point in physics space.
    
    Parameters:
    
    p - point in pixel space
    
    Returns:
    
    point in physics space
  - toPoint
```
public javafx.geometry.Point2D toPoint(Vec2 p)
```
    Converts a point in physics space to a point in pixel space.
    
    Parameters:
    
    p - point in physics space
    
    Returns:
    
    point in pixel space

Class PhysicsWorld

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PhysicsWorld

Method Detail

getJBox2DWorld

getAppHeight

onEntityAdded

onEntityRemoved

onUpdate

clear

clearCollisionHandlers

beginContact

endContact

preSolve

postSolve

addCollisionHandler

removeCollisionHandler

setGravity

raycast

toMeters

toPixels

toVector

toVector

toPoint

toPoint