On this page

Box2D. Box2dObject

Box2D Object - extend with your own custom physics objects

A LittleJS object with Box2D physics
Each object has a Box2D body which can have multiple fixtures and joints
Provides interface for Box2D body and fixture functions

Constructor

new Box2dObject(posopt, sizeopt, tileInfoopt, angleopt, coloropt, bodyTypeopt, renderOrderopt)

Create a LittleJS object with Box2d physics

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2	<optional>
`size`	Vector2	<optional>
`tileInfo`	TileInfo	<optional>
`angle`	number	<optional>	0
`color`	Color	<optional>
`bodyType`	number	<optional>
`renderOrder`	number	<optional>	0

Source: plugins/box2d.js, line 44

Extends

EngineObject

Methods

addBox(sizeopt, offsetopt, angleopt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a box shape to the body

Parameters:

Name	Type	Attributes	Default	Description
`size`	Vector2	<optional>
`offset`	Vector2	<optional>
`angle`	number	<optional>	0
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 154

addCircle(diameteropt, offsetopt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a circle shape to the body

Parameters:

Name	Type	Attributes	Default	Description
`diameter`	number	<optional>	1
`offset`	Vector2	<optional>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 234

addEdge(point1, point2, densityopt, frictionopt, restitutionopt, isSensoropt)

Add an edge shape to the body

Parameters:

Name	Type	Attributes	Description
`point1`	Vector2
`point2`	Vector2
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 249

addEdgeList(points, densityopt, frictionopt, restitutionopt, isSensoropt)

Add an edge list to the body

Parameters:

Name	Type	Attributes	Description
`points`	Array.<Vector2>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 285

addEdgeLoop(points, densityopt, frictionopt, restitutionopt, isSensoropt)

Add an edge loop to the body, an edge loop connects the end points

Parameters:

Name	Type	Attributes	Description
`points`	Array.<Vector2>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 262

addPoly(points, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a polygon shape to the body

Parameters:

Name	Type	Attributes	Description
`points`	Array.<Vector2>
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 167

addRandomPoly(diameteropt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a random polygon shape to the body

Parameters:

Name	Type	Attributes	Default	Description
`diameter`	number	<optional>	1
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 217

addRegularPoly(diameteropt, sidesopt, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a regular polygon shape to the body

Parameters:

Name	Type	Attributes	Default	Description
`diameter`	number	<optional>	1
`sides`	number	<optional>	8
`density`	number	<optional>
`friction`	number	<optional>
`restitution`	number	<optional>
`isSensor`	boolean	<optional>

Source: plugins/box2d.js, line 202

addShape(shape, densityopt, frictionopt, restitutionopt, isSensoropt)

Add a shape fixture to the body

Parameters:

Name	Type	Attributes	Default	Description
`shape`	Object
`density`	number	<optional>	1
`friction`	number	<optional>	0.2
`restitution`	number	<optional>	0
`isSensor`	boolean	<optional>	false

Source: plugins/box2d.js, line 135

applyAcceleration(acceleration, posopt)

Apply acceleration to this object

Parameters:

Name	Type	Attributes	Description
`acceleration`	Vector2
`pos`	Vector2	<optional>

Source: plugins/box2d.js, line 458

applyAngularAcceleration(acceleration)

Apply angular acceleration to this object

Parameters:

Name	Type	Description
`acceleration`	number

Source: plugins/box2d.js, line 475

applyForce(force, posopt)

Apply force to this object

Parameters:

Name	Type	Attributes	Description
`force`	Vector2
`pos`	Vector2	<optional>

Source: plugins/box2d.js, line 448

applyTorque(torque)

Apply torque to this object

Parameters:

Name	Type	Description
`torque`	number

Source: plugins/box2d.js, line 467

beginContact(otherObject)

Called when a contact begins

Parameters:

Name	Type	Description
`otherObject`	Box2dObject

Source: plugins/box2d.js, line 120

destroy()

Destroy this object and its physics body

Source: plugins/box2d.js, line 69

drawFixtures(coloropt, lineColoropt, lineWidthopt, contextopt)

Draws all this object's fixtures

Parameters:

Name	Type	Attributes	Default	Description
`color`	Color	<optional>
`lineColor`	Color	<optional>
`lineWidth`	number	<optional>	0.1
`context`	CanvasRenderingContext2D	<optional>

Source: plugins/box2d.js, line 109

endContact(otherObject)

Called when a contact ends

Parameters:

Name	Type	Description
`otherObject`	Box2dObject

Source: plugins/box2d.js, line 124

getAngularVelocity() → {Vector2}

Gets the angular velocity

Source: plugins/box2d.js, line 314

Returns:

Type:: Vector2

getBodyType() → {number}

Gets the physics body type

Source: plugins/box2d.js, line 330

Returns:

Type:: number

getCenterOfMass() → {Vector2}

Gets the center of mass

Source: plugins/box2d.js, line 306

Returns:

Type:: Vector2

getFixtureList() → {Array.<Object>}

Get list of fixtures for this object

Source: plugins/box2d.js, line 490

Returns:

Type:: Array.<Object>

getInertia() → {number}

Gets the rotational inertia

Source: plugins/box2d.js, line 322

Returns:

Type:: number

getIsAwake() → {boolean}

Check if this object is awake

Source: plugins/box2d.js, line 326

Returns:

Type:: boolean

getJointList() → {Array.<Object>}

Get list of joints for this object

Source: plugins/box2d.js, line 507

Returns:

Type:: Array.<Object>

getLinearVelocity() → {Vector2}

Gets the linear velocity

Source: plugins/box2d.js, line 310

Returns:

Type:: Vector2

getMass() → {number}

Gets the mass

Source: plugins/box2d.js, line 318

Returns:

Type:: number

hasFixtures() → {boolean}

Check if this object has any fixtures

Source: plugins/box2d.js, line 486

Returns:

Type:: boolean

hasJoints() → {boolean}

Check if this object has any joints

Source: plugins/box2d.js, line 503

Returns:

Type:: boolean

render()

Render the object, uses box2d drawing if no tile info exists

Source: plugins/box2d.js, line 86

renderDebugInfo()

Render debug info

Source: plugins/box2d.js, line 96

resetMassData()

Reset the mass, center of mass, and moment

Source: plugins/box2d.js, line 406

setAngle(angle)

Sets the angle

Parameters:

Name	Type	Description
`angle`	number

Source: plugins/box2d.js, line 351

setAngularDamping(damping)

Sets the angular damping

Parameters:

Name	Type	Description
`damping`	number

Source: plugins/box2d.js, line 367

setAngularVelocity(angularVelocity)

Sets the angular velocity

Parameters:

Name	Type	Description
`angularVelocity`	number

Source: plugins/box2d.js, line 359

setAwake(isAwakeopt)

Set the sleep state of the body

Parameters:

Name	Type	Attributes	Default	Description
`isAwake`	boolean	<optional>	true

Source: plugins/box2d.js, line 379

setBodyType(type)

Set the physics body type

Parameters:

Name	Type	Description
`type`	number

Source: plugins/box2d.js, line 383

setBullet(isBulletopt)

Should this body be treated like a bullet for continuous collision detection?

Parameters:

Name	Type	Attributes	Default	Description
`isBullet`	boolean	<optional>	true

Source: plugins/box2d.js, line 375

setCenterOfMass(center)

Set the center of mass of the body

Parameters:

Name	Type	Description
`center`	Vector2

Source: plugins/box2d.js, line 395

setFilterData(categoryBitsopt, ignoreCategoryBitsopt, groupIndexopt)

Set the collision filter data for this body

Parameters:

Name	Type	Attributes	Default	Description
`categoryBits`	number	<optional>	0
`ignoreCategoryBits`	number	<optional>	0
`groupIndex`	number	<optional>	0

Source: plugins/box2d.js, line 426

setFixedRotation(isFixedopt)

Set whether the body can rotate

Parameters:

Name	Type	Attributes	Default	Description
`isFixed`	boolean	<optional>	true

Source: plugins/box2d.js, line 391

setGravityScale(scaleopt)

Sets the gravity scale

Parameters:

Name	Type	Attributes	Default	Description
`scale`	number	<optional>	1

Source: plugins/box2d.js, line 371

setLinearDamping(damping)

Sets the linear damping

Parameters:

Name	Type	Description
`damping`	number

Source: plugins/box2d.js, line 363

setLinearVelocity(velocity)

Sets the linear velocity

Parameters:

Name	Type	Description
`velocity`	Vector2

Source: plugins/box2d.js, line 355

setMass(mass)

Set the mass of the body

Parameters:

Name	Type	Description
`mass`	number

Source: plugins/box2d.js, line 399

setMassData(localCenteropt, massopt, momentOfInertiaopt)

Set the mass data of the body

Parameters:

Name	Type	Attributes	Description
`localCenter`	Vector2	<optional>
`mass`	number	<optional>
`momentOfInertia`	number	<optional>

Source: plugins/box2d.js, line 412

setMomentOfInertia(momentOfInertia)

Set the moment of inertia of the body

Parameters:

Name	Type	Description
`momentOfInertia`	number

Source: plugins/box2d.js, line 403

setPosition(pos)

Sets the position

Parameters:

Name	Type	Description
`pos`	Vector2

Source: plugins/box2d.js, line 347

setSensor(isSensoropt)

Set if this body is a sensor

Parameters:

Name	Type	Attributes	Default	Description
`isSensor`	boolean	<optional>	true

Source: plugins/box2d.js, line 439

setSleepingAllowed(isAllowedopt)

Set whether the body is allowed to sleep

Parameters:

Name	Type	Attributes	Default	Description
`isAllowed`	boolean	<optional>	true

Source: plugins/box2d.js, line 387

setTransform(pos, angle)

Sets the position and angle

Parameters:

Name	Type	Description
`pos`	Vector2
`angle`	number

Source: plugins/box2d.js, line 338

update()

Copy box2d update sim data

Source: plugins/box2d.js, line 78