com.almasb.fxgl.physics

Class PhysicsWorld

java.lang.Object

com.almasb.fxgl.physics.PhysicsWorld

All Implemented Interfaces:

com.almasb.ents.EntityWorldListener, org.jbox2d.callbacks.ContactListener

public final class PhysicsWorld
extends Object
implements com.almasb.ents.EntityWorldListener, org.jbox2d.callbacks.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) (almaslvl@gmail.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PhysicsWorld.PhysicsParticleControl The difference between physics and normal particle entity is that the former is managed (controlled) by the physics world, the latter by the particle emitters.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PhysicsWorld(double appHeight, double ppm)

Method Summary

Modifier and Type	Method and Description
void	addCollisionHandler(CollisionHandler handler) Registers a collision handler.
void	beginContact(org.jbox2d.dynamics.contacts.Contact contact)
void	endContact(org.jbox2d.dynamics.contacts.Contact contact)
org.jbox2d.dynamics.World	getJBox2DWorld() Note: certain modifications to the jbox2d world directly may not be recognized by FXGL.
void	onEntityAdded(com.almasb.ents.Entity entity)
void	onEntityRemoved(com.almasb.ents.Entity entity)
void	onWorldReset() Resets physics world.
void	onWorldUpdate(double tpf)
void	postSolve(org.jbox2d.dynamics.contacts.Contact contact, org.jbox2d.callbacks.ContactImpulse impulse)
void	preSolve(org.jbox2d.dynamics.contacts.Contact contact, org.jbox2d.collision.Manifold oldManifold)
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
com.almasb.gameutils.math.Vec2	toPoint(javafx.geometry.Point2D p) Converts a point in pixel space to a point in physics space.
javafx.geometry.Point2D	toPoint(com.almasb.gameutils.math.Vec2 p) Converts a point in physics space to a point in pixel space.
com.almasb.gameutils.math.Vec2	toVector(javafx.geometry.Point2D v) Converts a vector of type Point2D to vector of type Vec2
javafx.geometry.Point2D	toVector(com.almasb.gameutils.math.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

@Inject
protected PhysicsWorld(double appHeight,
                                double ppm)

Method Detail

getJBox2DWorld

public org.jbox2d.dynamics.World getJBox2DWorld()

Note: certain modifications to the jbox2d world directly may not be recognized by FXGL.

Returns:

raw jbox2d physics world

onEntityAdded

public void onEntityAdded(com.almasb.ents.Entity entity)

Specified by:

onEntityAdded in interface com.almasb.ents.EntityWorldListener

onEntityRemoved

public void onEntityRemoved(com.almasb.ents.Entity entity)

Specified by:

onEntityRemoved in interface com.almasb.ents.EntityWorldListener

onWorldUpdate

public void onWorldUpdate(double tpf)

Specified by:

onWorldUpdate in interface com.almasb.ents.EntityWorldListener

onWorldReset

public void onWorldReset()

Resets physics world.

Specified by:

onWorldReset in interface com.almasb.ents.EntityWorldListener

beginContact

public void beginContact(org.jbox2d.dynamics.contacts.Contact contact)

Specified by:

beginContact in interface org.jbox2d.callbacks.ContactListener

endContact

public void endContact(org.jbox2d.dynamics.contacts.Contact contact)

Specified by:

endContact in interface org.jbox2d.callbacks.ContactListener

preSolve

public void preSolve(org.jbox2d.dynamics.contacts.Contact contact,
                     org.jbox2d.collision.Manifold oldManifold)

Specified by:

preSolve in interface org.jbox2d.callbacks.ContactListener

postSolve

public void postSolve(org.jbox2d.dynamics.contacts.Contact contact,
                      org.jbox2d.callbacks.ContactImpulse impulse)

Specified by:

postSolve in interface org.jbox2d.callbacks.ContactListener

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 com.almasb.gameutils.math.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(com.almasb.gameutils.math.Vec2 v)

Converts a vector of type Vec2 to vector of type Point2D

Parameters:

v - vector in meters

Returns:

vector in pixels

toPoint

public com.almasb.gameutils.math.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(com.almasb.gameutils.math.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