de.gurkenlabs.litiengine.physics

Class PhysicsEngine

java.lang.Object

de.gurkenlabs.litiengine.physics.PhysicsEngine

All Implemented Interfaces:

IUpdateable

public final class PhysicsEngine
extends java.lang.Object
implements IUpdateable

This class is used to hold all collision aware instances and static collision boxes. It is responsible for resolving movement that respects the collision boxes in the game. This is achieved by the move method group.
The collides method group can detect a collision at a certain location, for rectangles, or collision aware entities. Also, there's an overload that takes a Line2D to perform a basic raycast check.

Constructor Summary

Constructors

Constructor and Description
PhysicsEngine() You should never call this manually! Instead use the Game.physics() instance.

Method Summary

Modifier and Type	Method and Description
void	add(ICollisionEntity entity) Adds the specified collision aware entity to the physics engine which will make it respect the entity's collision box for upcoming calls.
void	clear() Clears all previously registered participants in the collision process from this instance.
boolean	collides(double x, double y)
boolean	collides(double x, double y, Collision collisionType)
boolean	collides(double x, double y, ICollisionEntity collisionEntity)
boolean	collides(ICollisionEntity collisionEntity)
boolean	collides(ICollisionEntity collisionEntity, Collision collisionType)
boolean	collides(java.awt.geom.Line2D line)
boolean	collides(java.awt.geom.Line2D line, Collision collision)
boolean	collides(java.awt.geom.Line2D line, Collision collision, ICollisionEntity entity)
boolean	collides(java.awt.geom.Line2D line, ICollisionEntity entity)
boolean	collides(java.awt.geom.Point2D location)
boolean	collides(java.awt.geom.Point2D location, Collision type)
boolean	collides(java.awt.geom.Point2D location, Collision type, ICollisionEntity entity)
boolean	collides(java.awt.geom.Point2D location, ICollisionEntity collisionEntity)
boolean	collides(java.awt.geom.Rectangle2D rect)
boolean	collides(java.awt.geom.Rectangle2D collisionBox, Collision type)
boolean	collides(java.awt.geom.Rectangle2D rectangle, Collision type, ICollisionEntity entity)
boolean	collides(java.awt.geom.Rectangle2D rect, ICollisionEntity collisionEntity) Checks whether the specified rectangle collides with the specified entity.
java.awt.geom.Rectangle2D	getBounds()
java.util.Collection<java.awt.geom.Rectangle2D>	getCollisionBoxes()
java.util.Collection<java.awt.geom.Rectangle2D>	getCollisionBoxes(Collision type)
java.util.Collection<ICollisionEntity>	getCollisionEntities()
java.util.Collection<ICollisionEntity>	getCollisionEntities(Collision type)
boolean	move(IMobileEntity entity, Direction direction, double delta)
boolean	move(IMobileEntity entity, double angle, double delta) Moves the specified entity by the delta in the direction of the angle.
boolean	move(IMobileEntity entity, double x, double y, float delta)
boolean	move(IMobileEntity entity, float delta)
boolean	move(IMobileEntity entity, java.awt.geom.Point2D newLocation)
boolean	move(IMobileEntity entity, java.awt.geom.Point2D target, float delta)
RaycastHit	raycast(java.awt.geom.Line2D line)
RaycastHit	raycast(java.awt.geom.Line2D line, Collision collisionType)
RaycastHit	raycast(java.awt.geom.Line2D line, Collision collisionType, ICollisionEntity entity)
RaycastHit	raycast(java.awt.geom.Line2D line, ICollisionEntity entity)
RaycastHit	raycast(java.awt.geom.Point2D point, double angle)
RaycastHit	raycast(java.awt.geom.Point2D start, java.awt.geom.Point2D target)
RaycastHit	raycast(java.awt.geom.Point2D start, java.awt.geom.Point2D target, Collision collisionType)
void	remove(ICollisionEntity entity) Removes the specified entity from any collision processing.
void	setBounds(java.awt.geom.Rectangle2D environmentBounds)
void	update() This method is called by the game loop on all objects that are attached to the loop.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PhysicsEngine

public PhysicsEngine()

You should never call this manually! Instead use the Game.physics() instance.

See Also:

Game.physics()

Method Detail

add

public void add(ICollisionEntity entity)

Adds the specified collision aware entity to the physics engine which will make it respect the entity's collision box for upcoming calls.

If you add a ICollisionEntiy to your Environment, it will automatically be added to the the PhysicsEngine. There is typically no need to call this explicitly.

Parameters:

entity - The collision entity to be added.

See Also:

ICollisionEntity.getCollisionBox(), remove(ICollisionEntity)

remove

public void remove(ICollisionEntity entity)

Removes the specified entity from any collision processing. Typically this method is implicitly called when an entity is removed from the current environment.

Parameters:

entity - The entity that is about to be removed.

clear

public void clear()

Clears all previously registered participants in the collision process from this instance. This includes all entities, static collision boxes and the map boundaries.

getCollisionBoxes

public java.util.Collection<java.awt.geom.Rectangle2D> getCollisionBoxes()

getCollisionBoxes

public java.util.Collection<java.awt.geom.Rectangle2D> getCollisionBoxes(Collision type)

getCollisionEntities

public java.util.Collection<ICollisionEntity> getCollisionEntities()

getCollisionEntities

public java.util.Collection<ICollisionEntity> getCollisionEntities(Collision type)

getBounds

public java.awt.geom.Rectangle2D getBounds()

setBounds

public void setBounds(java.awt.geom.Rectangle2D environmentBounds)

collides

public boolean collides(java.awt.geom.Line2D line)

collides

public boolean collides(java.awt.geom.Line2D line,
                        Collision collision)

collides

public boolean collides(java.awt.geom.Line2D line,
                        ICollisionEntity entity)

collides

public boolean collides(java.awt.geom.Line2D line,
                        Collision collision,
                        ICollisionEntity entity)

collides

public boolean collides(java.awt.geom.Rectangle2D rect)

collides

public boolean collides(java.awt.geom.Rectangle2D rect,
                        ICollisionEntity collisionEntity)

Checks whether the specified rectangle collides with the specified entity.

Parameters:

rect - The rectangle to check the collision for.

collisionEntity - The entity on which this collision check is based on.

Returns:

Returns true if the specified rectangle collides with any collision box of the specified type(s); otherwise false.

collides

public boolean collides(java.awt.geom.Rectangle2D collisionBox,
                        Collision type)

collides

public boolean collides(java.awt.geom.Rectangle2D rectangle,
                        Collision type,
                        ICollisionEntity entity)

collides

public boolean collides(java.awt.geom.Point2D location)

collides

public boolean collides(java.awt.geom.Point2D location,
                        Collision type)

collides

public boolean collides(java.awt.geom.Point2D location,
                        ICollisionEntity collisionEntity)

collides

public boolean collides(java.awt.geom.Point2D location,
                        Collision type,
                        ICollisionEntity entity)

collides

public boolean collides(double x,
                        double y)

collides

public boolean collides(double x,
                        double y,
                        Collision collisionType)

collides

public boolean collides(double x,
                        double y,
                        ICollisionEntity collisionEntity)

collides

public boolean collides(ICollisionEntity collisionEntity)

collides

public boolean collides(ICollisionEntity collisionEntity,
                        Collision collisionType)

raycast

public RaycastHit raycast(java.awt.geom.Point2D point,
                          double angle)

raycast

public RaycastHit raycast(java.awt.geom.Point2D start,
                          java.awt.geom.Point2D target)

raycast

public RaycastHit raycast(java.awt.geom.Point2D start,
                          java.awt.geom.Point2D target,
                          Collision collisionType)

raycast

public RaycastHit raycast(java.awt.geom.Line2D line)

raycast

public RaycastHit raycast(java.awt.geom.Line2D line,
                          Collision collisionType)

raycast

public RaycastHit raycast(java.awt.geom.Line2D line,
                          ICollisionEntity entity)

raycast

public RaycastHit raycast(java.awt.geom.Line2D line,
                          Collision collisionType,
                          ICollisionEntity entity)

move

public boolean move(IMobileEntity entity,
                    double angle,
                    double delta)

Moves the specified entity by the delta in the direction of the angle.

Parameters:

entity - the entity

angle - the angle

delta - the delta

Returns:

true, if successful, false if the physics engine detected a collision.

move

public boolean move(IMobileEntity entity,
                    Direction direction,
                    double delta)

move

public boolean move(IMobileEntity entity,
                    double x,
                    double y,
                    float delta)

move

public boolean move(IMobileEntity entity,
                    float delta)

move

public boolean move(IMobileEntity entity,
                    java.awt.geom.Point2D newLocation)

move

public boolean move(IMobileEntity entity,
                    java.awt.geom.Point2D target,
                    float delta)

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.

Specified by:

update in interface IUpdateable

See Also:

ClientConfiguration.setMaxFps(int)