Class: Box2dPlugin

Constructor

new Box2dPlugin(instance)

Create the global Box2D plugin object, box2dInit does this

Parameters:

Name	Type	Description
`instance`	Object

Source: plugins/box2d.js, line 1996

Members

bodyTypeDynamic :number

Type:

number

Properties

Type	Description
number	Dynamic, positive mass, non-zero velocity determined by forces, moved by solver

Source: plugins/box2d.js, line 2025

bodyTypeKinematic :number

Type:

number

Properties

Type	Description
number	Kinematic, zero mass, non-zero velocity set by user, moved by solver

Source: plugins/box2d.js, line 2022

bodyTypeStatic :number

Type:

number

Properties

Type	Description
number	Static, zero mass, zero velocity, may be manually moved

Source: plugins/box2d.js, line 2019

instance

Properties

Type	Description
Object	The Box2d instance

Source: plugins/box2d.js, line 2006

objects :Array.<Box2dObject>

Type:

Array.<Box2dObject>

Properties

Type	Description
Array.<Box2dObject>	List of all Box2d objects, a destroyed one stays until the next step with its body undefined

Source: plugins/box2d.js, line 2012

positionIterations

Properties

Type	Description
number	Position iterations per update

Source: plugins/box2d.js, line 2016

velocityIterations

Properties

Type	Description
number	Velocity iterations per update

Source: plugins/box2d.js, line 2014

world

Properties

Type	Description
Object	The Box2d world

Source: plugins/box2d.js, line 2008

Methods

boxCast(pos, size, includeSensorsopt) → {Box2dObject|undefined}

box aabb cast and return the first object

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2
`size`	Vector2
`includeSensors`	boolean	<optional>	false	Also find sensors, trigger zones are passed through by default

Source: plugins/box2d.js, line 2182

Returns:

Type:: Box2dObject | undefined

boxCastAll(pos, size, includeSensorsopt) → {Array.<Box2dObject>}

box aabb cast and return all the objects

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2
`size`	Vector2
`includeSensors`	boolean	<optional>	false	Also find sensors, trigger zones are passed through by default

Source: plugins/box2d.js, line 2152

Returns:

Type:: Array.<Box2dObject>

castJointObject(o)

casts a box2d object to a joint type

Parameters:

Name	Type	Description
`o`	Object

Source: plugins/box2d.js, line 2372

castShapeObject(o)

casts a box2d object to a shape type

Parameters:

Name	Type	Description
`o`	Object

Source: plugins/box2d.js, line 2353

circleCast(pos, diameter, includeSensorsopt) → {Box2dObject|undefined}

circle cast and return the object whose position is nearest, of those within the circle

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2
`diameter`	number
`includeSensors`	boolean	<optional>	false	Also find objects whose shapes are all sensors, like trigger zones

Source: plugins/box2d.js, line 2229

Returns:

Type:: Box2dObject | undefined

circleCastAll(pos, diameter, includeSensorsopt) → {Array.<Box2dObject>}

circle cast and return all the objects whose position is within the circle, wherever their shapes are

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2
`diameter`	number
`includeSensors`	boolean	<optional>	false	Also find objects whose shapes are all sensors, like trigger zones

Source: plugins/box2d.js, line 2214

Returns:

Type:: Array.<Box2dObject>

drawFixture(fixture, pos, angle, coloropt, lineColoropt, lineWidthopt, useWebGLopt, contextopt)

draws a fixture

Parameters:

Name	Type	Attributes	Default
`fixture`	Object
`pos`	Vector2
`angle`	number
`color`	Color	<optional>
`lineColor`	Color	<optional>
`lineWidth`	number	<optional>	0.1
`useWebGL`	boolean	<optional>	glEnable
`context`	CanvasRenderingContext2D	<optional>

Source: plugins/box2d.js, line 2290

isNull(o)

checks if a box2d object is null

Parameters:

Name	Type	Description
`o`	Object

Source: plugins/box2d.js, line 2349

pointCast(pos, dynamicOnlyopt, includeSensorsopt) → {Box2dObject|undefined}

point cast and return the first object

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2
`dynamicOnly`	boolean	<optional>	true
`includeSensors`	boolean	<optional>	false	Also find sensors, so a pickup radius does not grab its object from afar

Source: plugins/box2d.js, line 2249

Returns:

Type:: Box2dObject | undefined

raycast(start, end, includeSensorsopt) → {Box2dRaycastResult|undefined}

raycast and return the first result

Parameters:

Name	Type	Attributes	Default	Description
`start`	Vector2
`end`	Vector2
`includeSensors`	boolean	<optional>	false	Also hit sensors, trigger zones are passed through by default

Source: plugins/box2d.js, line 2142

Returns:

Type:: Box2dRaycastResult | undefined

raycastAll(start, end, includeSensorsopt) → {Array.<Box2dRaycastResult>}

raycast and return a list of all the results, nearest first

Parameters:

Name	Type	Attributes	Default	Description
`start`	Vector2
`end`	Vector2
`includeSensors`	boolean	<optional>	false	Also hit sensors, trigger zones are passed through by default

Source: plugins/box2d.js, line 2106

Returns:

Type:: Array.<Box2dRaycastResult>

step(framesopt)

Step the physics world simulation

Parameters:

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

Source: plugins/box2d.js, line 2076

vec2From(v)

converts a box2d vec2 to a Vector2

Parameters:

Name	Type	Description
`v`	Object

Source: plugins/box2d.js, line 2324

vec2FromPointer(vp)

converts a box2d vec2 pointer to a Vector2

Parameters:

Name	Type	Description
`vp`	Object

Source: plugins/box2d.js, line 2332

vec2dTo(v)

converts a Vector2 to a new box2d vec2, which stays until destroyed with box2d.instance.destroy; the plugin itself passes Box2D reused ones, since Box2D copies every vector it is given

Parameters:

Name	Type	Description
`v`	Vector2

Source: plugins/box2d.js, line 2341