LibGDX

Get the parent world of this body.

World As com.badlogic.gdx.physics.box2d.World [read only]

WorldCenter As lgMathVector2 [read only]

Get the world position of the center of mass.

lgBox2DBodyDef

A body definition holds all the data needed to construct a rigid body. You can safely re-use body definitions. Shapes are added
to a body after construction.

Events:

None

Members:

active As Boolean

allowSleep As Boolean

angle As Float

angularDamping As Float

angularVelocity As Float

awake As Boolean

bullet As Boolean

fixedRotation As Boolean

gravityScale As Float

linearDamping As Float

linearVelocity As lgMathVector2

position As lgMathVector2

type As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

Members description:

active As Boolean

Does this body start out active?

allowSleep As Boolean

Set this flag to false if this body should never fall asleep. Note that this increases CPU usage.

angle As Float

The world angle of the body in radians.

angularDamping As Float

Angular damping is use to reduce the angular velocity. The damping parameter can be larger than 1.0f but the damping effect
becomes sensitive to the time step when the damping parameter is large.

angularVelocity As Float

The angular velocity of the body.

awake As Boolean

Is this body initially awake or sleeping?

bullet As Boolean

Is this a fast moving body that should be prevented from tunneling through other moving bodies? Note that all bodies are
prevented from tunneling through kinematic and static bodies. This setting is only considered on dynamic bodies.

fixedRotation As Boolean

Should this body be prevented from rotating? Useful for characters.

gravityScale As Float

Scale the gravity applied to this body.

linearDamping As Float

Linear damping is use to reduce the linear velocity. The damping parameter can be larger than 1.0f but the damping effect
becomes sensitive to the time step when the damping parameter is large.

linearVelocity As lgMathVector2

The linear velocity of the body's origin in world co-ordinates.

position As lgMathVector2

The world position of the body. Avoid creating bodies at the origin since this can lead to many overlapping shapes.

type As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

The body type: static, kinematic, or dynamic. Note: if a dynamic body would have zero mass, the mass is set to one.

lgBox2DBodyEditorLoader

Loads the collision fixtures defined with the Physics Body Editor
application. You only need to give it a body and the corresponding fixture
name, and it will attach these fixtures to your body.

Events:

None

Members:

AttachFixture (body As lgBox2DBody, name As String, fd As lgBox2DFixtureDef, scale As Float)

getImagePath (name As String) As String

getOrigin (name As String, scale As Float) As lgMathVector2

Initialize (str As String)

InitializeWithFile (Internal As String)

InitializeWithFile2 (File As lgFileHandle)

SortedList As List

Members description:

AttachFixture (body As lgBox2DBody, name As String, fd As lgBox2DFixtureDef, scale As Float)

Creates and applies the fixtures defined in the editor. The name
parameter is used to retrieve the right fixture from the loaded file.

The body reference point (the red cross in the tool) is by default
located at the bottom left corner of the image. This reference point
will be put right over the BodyDef position point. Therefore, you should
place this reference point carefully to let you place your body in your
world easily with its BodyDef.position point. Note that to draw an image
at the position of your body, you will need to know this reference point
(see getOrigin).

Also, saved shapes are normalized. As shown in the tool, the width of
the image is considered to be always 1 meter. Thus, you need to provide
a scale factor so the polygons get resized according to your needs (not
every body is 1 meter large in your game, I guess).
body: The Box2d body you want to attach the fixture to.
name: The name of the fixture you want to load.
fd: The fixture parameters to apply to the created body fixture.
scale: The desired scale of the body. The default width is 1.

getImagePath (name As String) As String

Gets the image path attached to the given name.

getOrigin (name As String, scale As Float) As lgMathVector2

Gets the origin point attached to the given name. Since the point is
normalized in [0,1] coordinates, it needs to be scaled to your body
size. Warning: this method returns the same Vector2 object each time, so
copy it if you need it for later use.

Initialize (str As String)

InitializeWithFile (Internal As String)

InitializeWithFile2 (File As lgFileHandle)

SortedList As List

Gets a sorted list of all names.

lgBox2DChainShape

Events:

None

Members:

ChildCount As Int [read only]

createChain (vertices() As Float)

createLoop (vertices() As lgMathVector2)

dispose

getVertex (index As Int, vertex As lgMathVector2)

isLooped As Boolean

NextVertex As lgMathVector2 [write only]

PrevVertex As lgMathVector2 [write only]

Radius As Float

setNextVertex (nextVertexX As Float, nextVertexY As Float)

setPrevVertex (prevVertexX As Float, prevVertexY As Float)

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

VertexCount As Int [read only]

Members description:

ChildCount As Int [read only]

Create a chain with isolated end vertices.
vertices: an array of floats of alternating x, y coordinates.

createChain (vertices() As Float)

createLoop (vertices() As lgMathVector2)

Create a loop. This automatically adjusts connectivity.
vertices: an array of vertices, these are copied

dispose

Needs to be called when the shape is no longer used, e.g. after a fixture was created based on the shape.

getVertex (index As Int, vertex As lgMathVector2)

Returns the vertex at the given position.
index: the index of the vertex 0 <= index < getVertexCount( )
vertex: vertex

isLooped As Boolean

NextVertex As lgMathVector2 [write only]

Establish connectivity to a vertex that follows the last vertex. Don't call this for loops.

PrevVertex As lgMathVector2 [write only]

Establish connectivity to a vertex that precedes the first vertex. Don't call this for loops.

Radius As Float

Establish connectivity to a vertex that follows the last vertex. Don't call this for loops.

setNextVertex (nextVertexX As Float, nextVertexY As Float)

setPrevVertex (prevVertexX As Float, prevVertexY As Float)

Establish connectivity to a vertex that precedes the first vertex. Don't call this for loops.

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

VertexCount As Int [read only]

lgBox2DCircleShape

A circle shape.

Events:

None

Members:

ChildCount As Int [read only]

dispose

Position As lgMathVector2

Radius As Float

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

Members description:

ChildCount As Int [read only]

Needs to be called when the shape is no longer used, e.g. after a fixture was created based on the shape.

dispose

Position As lgMathVector2

Sets the position of the shape

Radius As Float

Get the child primitive index for fixture A.

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

{@inheritDoc}

lgBox2DContact

The class manages contact between two shapes. A contact exists for each overlapping AABB in the broad-phase (except if
filtered). Therefore a contact object may exist that has no contact points.

Events:

None

Members:

ChildIndexA As Int [read only]

ChildIndexB As Int [read only]

Enabled As Boolean [write only]

FixtureA As lgBox2DFixture [read only]

FixtureB As lgBox2DFixture [read only]

Friction As Float

isEnabled As Boolean

isTouching As Boolean

resetFriction

ResetRestitution

Restitution As Float

TangentSpeed As Float

WorldManifold As lgBox2DWorldManifold [read only]

Members description:

ChildIndexA As Int [read only]

ChildIndexB As Int [read only]

Get the child primitive index for fixture B.

Enabled As Boolean [write only]

Enable/disable this contact. This can be used inside the pre-solve contact listener. The contact is only disabled for the
current time step (or sub-step in continuous collisions).

FixtureA As lgBox2DFixture [read only]

Get the first fixture in this contact.

FixtureB As lgBox2DFixture [read only]

Get the second fixture in this contact.

Friction As Float

Get the friction.

isEnabled As Boolean

Has this contact been disabled?

isTouching As Boolean

resetFriction

Reset the friction mixture to the default value.

ResetRestitution

Reset the restitution to the default value.

Restitution As Float

Get the restitution.

TangentSpeed As Float

Get the tangent speed.

WorldManifold As lgBox2DWorldManifold [read only]

lgBox2DContactImpulse

Contact impulses for reporting. Impulses are used instead of forces because sub-step forces may approach infinity for rigid
body collisions. These match up one-to-one with the contact points in b2Manifold.

Events:

None

Members:

Count As Int [read only]

NormalImpulses() As Float [read only]

TangentImpulses() As Float [read only]

Members description:

Count As Int [read only]

NormalImpulses() As Float [read only]

TangentImpulses() As Float [read only]

lgBox2DDebugRenderer

Events:

None

Members:

Axis As lgMathVector2

dispose

DrawAABBs As Boolean [write only]

DrawBodies As Boolean [write only]

DrawContacts As Boolean [write only]

DrawInactiveBodies As Boolean [write only]

DrawJoints As Boolean [write only]

DrawVelocities As Boolean [write only]

Initialize

Initialize2 (drawBodies As Boolean, drawJoints As Boolean, drawAABBs As Boolean, drawInactiveBodies As Boolean, drawVelocities As Boolean, drawContacts As Boolean)

isDrawAABBs As Boolean

isDrawBodies As Boolean

isDrawContacts As Boolean

isDrawInactiveBodies As Boolean

isDrawJoints As Boolean

isDrawVelocities As Boolean

render (world As com.badlogic.gdx.physics.box2d.World, projMatrix As lgMathMatrix4)

Members description:

Axis As lgMathVector2

dispose

DrawAABBs As Boolean [write only]

DrawBodies As Boolean [write only]

DrawContacts As Boolean [write only]

DrawInactiveBodies As Boolean [write only]

DrawJoints As Boolean [write only]

DrawVelocities As Boolean [write only]

Initialize

Initializes the renderer with the following settings:
drawBodies = true
drawJoints = true
drawAABBs = false
drawInactiveBodies = true
drawVelocities = false
drawContacts = true

Initialize2 (drawBodies As Boolean, drawJoints As Boolean, drawAABBs As Boolean, drawInactiveBodies As Boolean, drawVelocities As Boolean, drawContacts As Boolean)

isDrawAABBs As Boolean

isDrawBodies As Boolean

isDrawContacts As Boolean

isDrawInactiveBodies As Boolean

isDrawJoints As Boolean

isDrawVelocities As Boolean

render (world As com.badlogic.gdx.physics.box2d.World, projMatrix As lgMathMatrix4)

This assumes that the projection matrix has already been set.

lgBox2DDistanceJoint

A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a
massless, rigid rod.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

DampingRatio As Float

Frequency As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

Length As Float

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

DampingRatio As Float

Set/get damping ratio.

Frequency As Float

Set/get frequency in Hz.

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

Length As Float

Set/get the natural length. Manipulating the length can lead to non-physical behavior when the frequency is zero.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DDistanceJointDef

Distance joint definition. This requires defining an anchor point on both bodies and the non-zero length of the distance joint.
The definition uses local anchor points so that the initial configuration can violate the constraint slightly. This helps when
saving and loading a game.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

dampingRatio As Float

frequencyHz As Float

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchorA As lgMathVector2, anchorB As lgMathVector2)

length As Float

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

dampingRatio As Float

The damping ratio. 0 = no damping, 1 = critical damping.

frequencyHz As Float

The mass-spring-damper frequency in Hertz.

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchorA As lgMathVector2, anchorB As lgMathVector2)

Initialize the bodies, anchors, and length using the world anchors.

length As Float

The natural length between the anchor points.

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

The joint type is set automatically for concrete joint types.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

lgBox2DEdgeShape

A line segment (edge) shape. These can be connected in chains or loops to other edge shapes. The connectivity information is
used to ensure correct contact normals.

Events:

None

Members:

ChildCount As Int [read only]

dispose

getVertex1 (vec As lgMathVector2)

getVertex2 (vec As lgMathVector2)

Radius As Float

set (v1 As lgMathVector2, v2 As lgMathVector2)

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

Members description:

ChildCount As Int [read only]

Needs to be called when the shape is no longer used, e.g. after a fixture was created based on the shape.

dispose

getVertex1 (vec As lgMathVector2)

getVertex2 (vec As lgMathVector2)

Radius As Float

Set this as an isolated edge.

set (v1 As lgMathVector2, v2 As lgMathVector2)

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

lgBox2DFilter

This holds contact filtering data.

Events:

None

Members:

categoryBits As Short

groupIndex As Short

maskBits As Short

Members description:

categoryBits As Short

The collision category bits. Normally you would just set one bit.

groupIndex As Short

Collision groups allow a certain group of objects to never collide (negative) or always collide (positive). Zero means no
collision group. Non-zero group filtering always wins against the mask bits.

maskBits As Short

The collision mask bits. This states the categories that this shape would accept for collision.

lgBox2DFixture

Events:

None

Members:

Body As lgBox2DBody [read only]

Density As Float

FilterData As lgBox2DFilter

Friction As Float

isSensor As Boolean

refilter

Restitution As Float

Sensor As Boolean [write only]

Shape As lgBox2DShape [read only]

testPoint (p As lgMathVector2) As Boolean

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

UserData As Object

Members description:

Body As lgBox2DBody [read only]

Get the parent body of this fixture. This is NULL if the fixture is not attached.

Density As Float

Get the density of this fixture.

FilterData As lgBox2DFilter

Set the contact filtering data. This will not update contacts until the next time step when either parent body is active and
awake. This automatically calls Refilter.

Friction As Float

Get the coefficient of friction.

isSensor As Boolean

Is this fixture a sensor (non-solid)?
Return type: @return:the true if the shape is a sensor.

refilter

Call this if you want to establish collision that was previously disabled by b2ContactFilter::ShouldCollide.

Restitution As Float

Get the coefficient of restitution.

Sensor As Boolean [write only]

Set if this fixture is a sensor.

Shape As lgBox2DShape [read only]

Returns the shape of this fixture

testPoint (p As lgMathVector2) As Boolean

Test a point for containment in this fixture.
p: a point in world coordinates.

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

Get the type of the child shape. You can use this to down cast to the concrete shape.

UserData As Object

Sets custom user data.

lgBox2DFixtureDef

A fixture definition is used to create a fixture. This class defines an abstract fixture definition. You can reuse fixture
definitions safely.

Events:

None

Members:

density As Float

filter As lgBox2DFilter

friction As Float

isSensor As Boolean

restitution As Float

shape As lgBox2DShape

Members description:

density As Float

The density, usually in kg/m^2.

filter As lgBox2DFilter

Contact filtering data.

friction As Float

The friction coefficient, usually in the range [0,1].

isSensor As Boolean

A sensor shape collects contact information but never generates a collision response.

restitution As Float

The restitution (elasticity) usually in the range [0,1].

shape As lgBox2DShape

The shape, this must be set. The shape will be cloned, so you can create the shape on the stack.

lgBox2DFrictionJoint

Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

MaxForce As Float

MaxTorque As Float

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

MaxForce As Float

Get the maximum friction force in N.

MaxTorque As Float

Get the maximum friction torque in N*m.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DFrictionJointDef

Friction joint definition.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

maxForce As Float

maxTorque As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2)

Initialize the bodies, anchors, axis, and reference angle using the world anchor and world axis.

localAnchorA As lgMathVector2

The local anchor point relative to bodyA's origin.

localAnchorB As lgMathVector2

The local anchor point relative to bodyB's origin.

maxForce As Float

The maximum friction force in N.

maxTorque As Float

The maximum friction torque in N-m.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DGearJoint

A gear joint is used to connect two joints together. Either joint can be a revolute or prismatic joint. You specify a gear
ratio to bind the motions together: coordinate1 + ratio * coordinate2 = constant The ratio can be negative or positive. If one
joint is a revolute joint and the other joint is a prismatic joint, then the ratio will have units of length or units of
1/length.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

Ratio As Float

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

Ratio As Float

Set/Get the gear ratio.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DGearJointDef

Gear joint definition. This definition requires two existing revolute or prismatic joints (any combination will work). The
provided joints must attach a dynamic body to a static body.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

joint1 As lgBox2DJoint

joint2 As lgBox2DJoint

ratio As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

joint1 As lgBox2DJoint

The first revolute/prismatic joint attached to the gear joint.

joint2 As lgBox2DJoint

The second revolute/prismatic joint attached to the gear joint.

ratio As Float

The gear ratio.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DJoint

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DJointDef

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DJointEdge

A joint edge is used to connect bodies and joints together in a joint graph where each body is a node and each joint is an
edge. A joint edge belongs to a doubly linked list maintained in each attached body. Each joint has two joint nodes, one for
each attached body.

Events:

None

Members:

joint As lgBox2DJoint

other As lgBox2DBody

Members description:

joint As lgBox2DJoint

other As lgBox2DBody

lgBox2DManifold

Events:

None

Members:

LocalNormal As lgMathVector2 [read only]

LocalPoint As lgMathVector2 [read only]

MANIFOLDTYPE_Circle As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType

MANIFOLDTYPE_FaceA As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType

MANIFOLDTYPE_FaceB As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType

PointCount As Int [read only]

Points() As lgBox2DManifoldPoint [read only]

Type As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType [read only]

Members description:

LocalNormal As lgMathVector2 [read only]

LocalPoint As lgMathVector2 [read only]

MANIFOLDTYPE_Circle As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType

MANIFOLDTYPE_FaceA As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType

MANIFOLDTYPE_FaceB As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType

PointCount As Int [read only]

Points() As lgBox2DManifoldPoint [read only]

Type As com.badlogic.gdx.physics.box2d.Manifold.ManifoldType [read only]

lgBox2DManifoldPoint

Events:

None

Members:

contactID As Int

localPoint As lgMathVector2

normalImpulse As Float

tangentImpulse As Float

toString As String

Members description:

contactID As Int

localPoint As lgMathVector2

normalImpulse As Float

tangentImpulse As Float

toString As String

lgBox2DMassData

This holds the mass data computed for a shape.

Events:

None

Members:

center As lgMathVector2

I As Float

mass As Float

Members description:

center As lgMathVector2

The position of the shape's centroid relative to the shape's origin.

I As Float

The rotational inertia of the shape about the local origin.

mass As Float

The mass of the shape, usually in kilograms.

lgBox2DMouseJoint

A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force.
This allows the constraint to stretch and without applying huge forces. NOTE: this joint is not documented in the manual
because it was developed to be used in the testbed. If you want to learn how to use the mouse joint, look at the testbed.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

DampingRatio As Float

Frequency As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

MaxForce As Float

Target As lgMathVector2

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

Set/get the damping ratio (dimensionless).

DampingRatio As Float

Frequency As Float

Set/get the frequency in Hertz.

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

MaxForce As Float

Set/get the maximum force in Newtons.

Target As lgMathVector2

Use this to update the target point.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DMouseJointDef

Mouse joint definition. This requires a world target point, tuning parameters, and the time step.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

dampingRatio As Float

frequencyHz As Float

maxForce As Float

target As lgMathVector2

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

dampingRatio As Float

The damping ratio. 0 = no damping, 1 = critical damping.

frequencyHz As Float

The response speed.

maxForce As Float

The maximum constraint force that can be exerted to move the candidate body. Usually you will express as some multiple of
the weight (multiplier * mass * gravity).

target As lgMathVector2

The initial world target point. This is assumed to coincide with the body anchor initially.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DParticleEmitter

Events:

None

Members:

ActiveCount As Int [read only]

Additive As Boolean

AddParticle

AddParticles (Count As Int)

Aligned As Boolean

AllowCompletion

Angle As lgParticleScaledNumericValue [read only]

Attached As Boolean

Behind As Boolean

BoundingBox As lgMathBoundingBox [read only]

Continuous As Boolean

Delay As lgParticleRangedNumericValue [read only]

Draw (SpriteBatch As lgSpriteBatch)

Draw2 (SpriteBatch As lgSpriteBatch, Delta As Float)

Duration As lgParticleRangedNumericValue [read only]

DurationTimer As Float

Emission As lgParticleScaledNumericValue [read only]

FlipY

Gravity As lgParticleScaledNumericValue [read only]

ImagePath As String

Initialize (World As lgBox2DWorld)

Initialize2 (World As lgBox2DWorld, File As lgFileHandle)

Initialize3 (World As lgBox2DWorld, Emitter As lgParticleEmitter)

InternalObject As com.badlogic.gdx.graphics.g2d.ParticleEmitterBox2D [read only]

IsComplete As Boolean

Life As lgParticleScaledNumericValue [read only]

LifeOffset As lgParticleScaledNumericValue [read only]

Load (Internal As String)

Load2 (File As lgFileHandle)

MaxParticleCount As Int

MinParticleCount As Int

Name As String

PercentComplete As Float [read only]

Reset

Rotation As lgParticleScaledNumericValue [read only]

Save (File As lgFileHandle)

Scale As lgParticleScaledNumericValue [read only]

SetFlip (FlipX As Boolean, FlipY As Boolean)

SetPosition (X As Float, Y As Float)

SpawnHeight As lgParticleScaledNumericValue [read only]

SpawnShape As lgParticleSpawnShapeValue [read only]

SpawnWidth As lgParticleScaledNumericValue [read only]

Sprite As lgSprite

Start

Tint As lgParticleGradientColorValue [read only]

Transparency As lgParticleScaledNumericValue [read only]

Update (Delta As Float)

Velocity As lgParticleScaledNumericValue [read only]

Wind As lgParticleScaledNumericValue [read only]

X As Float [read only]

XOffsetValue As lgParticleRangedNumericValue [read only]

Y As Float [read only]

YOffsetValue As lgParticleRangedNumericValue [read only]

Members description:

ActiveCount As Int [read only]

Additive As Boolean

AddParticle

AddParticles (Count As Int)

Aligned As Boolean

AllowCompletion

Ignores the continuous setting until the emitter is started again. This allows the emitter to stop smoothly.

Angle As lgParticleScaledNumericValue [read only]

Attached As Boolean

Behind As Boolean

BoundingBox As lgMathBoundingBox [read only]

Returns the bounding box for all active particles. Z axis will always be zero.

Continuous As Boolean

Delay As lgParticleRangedNumericValue [read only]

Draw (SpriteBatch As lgSpriteBatch)

Draw2 (SpriteBatch As lgSpriteBatch, Delta As Float)

Updates and draws the particles. This is slightly more efficient than calling Update and Draw separately.

Duration As lgParticleRangedNumericValue [read only]

DurationTimer As Float

Emission As lgParticleScaledNumericValue [read only]

FlipY

Gravity As lgParticleScaledNumericValue [read only]

ImagePath As String

Initialize (World As lgBox2DWorld)

Constructs a default ParticleEmitter for Box2D. Box2d World is used for raycasting. Assumes that particles use same unit system that Box2d world does.

Initialize2 (World As lgBox2DWorld, File As lgFileHandle)

Constructs a ParticleEmitter for Box2D using the given file. Box2d World is used for raycasting. Assumes that particles use same unit system that Box2d world does.

Initialize3 (World As lgBox2DWorld, Emitter As lgParticleEmitter)

Constructs a ParticleEmitter for Box2D fully copying the given emitter attributes. Box2d World is used for raycasting. Assumes that particles use same unit system that Box2d world does.

InternalObject As com.badlogic.gdx.graphics.g2d.ParticleEmitterBox2D [read only]

IsComplete As Boolean

Life As lgParticleScaledNumericValue [read only]

LifeOffset As lgParticleScaledNumericValue [read only]

Load (Internal As String)

Load2 (File As lgFileHandle)

MaxParticleCount As Int

MinParticleCount As Int

Name As String

PercentComplete As Float [read only]

Reset

Rotation As lgParticleScaledNumericValue [read only]

Save (File As lgFileHandle)

Scale As lgParticleScaledNumericValue [read only]

SetFlip (FlipX As Boolean, FlipY As Boolean)

SetPosition (X As Float, Y As Float)

SpawnHeight As lgParticleScaledNumericValue [read only]

SpawnShape As lgParticleSpawnShapeValue [read only]

SpawnWidth As lgParticleScaledNumericValue [read only]

Sprite As lgSprite

Start

Tint As lgParticleGradientColorValue [read only]

Transparency As lgParticleScaledNumericValue [read only]

Update (Delta As Float)

Velocity As lgParticleScaledNumericValue [read only]

Wind As lgParticleScaledNumericValue [read only]

X As Float [read only]

XOffsetValue As lgParticleRangedNumericValue [read only]

Y As Float [read only]

YOffsetValue As lgParticleRangedNumericValue [read only]

lgBox2DPolygonShape

Events:

None

Members:

ChildCount As Int [read only]

dispose

getVertex (index As Int, vertex As lgMathVector2)

Radius As Float

Set (vertices() As lgMathVector2)

Set2 (vertices() As Float)

Set3 (vertices() As Float, offset As Int, len As Int)

SetAsBox (hx As Float, hy As Float)

SetAsBox2 (hx As Float, hy As Float, center As lgMathVector2, angle As Float)

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

VertexCount As Int [read only]

Members description:

ChildCount As Int [read only]

Needs to be called when the shape is no longer used, e.g. after a fixture was created based on the shape.

dispose

getVertex (index As Int, vertex As lgMathVector2)

Returns the vertex at the given position.
index: the index of the vertex 0 <= index < getVertexCount( )
vertex: vertex

Radius As Float

Copy vertices. This assumes the vertices define a convex polygon. It is assumed that the exterior is the the right of each
edge.

Set (vertices() As lgMathVector2)

Set2 (vertices() As Float)

Copy vertices from the given float array. It is assumed the vertices are in x,y order and define a convex polygon. It is
assumed that the exterior is the the right of each edge.

Set3 (vertices() As Float, offset As Int, len As Int)

Copy vertices from the given float array, taking into account the offset and length. It is assumed the vertices are in
x,y order and define a convex polygon. It is assumed that the exterior is the the right of each edge.

SetAsBox (hx As Float, hy As Float)

Build vertices to represent an axis-aligned box.
hx: the half-width.
hy: the half-height.

SetAsBox2 (hx As Float, hy As Float, center As lgMathVector2, angle As Float)

Build vertices to represent an oriented box.
hx: the half-width.
hy: the half-height.
center: the center of the box in local coordinates.
angle: the rotation in radians of the box in local coordinates.

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

{@inheritDoc}

VertexCount As Int [read only]

lgBox2DPrismaticJoint

A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in body1. Relative rotation is
prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint
friction.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

enableLimit (flag As Boolean)

enableMotor (flag As Boolean)

getMotorForce (invDt As Float) As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

isLimitEnabled As Boolean

isMotorEnabled As Boolean

JointSpeed As Float [read only]

JointTranslation As Float [read only]

LowerLimit As Float [read only]

MaxMotorForce As Float [write only]

MotorSpeed As Float

setLimits (lower As Float, upper As Float)

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UpperLimit As Float [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

Enable/disable the joint limit.

enableLimit (flag As Boolean)

enableMotor (flag As Boolean)

Get the current motor force given the inverse time step, usually in N.

getMotorForce (invDt As Float) As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

isLimitEnabled As Boolean

Is the joint limit enabled?

isMotorEnabled As Boolean

Is the joint motor enabled?

JointSpeed As Float [read only]

Get the current joint translation speed, usually in meters per second.

JointTranslation As Float [read only]

Get the current joint translation, usually in meters.

LowerLimit As Float [read only]

Get the lower joint limit, usually in meters.

MaxMotorForce As Float [write only]

Set the maximum motor force, usually in N.

MotorSpeed As Float

Get the motor speed, usually in meters per second.

setLimits (lower As Float, upper As Float)

Set the joint limits, usually in meters.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

Get the upper joint limit, usually in meters.

UpperLimit As Float [read only]

UserData As Object

lgBox2DPrismaticJointDef

Prismatic joint definition. This requires defining a line of motion using an axis and an anchor point. The definition uses
local anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint
translation is zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when
saving and loading a game.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

enableLimit As Boolean

enableMotor As Boolean

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2, axis As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

localAxisA As lgMathVector2

lowerTranslation As Float

maxMotorForce As Float

motorSpeed As Float

referenceAngle As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

upperTranslation As Float

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

enableLimit As Boolean

Enable/disable the joint limit.

enableMotor As Boolean

Initialize the bodies, anchors, axis, and reference angle using the world anchor and world axis.

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2, axis As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

The local translation axis in body1.

localAxisA As lgMathVector2

lowerTranslation As Float

The lower translation limit, usually in meters.

maxMotorForce As Float

The maximum motor torque, usually in N-m.

motorSpeed As Float

The desired motor speed in radians per second.

referenceAngle As Float

The constrained angle between the bodies: body2_angle - body1_angle.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

upperTranslation As Float

The upper translation limit, usually in meters.

lgBox2DPulleyJoint

The pulley joint is connected to two bodies and two fixed ground points. The pulley supports a ratio such that: length1 + ratio
* length2 <= constant Yes, the force transmitted is scaled by the ratio. The pulley also enforces a maximum length limit on
both sides. This is useful to prevent one side of the pulley hitting the top.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

GroundAnchorA As lgMathVector2 [read only]

GroundAnchorB As lgMathVector2 [read only]

isActive As Boolean

Length1 As Float [read only]

Length2 As Float [read only]

Ratio As Float [read only]

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

GroundAnchorA As lgMathVector2 [read only]

GroundAnchorB As lgMathVector2 [read only]

isActive As Boolean

Length1 As Float [read only]

Get the current length of the segment attached to body1.

Length2 As Float [read only]

Get the current length of the segment attached to body2.

Ratio As Float [read only]

Get the pulley ratio.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DPulleyJointDef

Pulley joint definition. This requires two ground anchors, two dynamic body anchor points, max lengths for each side, and a
pulley ratio.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

groundAnchorA As lgMathVector2

groundAnchorB As lgMathVector2

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, groundAnchorA As lgMathVector2, groundAnchorB As lgMathVector2, anchorA As lgMathVector2, anchorB As lgMathVector2, ratio As Float)

lengthA As Float

lengthB As Float

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

ratio As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

groundAnchorA As lgMathVector2

The first ground anchor in world coordinates. This point never moves.

groundAnchorB As lgMathVector2

The second ground anchor in world coordinates. This point never moves.

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, groundAnchorA As lgMathVector2, groundAnchorB As lgMathVector2, anchorA As lgMathVector2, anchorB As lgMathVector2, ratio As Float)

Initialize the bodies, anchors, lengths, max lengths, and ratio using the world anchors.

lengthA As Float

The a reference length for the segment attached to bodyA.

lengthB As Float

The a reference length for the segment attached to bodyB.

localAnchorA As lgMathVector2

The local anchor point relative to bodyA's origin.

localAnchorB As lgMathVector2

The local anchor point relative to bodyB's origin.

ratio As Float

The pulley ratio, used to simulate a block-and-tackle.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DQueryCallback

Events:

ReportFixture(Fixture As lgBox2DFixture) As Boolean

Members:

Initialize (CallbackSub As String)

Members description:

Initialize (CallbackSub As String)

Registers a query callback function. This callback function will be called for each fixture found by lgBox2DWorld.QueryAABB.
The function may terminate the query by returning false.

lgBox2DRayCastCallback

Events:

ReportFixture(Fixture As lgBox2DFixture, Point As lgMathVector2, Normal As lgMathVector2, Fraction As Float) As Float

Members:

Initialize (CallbackSub As String)

Members description:

Initialize (CallbackSub As String)

Registers a ray cast callback function. This callback function will be called by lgBox2DWorld.RayCast.
The function controls how the ray cast proceeds by returning a float:
-1: ignore this fixture and continue;
0: terminate the ray cast;
fraction: clip the ray to this point;
1: don't clip the ray and continue.
Parameters passed to the callback function:
Fixture: The fixture hit by the ray;
Point: The point of initial intersection;
Normal: The normal vector at the point of intersection.
The lgMathVector2 instances passed to the callback will be reused for future calls so make a copy of them!

lgBox2DRevoluteJoint

A revolute joint constrains two bodies to share a common point while they are free to rotate about the point. The relative
rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a
lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is
provided so that infinite forces are not generated.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

enableLimit (flag As Boolean)

enableMotor (flag As Boolean)

getMotorTorque (invDt As Float) As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

isLimitEnabled As Boolean

isMotorEnabled As Boolean

JointAngle As Float [read only]

JointSpeed As Float [read only]

LocalAnchorA As lgMathVector2 [read only]

LocalAnchorB As lgMathVector2 [read only]

LowerLimit As Float [read only]

MaxMotorTorque As Float

MotorSpeed As Float

ReferenceAngle As Float [read only]

setLimits (lower As Float, upper As Float)

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UpperLimit As Float [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

Enable/disable the joint limit.

enableLimit (flag As Boolean)

enableMotor (flag As Boolean)

Get the current motor torque, usually in N-m.

getMotorTorque (invDt As Float) As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

isLimitEnabled As Boolean

Is the joint limit enabled?

isMotorEnabled As Boolean

Is the joint motor enabled?

JointAngle As Float [read only]

Get the current joint angle in radians.

JointSpeed As Float [read only]

Get the current joint angle speed in radians per second.

LocalAnchorA As lgMathVector2 [read only]

LocalAnchorB As lgMathVector2 [read only]

LowerLimit As Float [read only]

Get the lower joint limit in radians.

MaxMotorTorque As Float

Set the maximum motor torque, usually in N-m.

MotorSpeed As Float

Get the motor speed in radians per second.

ReferenceAngle As Float [read only]

Get the current motor torque, usually in N-m.

setLimits (lower As Float, upper As Float)

Set the joint limits in radians.
upper:

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

Get the upper joint limit in radians.

UpperLimit As Float [read only]

UserData As Object

lgBox2DRevoluteJointDef

Revolute joint definition. This requires defining an anchor point where the bodies are joined. The definition uses local anchor
points so that the initial configuration can violate the constraint slightly. You also need to specify the initial relative
angle for joint limits. This helps when saving and loading a game. The local anchor points are measured from the body's origin
rather than the center of mass because: 1. you might not know where the center of mass will be. 2. if you add/remove shapes
from a body and recompute the mass, the joints will be broken.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

enableLimit As Boolean

enableMotor As Boolean

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

lowerAngle As Float

maxMotorTorque As Float

motorSpeed As Float

referenceAngle As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

upperAngle As Float

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

enableLimit As Boolean

A flag to enable joint limits.

enableMotor As Boolean

A flag to enable the joint motor.

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2)

Initialize the bodies, anchors, and reference angle using a world anchor point.

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

The lower angle for the joint limit (radians).

lowerAngle As Float

maxMotorTorque As Float

The maximum motor torque used to achieve the desired motor speed. Usually in N-m.

motorSpeed As Float

The desired motor speed. Usually in radians per second.

referenceAngle As Float

The body2 angle minus body1 angle in the reference state (radians).

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

upperAngle As Float

The upper angle for the joint limit (radians).

lgBox2DRopeJoint

A rope joint enforces a maximum distance between two points on two bodies. It has no other effect. Warning: if you attempt to
change the maximum length during the simulation you will get some non-physical behavior. A model that would allow you to
dynamically modify the length would have some sponginess, so I chose not to implement it that way. See b2DistanceJoint if you
want to dynamically control length.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

MaxLength As Float

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

MaxLength As Float

Get the maximum length of the rope.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DRopeJointDef

Rope joint definition. This requires two body anchor points and a maximum lengths. Note: by default the connected objects will
not collide. see collideConnected in b2JointDef.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

maxLength As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

localAnchorA As lgMathVector2

The local anchor point relative to bodyA's origin.

localAnchorB As lgMathVector2

The local anchor point relative to bodyB's origin.

maxLength As Float

The maximum length of the rope. Warning: this must be larger than b2_linearSlop or the joint will have no effect.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DShape

A shape is used for collision detection. You can create a shape however you like. Shapes used for simulation in b2World are
created automatically when a b2Fixture is created. Shapes may encapsulate a one or more child shapes.

NOTE: YOU NEED TO DISPOSE SHAPES YOU CREATED YOURSELF AFTER YOU NO LONGER USE THEM! E.g. after calling body.createFixture();

Events:

None

Members:

ChildCount As Int [read only]

dispose

Radius As Float

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

Members description:

ChildCount As Int [read only]

Needs to be called when the shape is no longer used, e.g. after a fixture was created based on the shape.

dispose

Radius As Float

Get the type of this shape. You can use this to down cast to the concrete shape.

Type As com.badlogic.gdx.physics.box2d.Shape.Type [read only]

lgBox2DTransform

Encodes a Box2D transform. We are lazy so we only store a 4 float wide array. First two floats are the position of the
b2Transform struct. Next two floats are the cosine and sine of the rotation angle.

Events:

None

Members:

COS As Int

mul (v As lgMathVector2) As lgMathVector2

POS_X As Int

POS_Y As Int

Position As lgMathVector2

Rotation As Float

SIN As Int

vals() As Float

Members description:

COS As Int

mul (v As lgMathVector2) As lgMathVector2

Transforms the given vector by this transform
v: the vector

POS_X As Int

POS_Y As Int

Position As lgMathVector2

Sets the position of this transform

Rotation As Float

Sets the rotation of this transform

SIN As Int

vals() As Float

lgBox2DWeldJoint

A weld joint essentially glues two bodies together. A weld joint may distort somewhat because the island constraint solver is
approximate.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

ReferenceAngle As Float [read only]

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

ReferenceAngle As Float [read only]

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DWeldJointDef

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

initialize (body1 As lgBox2DBody, body2 As lgBox2DBody, anchor As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

referenceAngle As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

initialize (body1 As lgBox2DBody, body2 As lgBox2DBody, anchor As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

referenceAngle As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DWheelJoint

A wheel joint. This joint provides two degrees of freedom: translation along an axis fixed in body1 and rotation in the plane.
You can use a joint limit to restrict the range of motion and a joint motor to drive the rotation or to model rotational
friction. This joint is designed for vehicle suspensions.

Events:

None

Members:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

enableMotor (flag As Boolean)

getMotorTorque (invDt As Float) As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

isActive As Boolean

JointSpeed As Float [read only]

JointTranslation As Float [read only]

MaxMotorTorque As Float

MotorSpeed As Float

SpringDampingRatio As Float

SpringFrequencyHz As Float

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

Members description:

AnchorA As lgMathVector2 [read only]

AnchorB As lgMathVector2 [read only]

BodyA As lgBox2DBody [read only]

BodyB As lgBox2DBody [read only]

enableMotor (flag As Boolean)

Get the current motor torque given the inverse time step, usually in N-m.

getMotorTorque (invDt As Float) As Float

getReactionForce (inv_dt As Float) As lgMathVector2

getReactionTorque (inv_dt As Float) As Float

Short-cut function to determine if either body is inactive.

isActive As Boolean

JointSpeed As Float [read only]

Get the current joint translation speed, usually in meters per second.

JointTranslation As Float [read only]

Get the current joint translation, usually in meters.

MaxMotorTorque As Float

Set/Get the maximum motor force, usually in N-m.

MotorSpeed As Float

Get the motor speed, usually in radians per second.

SpringDampingRatio As Float

Set/Get the spring damping ratio

SpringFrequencyHz As Float

Set/Get the spring frequency in hertz. Setting the frequency to zero disables the spring.

Type As com.badlogic.gdx.physics.box2d.JointDef.JointType [read only]

UserData As Object

lgBox2DWheelJointDef

Wheel joint definition. This requires defining a line of motion using an axis and an anchor point. The definition uses local
anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint translation is
zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when saving and loading a
game.

Events:

None

Members:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

collideConnected As Boolean

dampingRatio As Float

enableMotor As Boolean

frequencyHz As Float

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2, axis As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

localAxisA As lgMathVector2

maxMotorTorque As Float

motorSpeed As Float

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

Members description:

bodyA As lgBox2DBody

bodyB As lgBox2DBody

Set this flag to true if the attached bodies should collide.

collideConnected As Boolean

dampingRatio As Float

Suspension damping ratio, one indicates critical damping

enableMotor As Boolean

Suspension frequency, zero indicates no suspension

frequencyHz As Float

initialize (bodyA As lgBox2DBody, bodyB As lgBox2DBody, anchor As lgMathVector2, axis As lgMathVector2)

localAnchorA As lgMathVector2

localAnchorB As lgMathVector2

The local translation axis in body1.

localAxisA As lgMathVector2

maxMotorTorque As Float

The maximum motor torque, usually in N-m.

motorSpeed As Float

The desired motor speed in radians per second.

type As com.badlogic.gdx.physics.box2d.JointDef.JointType

The joint type is set automatically for concrete joint types.

lgBox2DWorld

Events:

BeginContact(Contact As lgBox2DContact)
EndContact(Contact As lgBox2DContact)
PreSolve(Contact As lgBox2DContact, OldManifold As lgBox2DManifold)
PostSolve(Contact As lgBox2DContact, Impulse As lgBox2DContactImpulse)
ShouldCollide(FixtureA As lgBox2DFixture, FixtureB As lgBox2DFixture) As Boolean

Members:

AutoClearForces As Boolean

BodyCount As Int [read only]

BODYTYPE_Dynamic As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

BODYTYPE_Kinematic As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

BODYTYPE_Static As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

ClearForces

ContactCount As Int [read only]

CreateBody (Def As lgBox2DBodyDef) As lgBox2DBody

CreateJoint (Def As lgBox2DJointDef) As lgBox2DJoint

DestroyBody (Body As lgBox2DBody)

DestroyJoint (Joint As lgBox2DJoint)

dispose

GetAllBodies (Bodies As lgArray)

GetAllContacts As lgArray

GetAllJoints (Joints As lgArray)

Gravity As lgMathVector2

Initialize (Gravity As lgMathVector2, DoSleep As Boolean, EvtPrefix As String)

InternalObject As com.badlogic.gdx.physics.box2d.World [read only]

IsLocked As Boolean

JointCount As Int [read only]

JOINTTYPE_DistanceJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_FrictionJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_GearJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_MouseJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_PrismaticJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_PulleyJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_RevoluteJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_RopeJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_Unknown As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_WeldJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_WheelJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

ProxyCount As Int [read only]

QueryAABB (Callback As lgBox2DQueryCallback, lowerX As Float, lowerY As Float, upperX As Float, upperY As Float)

RayCast (Callback As lgBox2DRayCastCallback, Point1 As lgMathVector2, Point2 As lgMathVector2)

SetContactFilter

SetContinuousPhysics (Enable As Boolean)

SetWarmStarting (Enable As Boolean)

SHAPETYPE_Chain As com.badlogic.gdx.physics.box2d.Shape.Type

SHAPETYPE_Circle As com.badlogic.gdx.physics.box2d.Shape.Type

SHAPETYPE_Edge As com.badlogic.gdx.physics.box2d.Shape.Type

SHAPETYPE_Polygon As com.badlogic.gdx.physics.box2d.Shape.Type

Step (TimeStep As Float, VelocityIterations As Int, PositionIterations As Int)

VelocityThreshold As Float

Members description:

AutoClearForces As Boolean

Gets or sets the flag that controls automatic clearing of forces after each time step.

BodyCount As Int [read only]

Gets the number of bodies.

BODYTYPE_Dynamic As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

BODYTYPE_Kinematic As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

BODYTYPE_Static As com.badlogic.gdx.physics.box2d.BodyDef.BodyType

ClearForces

Manually clear the force buffer on all bodies. By default, forces are cleared automatically after each call to Step. The default behavior is modified by AutoClearForces. The purpose of this function is to support sub-stepping. Sub-stepping is often used to maintain a fixed sized time step under a variable frame-rate. When you perform sub-stepping you will disable auto clearing of forces and instead call ClearForces after all sub-steps are complete in one pass of your game loop.

ContactCount As Int [read only]

Gets the number of contacts (each may have 0 or more contact points).

CreateBody (Def As lgBox2DBodyDef) As lgBox2DBody

Creates a rigid body given a definition. No reference to the definition is retained.

CreateJoint (Def As lgBox2DJointDef) As lgBox2DJoint

Creates a joint to constrain bodies together. No reference to the definition is retained.

DestroyBody (Body As lgBox2DBody)

Destroys the specified rigid body and all associated fixtures and joints. This function is locked during callbacks.

DestroyJoint (Joint As lgBox2DJoint)

Destroys the specified joint. This may cause the connected bodies to begin colliding.

dispose

Releases all resources of this object.

GetAllBodies (Bodies As lgArray)

Fills the given array with all bodies currently in the simulation.

GetAllContacts As lgArray

Returns an array of Contact instances produced by the last call to Step. Contacts are created and destroyed in the middle of a time step. Use the Contact events to avoid missing contacts.

GetAllJoints (Joints As lgArray)

Fills the given array with all joints currently in the simulation.

Gravity As lgMathVector2

Gets or sets the global gravity vector.

Initialize (Gravity As lgMathVector2, DoSleep As Boolean, EvtPrefix As String)

Constructs a world object and registers the contact listeners.
The Contact instance passed to the contact events will be reused for future calls so make a copy of its data!
Gravity: The world gravity vector.
DoSleep: Improve performance by not simulating inactive bodies.
EvtPrefix: Prefix of the contact events.

InternalObject As com.badlogic.gdx.physics.box2d.World [read only]

IsLocked As Boolean

Is the world locked (in the middle of a time step)?

JointCount As Int [read only]

Gets the number of joints.

JOINTTYPE_DistanceJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_FrictionJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_GearJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_MouseJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_PrismaticJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_PulleyJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_RevoluteJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_RopeJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_Unknown As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_WeldJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

JOINTTYPE_WheelJoint As com.badlogic.gdx.physics.box2d.JointDef.JointType

ProxyCount As Int [read only]

Gets the number of broad-phase proxies.

QueryAABB (Callback As lgBox2DQueryCallback, lowerX As Float, lowerY As Float, upperX As Float, upperY As Float)

Queries the world for all fixtures that potentially overlap the provided AABB.
Callback: An instance of lgBox2DQueryCallback.
lowerX: The X coordinate of the lower left corner
lowerY: The Y coordinate of the lower left corner
upperX: The X coordinate of the upper right corner
upperY: The Y coordinate of the upper right corner

RayCast (Callback As lgBox2DRayCastCallback, Point1 As lgMathVector2, Point2 As lgMathVector2)

Ray-casts the world for all fixtures in the path of the ray. The ray-cast ignores shapes that contain the starting point.
Callback: An instance of lgBox2DRayCastCallback.
Point1: The ray starting point.
Point2: The ray ending point.

SetContactFilter

Raises the ShouldCollide event for each contact to provide collision filtering. Otherwise the default filter is used.

SetContinuousPhysics (Enable As Boolean)

Enables/disables continuous physics.

SetWarmStarting (Enable As Boolean)

Enables/disables warm starting.

SHAPETYPE_Chain As com.badlogic.gdx.physics.box2d.Shape.Type

SHAPETYPE_Circle As com.badlogic.gdx.physics.box2d.Shape.Type

SHAPETYPE_Edge As com.badlogic.gdx.physics.box2d.Shape.Type

SHAPETYPE_Polygon As com.badlogic.gdx.physics.box2d.Shape.Type

Step (TimeStep As Float, VelocityIterations As Int, PositionIterations As Int)

Takes a time step. This performs collision detection, integration, and constraint solution.
TimeStep: The amount of time to simulate, this should not vary.
VelocityIterations: For the velocity constraint solver.
PositionIterations: For the position constraint solver.

VelocityThreshold As Float

Gets or sets the global box2d velocity threshold (default 1.0).

lgBox2DWorldManifold

This is used to compute the current state of a contact manifold.

Events:

None

Members:

Normal As lgMathVector2 [read only]

NumberOfContactPoints As Int [read only]

Points() As lgMathVector2 [read only]

Members description:

Normal As lgMathVector2 [read only]

Returns the normal of this manifold

NumberOfContactPoints As Int [read only]

Points() As lgMathVector2 [read only]

Returns the contact points of this manifold. Use getNumberOfContactPoints to determine how many contact points there are
(0,1 or 2)

lgClipboard

Events:

None

Members:

Contents As String

Members description:

Contents As String

lgColor

A color class, holding the r, g, b and alpha component as floats in the range [0,1]. All methods perform clamping on the
internal values after execution.

Events:

None

Members:

an style="color: #000000; ">a As Float

add (color As lgColor) As lgColor

addRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

alpha (alpha As Float) As Int

b As Float

BLACK As lgColor

BLUE As lgColor

clamp As lgColor

CLEAR As lgColor

cpy As lgColor

CYAN As lgColor

DARK_GRAY As lgColor

equals (o As Object) As Boolean

g As Float

GRAY As lgColor

GREEN As lgColor

hashCode As Int

lerp (target As lgColor, t As Float) As lgColor

LIGHT_GRAY As lgColor

luminanceAlpha (luminance As Float, alpha As Float) As Int

MAGENTA As lgColor

mul (color As lgColor) As lgColor

mulRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

ORANGE As lgColor

PINK As lgColor

premultiplyAlpha As lgColor

r As Float

RED As lgColor

rgb565 (r As Float, g As Float, b As Float) As Int

rgb565ToColor (color As lgColor, value As Int)

rgb888 (r As Float, g As Float, b As Float) As Int

rgb888ToColor (color As lgColor, value As Int)

rgba4444 (r As Float, g As Float, b As Float, a As Float) As Int

rgba4444ToColor (color As lgColor, value As Int)

rgba8888 (r As Float, g As Float, b As Float, a As Float) As Int

rgba8888ToColor (color As lgColor, value As Int)

set (color As lgColor) As lgColor

setRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

sub (color As lgColor) As lgColor

subRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

toFloatBits As Float

toIntBits As Int

toString As String

valueOf (hex As String) As lgColor

WHITE As lgColor

YELLOW As lgColor

Members description:

a As Float

Adds the given color to this color.
color: the color
Return type: @return:this color

add (color As lgColor) As lgColor

addRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

alpha (alpha As Float) As Int

b As Float

BLACK As lgColor

BLUE As lgColor

clamp As lgColor

Return type: @return:a copy of this color

CLEAR As lgColor

cpy As lgColor

CYAN As lgColor

DARK_GRAY As lgColor

equals (o As Object) As Boolean

g As Float

Linearly interpolates between this color and the target color by t which is in the range [0,1]. The result is stored in this
color.
target: The target color
t: The interpolation coefficient
Return type: @return:This color for chaining.

GRAY As lgColor

GREEN As lgColor

hashCode As Int

lerp (target As lgColor, t As Float) As lgColor

LIGHT_GRAY As lgColor

luminanceAlpha (luminance As Float, alpha As Float) As Int

MAGENTA As lgColor

mul (color As lgColor) As lgColor

Multiplies the this color and the given color
color: the color
Return type: @return:this color.

mulRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

Multiplies the RGB values by the alpha.

ORANGE As lgColor

PINK As lgColor

premultiplyAlpha As lgColor

r As Float

Sets the Color components using the specified integer value in the format RGB565. This is inverse to the rgb565(r, g, b)
method.
color: The Color to be modified.
value: An integer color value in RGB565 format.

RED As lgColor

rgb565 (r As Float, g As Float, b As Float) As Int

rgb565ToColor (color As lgColor, value As Int)

rgb888 (r As Float, g As Float, b As Float) As Int

rgb888ToColor (color As lgColor, value As Int)

Sets the Color components using the specified integer value in the format RGB888. This is inverse to the rgb888(r, g, b)
method.
color: The Color to be modified.
value: An integer color value in RGB888 format.

rgba4444 (r As Float, g As Float, b As Float, a As Float) As Int

rgba4444ToColor (color As lgColor, value As Int)

Sets the Color components using the specified integer value in the format RGBA4444. This is inverse to the rgba4444(r, g, b,
a) method.
color: The Color to be modified.
value: An integer color value in RGBA4444 format.

rgba8888 (r As Float, g As Float, b As Float, a As Float) As Int

rgba8888ToColor (color As lgColor, value As Int)

Sets the Color components using the specified integer value in the format RGBA8888. This is inverse to the rgba8888(r, g, b,
a) method.
color: The Color to be modified.
value: An integer color value in RGBA8888 format.

set (color As lgColor) As lgColor

Sets this color to the given color.
color: the Color

setRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

Subtracts the given color from this color
color: the color
Return type: @return:this color

sub (color As lgColor) As lgColor

subRGBA (r As Float, g As Float, b As Float, a As Float) As lgColor

Packs the color components into a 32-bit integer with the format ABGR and then converts it to a float.
Return type: @return:the packed color as a 32-bit float

toFloatBits As Float

toIntBits As Int

Packs the color components into a 32-bit integer with the format ABGR.
Return type: @return:the packed color as a 32-bit int.

toString As String

Returns the color encoded as hex string with the format RRGGBBAA.

valueOf (hex As String) As lgColor

Returns a new color from a hex string with the format RRGGBBAA.

WHITE As lgColor

YELLOW As lgColor

lgConfiguration

Class defining the configuration of an AndroidApplication. Allows you to disable the use of the accelerometer to save
battery among other things.

Events:

None

Members:

an style="color: #000000; ">a As Int

b As Int

depth As Int

g As Int

hideStatusBar As Boolean

maxSimultaneousSounds As Int

numSamples As Int

r As Int

stencil As Int

touchSleepTime As Int

useAccelerometer As Boolean

useCompass As Boolean

useGL20 As Boolean

useWakelock As Boolean

Members description:

a As Int

b As Int

number of bits for depth and stencil buffer

depth As Int

g As Int

hide status bar buttons on Android 4.x and higher (API 14+). Doesn't work if "android:targetSdkVersion" less 11 or if API
less 14. default: false

hideStatusBar As Boolean

maxSimultaneousSounds As Int

the maximum number of Sound instances that can be played simultaneously, sets the corresponding SoundPool
constructor argument.

numSamples As Int

number of samples for CSAA/MSAA, 2 is a good value

r As Int