ch.hevs.gdx2d.lib.physics

Class AbstractPhysicsObject

java.lang.Object

ch.hevs.gdx2d.lib.physics.AbstractPhysicsObject

All Implemented Interfaces:

BodyInterface, ContactListener

Direct Known Subclasses:

PhysicsBox, PhysicsCircle, PhysicsPolygon, PhysicsStaticBox, PhysicsStaticCircle, PhysicsStaticLine

public abstract class AbstractPhysicsObject
extends Object
implements ContactListener, BodyInterface

An abstract physical object that contains everything required for simulation.
For concrete instances, see PhysicsBox, PhysicsCircle, PhysicsPolygon, PhysicsStaticBox and PhysicsStaticCircle.

Version:

1.3

Author:

Pierre-André Mudry (mui)

Field Summary

Fields

Modifier and Type	Field and Description
protected Fixture	f The physical characteristics of the the object, such as friction etc...
String	name A name for the object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPhysicsObject(Shape.Type t, String name, Vector2 position, float width, float height, float density, float restitution, float friction, boolean isDynamic) Abstract constructor.
protected	AbstractPhysicsObject(Shape.Type t, String name, Vector2 position, float width, float height, float density, float restitution, float friction, float angle, boolean isDynamic) Abstract constructor.
protected	AbstractPhysicsObject(String name, Vector2 position, Vector2[] vertices, float density, float restitution, float friction, boolean isDynamic) Abstract constructor.

Method Summary

Modifier and Type	Method and Description
void	applyBodyAngularImpulse(float impulse, boolean wake)
void	applyBodyForce(float forceX, float forceY, float pointX, float pointY, boolean wake)
void	applyBodyForce(Vector2 force, Vector2 point, boolean wake)
void	applyBodyForceToCenter(float forceX, float forceY, boolean wake)
void	applyBodyForceToCenter(Vector2 force, boolean wake)
void	applyBodyLinearImpulse(float impulseX, float impulseY, float pointX, float pointY, boolean wake)
void	applyBodyLinearImpulse(Vector2 impulse, Vector2 point, boolean wake)
void	applyBodyTorque(float torque, boolean wake)
void	beginContact(Contact contact)
void	collision(AbstractPhysicsObject theOtherObject, float energy) A collision occurred between this object and another.
protected void	createFixture(Shape s, float density, float restitution, float friction) Creates the fixture (collision information) attached to the object
void	destroy() Should be called to destroy a simulated object Warning, deletion will happen at the next simulation step, not immediately
void	enableCollisionListener() Makes the object react on collisions
void	endContact(Contact contact)
Body	getBody() Convenience method for some special operations.
float	getBodyAngle()
float	getBodyAngleDeg()
float	getBodyAngularDamping()
float	getBodyAngularVelocity()
Array<Fixture>	getBodyFixtureList()
float	getBodyGravityScale()
float	getBodyInertia()
float	getBodyLinearDamping()
Vector2	getBodyLinearVelocity()
Vector2	getBodyLinearVelocityFromLocalPoint(Vector2 v)
Vector2	getBodyLinearVelocityFromWorldPoint(Vector2 v)
Vector2	getBodyLinearVelocityPixels()
Vector2	getBodyLocalCenter()
Vector2	getBodyLocalPoint(Vector2 v)
Vector2	getBodyLocalVector(Vector2 v)
float	getBodyMass()
MassData	getBodyMassData()
Vector2	getBodyPosition() Body method redefinition for meters / pixels.
float	getBodyRadius()
Transform	getBodyTransform()
World	getBodyWorld()
Vector2	getBodyWorldCenter()
Vector2	getBodyWorldPoint(Vector2 v)
Vector2	getBodyWorldVector(Vector2 v)
boolean	isBodyActive()
boolean	isBodyAwake()
boolean	isBodyBullet()
boolean	isBodyFixedRotation()
boolean	isBodySleepingAllowed()
void	postSolve(Contact contact, ContactImpulse impulse)
void	preSolve(Contact contact, Manifold oldManifold)
void	setBodyActive(boolean active)
void	setBodyAngularDamping(float damping)
void	setBodyAwake(boolean awake)
void	setBodyLinearDamping(float damping)
void	setBodyLinearVelocity(float vx, float vy)
void	setBodyLinearVelocity(Vector2 v)
void	setCollisionGroup(int id) Sets a collision group to all fixtures of an AbstractPhysicsObject.
void	setSensor(boolean enable) Set (or unset) sensor mode

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

A name for the object

f

protected Fixture f

The physical characteristics of the the object, such as friction etc...

Constructor Detail

AbstractPhysicsObject

protected AbstractPhysicsObject(Shape.Type t,
                                String name,
                                Vector2 position,
                                float width,
                                float height,
                                float density,
                                float restitution,
                                float friction,
                                boolean isDynamic)

Abstract constructor.

AbstractPhysicsObject

protected AbstractPhysicsObject(String name,
                                Vector2 position,
                                Vector2[] vertices,
                                float density,
                                float restitution,
                                float friction,
                                boolean isDynamic)

Abstract constructor.

AbstractPhysicsObject

protected AbstractPhysicsObject(Shape.Type t,
                                String name,
                                Vector2 position,
                                float width,
                                float height,
                                float density,
                                float restitution,
                                float friction,
                                float angle,
                                boolean isDynamic)

Abstract constructor.

Method Detail

createFixture

protected void createFixture(Shape s,
                             float density,
                             float restitution,
                             float friction)

Creates the fixture (collision information) attached to the object

Parameters:

s - The shape we want for collision

density - The density of the object, in kg/ms²

restitution - For elastic collisions

friction - Coulomb friction, does not work for circles

destroy

public void destroy()

Should be called to destroy a simulated object Warning, deletion will happen at the next simulation step, not immediately

enableCollisionListener

public void enableCollisionListener()

Makes the object react on collisions

collision

public void collision(AbstractPhysicsObject theOtherObject,
                      float energy)

A collision occurred between this object and another.

Parameters:

theOtherObject - the collides object

energy - the collision energy

setCollisionGroup

public void setCollisionGroup(int id)

Sets a collision group to all fixtures of an AbstractPhysicsObject.

Collision groups let you specify an integral group index. You can have all fixtures with the same group index always collide (positive index) or never collide (negative index).

See http://www.aurelienribon.com/blog/2011/07/box2d-tutorial-collision-filtering/

Parameters:

id - the identifier of the group

beginContact

public void beginContact(Contact contact)

Specified by:

beginContact in interface ContactListener

endContact

public void endContact(Contact contact)

Specified by:

endContact in interface ContactListener

postSolve

public void postSolve(Contact contact,
                      ContactImpulse impulse)

Specified by:

postSolve in interface ContactListener

preSolve

public void preSolve(Contact contact,
                     Manifold oldManifold)

Specified by:

preSolve in interface ContactListener

getBodyPosition

public Vector2 getBodyPosition()

Body method redefinition for meters / pixels. Implementation of the BodyInterface interface.

Specified by:

getBodyPosition in interface BodyInterface

Returns:

The physics body position, in the pixel space

getBodyLocalCenter

public Vector2 getBodyLocalCenter()

Specified by:

getBodyLocalCenter in interface BodyInterface

Returns:

The physics body central position, in the pixel space

getBodyAngle

public float getBodyAngle()

Specified by:

getBodyAngle in interface BodyInterface

Returns:

The current angle of the physics object, in radians

getBodyAngleDeg

public float getBodyAngleDeg()

Specified by:

getBodyAngleDeg in interface BodyInterface

Returns:

The current angle of the physics object, in degrees

getBodyRadius

public float getBodyRadius()

Specified by:

getBodyRadius in interface BodyInterface

Returns:

the radius of the current circle shape. If not a circle shape, throws an UnsupportedOperationException

Throws:

UnsupportedOperationException

applyBodyTorque

public void applyBodyTorque(float torque,
                            boolean wake)

Specified by:

applyBodyTorque in interface BodyInterface

getBodyAngularDamping

public float getBodyAngularDamping()

Specified by:

getBodyAngularDamping in interface BodyInterface

setBodyAngularDamping

public void setBodyAngularDamping(float damping)

Specified by:

setBodyAngularDamping in interface BodyInterface

getBodyLinearDamping

public float getBodyLinearDamping()

Specified by:

getBodyLinearDamping in interface BodyInterface

setBodyLinearDamping

public void setBodyLinearDamping(float damping)

Specified by:

setBodyLinearDamping in interface BodyInterface

getBodyLinearVelocity

public Vector2 getBodyLinearVelocity()

Specified by:

getBodyLinearVelocity in interface BodyInterface

setBodyLinearVelocity

public void setBodyLinearVelocity(Vector2 v)

Specified by:

setBodyLinearVelocity in interface BodyInterface

getBodyLinearVelocityPixels

public Vector2 getBodyLinearVelocityPixels()

getBodyLinearVelocityFromLocalPoint

public Vector2 getBodyLinearVelocityFromLocalPoint(Vector2 v)

Specified by:

getBodyLinearVelocityFromLocalPoint in interface BodyInterface

getBodyLinearVelocityFromWorldPoint

public Vector2 getBodyLinearVelocityFromWorldPoint(Vector2 v)

Specified by:

getBodyLinearVelocityFromWorldPoint in interface BodyInterface

getBodyAngularVelocity

public float getBodyAngularVelocity()

Specified by:

getBodyAngularVelocity in interface BodyInterface

getBodyFixtureList

public Array<Fixture> getBodyFixtureList()

Specified by:

getBodyFixtureList in interface BodyInterface

getBodyGravityScale

public float getBodyGravityScale()

Specified by:

getBodyGravityScale in interface BodyInterface

getBodyInertia

public float getBodyInertia()

Specified by:

getBodyInertia in interface BodyInterface

getBodyLocalPoint

public Vector2 getBodyLocalPoint(Vector2 v)

Specified by:

getBodyLocalPoint in interface BodyInterface

getBodyLocalVector

public Vector2 getBodyLocalVector(Vector2 v)

Specified by:

getBodyLocalVector in interface BodyInterface

getBodyMass

public float getBodyMass()

Specified by:

getBodyMass in interface BodyInterface

getBodyMassData

public MassData getBodyMassData()

Specified by:

getBodyMassData in interface BodyInterface

getBodyTransform

public Transform getBodyTransform()

Specified by:

getBodyTransform in interface BodyInterface

getBodyWorld

public World getBodyWorld()

Specified by:

getBodyWorld in interface BodyInterface

getBodyWorldCenter

public Vector2 getBodyWorldCenter()

Specified by:

getBodyWorldCenter in interface BodyInterface

getBodyWorldPoint

public Vector2 getBodyWorldPoint(Vector2 v)

Specified by:

getBodyWorldPoint in interface BodyInterface

getBodyWorldVector

public Vector2 getBodyWorldVector(Vector2 v)

Specified by:

getBodyWorldVector in interface BodyInterface

isBodyActive

public boolean isBodyActive()

Specified by:

isBodyActive in interface BodyInterface

setBodyActive

public void setBodyActive(boolean active)

Specified by:

setBodyActive in interface BodyInterface

isBodyAwake

public boolean isBodyAwake()

Specified by:

isBodyAwake in interface BodyInterface

setBodyAwake

public void setBodyAwake(boolean awake)

Specified by:

setBodyAwake in interface BodyInterface

isBodyBullet

public boolean isBodyBullet()

Specified by:

isBodyBullet in interface BodyInterface

isBodyFixedRotation

public boolean isBodyFixedRotation()

Specified by:

isBodyFixedRotation in interface BodyInterface

isBodySleepingAllowed

public boolean isBodySleepingAllowed()

Specified by:

isBodySleepingAllowed in interface BodyInterface

setBodyLinearVelocity

public void setBodyLinearVelocity(float vx,
                                  float vy)

Specified by:

setBodyLinearVelocity in interface BodyInterface

applyBodyAngularImpulse

public void applyBodyAngularImpulse(float impulse,
                                    boolean wake)

Specified by:

applyBodyAngularImpulse in interface BodyInterface

applyBodyForce

public void applyBodyForce(float forceX,
                           float forceY,
                           float pointX,
                           float pointY,
                           boolean wake)

Specified by:

applyBodyForce in interface BodyInterface

applyBodyForce

public void applyBodyForce(Vector2 force,
                           Vector2 point,
                           boolean wake)

Specified by:

applyBodyForce in interface BodyInterface

applyBodyForceToCenter

public void applyBodyForceToCenter(float forceX,
                                   float forceY,
                                   boolean wake)

Specified by:

applyBodyForceToCenter in interface BodyInterface

applyBodyForceToCenter

public void applyBodyForceToCenter(Vector2 force,
                                   boolean wake)

Specified by:

applyBodyForceToCenter in interface BodyInterface

applyBodyLinearImpulse

public void applyBodyLinearImpulse(float impulseX,
                                   float impulseY,
                                   float pointX,
                                   float pointY,
                                   boolean wake)

Specified by:

applyBodyLinearImpulse in interface BodyInterface

applyBodyLinearImpulse

public void applyBodyLinearImpulse(Vector2 impulse,
                                   Vector2 point,
                                   boolean wake)

Specified by:

applyBodyLinearImpulse in interface BodyInterface

setSensor

public void setSensor(boolean enable)

Set (or unset) sensor mode

Parameters:

enable - Set the body traversable, but still sensible to collisions

getBody

public Body getBody()

Convenience method for some special operations. You should not use that normally because the dimensions are not scaled appropriately in the object itself.

Returns:

The body for the simulation