API Docs for: 0.1.0
Show:

zerk.game.engine.system.physics.box2d Class

Extends zerk.game.engine.system.physics
Defined in: src/zerk/class/game/engine/system/physics/box2d.js:4
Module: zerk

Box2D Physics System

Box2dWeb implementation.

Methods

__setBodyKinematic

(
  • bodyKey
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:389

Sets given body to be kinematic

Parameters:

  • bodyKey String

__setLinearVelocity

(
  • bodyKey
  • degrees
  • power
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:316

Sets the linear velocity of given body

Parameters:

  • bodyKey String
  • degrees Integer
  • power Integer

_addContactListener

() protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:878

Registers the contact listener event handlers

_bodyApplyImpulse

(
  • bodyKey
  • degrees
  • power
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:293

Applies an impulse to given body

Parameters:

  • bodyKey String
  • degrees Integer
  • power Integer

_cleanup

() protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:507

Destroy bodies and joints schedules to be removed from the world

_createBody

(
  • entity
  • body
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:967

Creates a body

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • body zerk.game.engine.system.physics.box2d.body

    Body

Returns:

Object: Body handle

_createFixture

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1029

Delegate method for fixture creation

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • body zerk.game.engine.system.physics.box2d.body

    Body

  • fixture zerk.game.engine.system.physics.box2d.fixture

    Fixture

Returns:

Object: Fixture handle

_createFixtureCircle

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1128

Creates a circle shaped fixture

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • body zerk.game.engine.system.physics.box2d.body

    Body

  • fixture zerk.game.engine.system.physics.box2d.fixture

    Fixture

Returns:

Object: Fixture handle

_createFixturePolygon

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1179

Creates a polygon shaped fixture

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • body zerk.game.engine.system.physics.box2d.body

    Body

  • fixture zerk.game.engine.system.physics.box2d.fixture

    Fixture

Returns:

Object: Fixture handle

_createFixtureRectangle

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1066

Creates a rectangle shaped fixture

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • body zerk.game.engine.system.physics.box2d.body

    Body

  • fixture zerk.game.engine.system.physics.box2d.fixture

    Fixture

Returns:

Object: Fixture handle

_createJoint

(
  • entity
  • joint
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1255

Delgate method for joint creation

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • joint zerk.game.engine.system.physics.box2d.joint

    Joint

Returns:

Object: Joint handle

_createJointDistance

(
  • entity
  • joint
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1275

Creates a distance joint

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • joint zerk.game.engine.system.physics.box2d.joint

    Joint

Returns:

Object: Joint handle

_createJointMouse

(
  • body
  • targetX
  • targetY
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1357

Creates a mouse joint

Parameters:

  • body Object

    Box2dWeb body

  • targetX Float

    Horizontal position

  • targetY Float

    Vertical position

Returns:

Object: Joint handle

_createJointRevolute

(
  • entity
  • joint
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1320

Creates a revolute join

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • joint zerk.game.engine.system.physics.box2d.joint

    Joint

Returns:

Object: Joint handle

_createPhysics

(
  • entity
)
protected

Inherited from zerk.game.engine.system.physics: src/zerk/class/game/engine/system/physics.js:181

Creates the physics representation for given entity

Parameters:

_destroyBody

(
  • bodyKey
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:470

Destroys given body

Parameters:

  • bodyKey String

_destroyBody

(
  • entity
  • body
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:561

Destroys a body

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • body zerk.game.engine.system.physics.box2d.body

    Body

_destroyJoint

(
  • entity
  • joint
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:581

Destroys a joint

Parameters:

  • entity zerk.game.engine.entity

    Entity

  • joint zerk.game.engine.system.physics.box2d.joint

    Joint

_getBodyAtMouseCallback

(
  • fixture
)
Boolean protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1443

Callbak method for internal processing of getBodyAtMouse

Parameters:

  • fixture Object

    Box2D fixture

Returns:

Boolean:

_getBodyLinearVelocity

(
  • bodyKey
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:454

Returns the linear velocity of given body

Parameters:

  • bodyKey String

Returns:

Object:

_getBodyPosition

(
  • bodyKey
)
Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:440

Returns position of given body

Parameters:

  • bodyKey String

Returns:

Object: Position

_getConfigDefaults

() Object protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:54

Returns the configuration defaults of the system

Returns:

Object: Default configuration

_getSystem

(
  • name
)
zerk.game.engine.system protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:231

Returns system by given name

This method is used to communicate with other systems.

Parameters:

  • name String

    System name

Returns:

zerk.game.engine.system: System instance

_log

(
  • message
  • severity
)
protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:247

Local log method

Parameters:

  • message String

    Log message

  • severity Integer

    Log severity

_onContactBegin

(
  • contact
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:770

Contact begin event handler

Parameters:

  • contact Object

    Contact information

_onContactEnd

(
  • contact
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:798

Contact end event handler

Parameters:

  • contact Object

    Contact information

_onContactPostSolve

(
  • contact
  • impulse
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:828

Contact post solve event handler

Parameters:

  • contact Object

    Contact information

  • impulse Object

    Impulse information

_onContactPreSolve

(
  • contact
  • oldManifold
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:862

Contact pre solve event handler

Parameters:

  • contact Object

    Contact information

  • oldManifold Object

_processMouseJoint

() protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:1384

Process mouse joint

_removePhysics

(
  • entity
)
protected

Inherited from zerk.game.engine.system.physics: src/zerk/class/game/engine/system/physics.js:190

Removes the physics representation for given entity

Parameters:

_scheduleDestroyBody

(
  • entity
  • body
)

Defined in src/zerk/class/game/engine/system/physics/box2d.js:535

Schedules a body to be destroyed after current simulation tick

Parameters:

  • entity zerk.game.engine.entity
  • body zerk.game.engine.system.physics.box2d.body

_scheduleDestroyJoint

(
  • entity
  • body
)

Defined in src/zerk/class/game/engine/system/physics/box2d.js:548

Schedules a join to be destroyed after current simulation tick

Parameters:

  • entity zerk.game.engine.entity
  • body zerk.game.engine.system.physics.box2d.join

_setBodyMoveable

(
  • bodyKey
  • moveable
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:369

Sets whether given body is moveable

Parameters:

  • bodyKey String
  • moveable Boolean

_setBodyPosition

(
  • bodyKey
  • position
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:338

Sets the position of given body

Parameters:

  • bodyKey String
  • position Object

_setBodySleepingAllowed

(
  • bodyKey
  • allowed
)
protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:354

Sets whether given body is allowed to sleep

Parameters:

  • bodyKey String
  • allowed Boolean

_tick

() protected

Inherited from zerk.game.engine.system.physics: src/zerk/class/game/engine/system/physics.js:173

Fires every tick

addEntity

(
  • entity
)

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:113

Adds an entity to the system

Parameters:

createPhysics

(
  • entity
)

Defined in src/zerk/class/game/engine/system/physics/box2d.js:919

Create the physics engine representation for an entity

Parameters:

  • entity zerk.game.engine.entity

    Entity

dumpPhysicsData

()

Defined in src/zerk/class/game/engine/system/physics/box2d.js:691

Dumps elements currently contained in physics simulation to console

fireEvent

(
  • event
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:112

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

getBodyAtMouse

() Object

Defined in src/zerk/class/game/engine/system/physics/box2d.js:601

Returns body at current cursor position if present

Returns:

Object: Box2D body

getEntitiesInArea

(
  • x1
  • y1
  • x2
  • y2
)
Array

Defined in src/zerk/class/game/engine/system/physics/box2d.js:639

Returns an array of entities inside given area

Parameters:

  • x1 Float
  • y1 Float
  • x2 Float
  • y2 Float

Returns:

Array: Entities inside given area

getName

() String

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:128

Returns the name of the system

Returns:

String: System name

getPriority

() Integer

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:140

Returns the priority of the system

Returns:

Integer: System priority

getThread

() String

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:116

Returns the thread the systems runs in

Returns:

String: Thread name

init

(
  • engine
)

Inherited from zerk.observable but overwritten in src/zerk/class/game/engine/system/physics/box2d.js:201

Class constructor

Parameters:

on

(
  • event
  • callback
  • scope
)

Inherited from zerk.observable: src/zerk/class/observable.js:38

Register event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function. Return false to cancel event bubble.

  • scope Object

    Scope to be used in callback function

removeEntity

(
  • entity
)

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:130

Removes an entity from the system

Parameters:

removePhysics

(
  • entity
)

Defined in src/zerk/class/game/engine/system/physics/box2d.js:941

Removes the physics engine representation for an entity

Parameters:

  • entity zerk.game.engine.entity

    Entity

start

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:85

Starts the system

stop

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:99

Stops the system

syncEntityPhysics

(
  • entity
)

Defined in src/zerk/class/game/engine/system/physics/box2d.js:722

Synchronize the physic simulation properties of an entity

Parameters:

  • entity zerk.game.engine.entity

    Entity

tick

()

Defined in src/zerk/class/game/engine/system/physics/box2d.js:257

Physics engine tick

un

(
  • event
  • callback
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:80

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

update

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:147

Updates the system

useComponent

(
  • name
)
Boolean

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:72

Returns true when the system is interested in given component

Parameters:

  • name String

    Component name

Returns:

Boolean: True when the system is intereseted in given component

Properties

__destroyJointList

Array protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:75

List of joints to be destroyed after current simulation tick

_b2AABB

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:93

Shortcut for Box2D.Collision.b2AABB

_b2Body

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:111

Shortcut for Box2D.Dynamics.b2Body

_b2BodyDef

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:102

Shortcut for Box2D.Dynamics.b2BodyDef

_b2CircleShape

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:147

Shortcut for Box2D.Collision.Shapes.b2CircleShape

_b2ContactListener

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:192

Shortcut for Box2D.Dynamics.b2ContactListener

_b2DebugDraw

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:156

Shortcut for Box2D.Dynamics.b2DebugDraw

_b2DistanceJointDef

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:183

Shortcut for Box2D.Dynamics.Joints.b2DistanceJointDef

_b2FixtureDef

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:120

Shortcut for Box2D.Dynamics.b2FixtureDef

_b2MouseJointDef

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:165

Shortcut for Box2D.Dynamics.Joints.b2MouseJointDef

_b2PolygonShape

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:138

Shortcut for Box2D.Collision.Shapes.b2PolygonShape

_b2RevoluteJointDef

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:174

Shortcut for Box2D.Dynamics.Joints.b2RevoluteJointDef

_b2Vec2

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:84

Shortcut for Box2D.Common.Math.b2Vec2

_b2World

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:129

Shortcut for Box2D.Dynamics.b2World

_config

Object protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics/box2d.js:21

Physics configuration

_destroyBodyList

Array protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:66

List of bodies to be destroyed after current simulation tick

_engine

zerk.game.engine protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:55

Engine instance

Back reference to the engine instance.

_entities

Array protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:66

Entities register

Entities that this system is interested in.

_eventListeners

Array protected

Inherited from zerk.observable: src/zerk/class/observable.js:18

List of event handlers

_mouseJoint

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:39

Handle for the mouse joint

_mouseJointVec

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:48

Stores a vector for the mouse joint function

_name

String protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:20

Name of the system

_priority

Integer protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:44

Priority of this system

Priorities handle the order in which systems are processed.

_selectedBody

Object protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:57

Stores the last selected body

_thread

String protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/physics.js:29

Thread that runs this system

_world

Box2D.Dynamics.b2World protected

Defined in src/zerk/class/game/engine/system/physics/box2d.js:30

Box2D world

Events

contactbegin

Defined in src/zerk/class/game/engine/system/physics/box2d.js:782

Fires when two fixtures start colliding

Event Payload:

  • sourceFixture zerk.game.engine.system.physics.box2d.fixture

    Source fixture

  • targetFixture zerk.game.engine.system.physics.box2d.fixture

    Target fixture

contactend

Defined in src/zerk/class/game/engine/system/physics/box2d.js:810

Fires when two fixtures stop colliding

Event Payload:

  • sourceFixture zerk.game.engine.system.physics.box2d.fixture

    Source fixture

  • targetFixture zerk.game.engine.system.physics.box2d.fixture

    Target fixture

contactpostsolve

Defined in src/zerk/class/game/engine/system/physics/box2d.js:844

Fires before two fixtures start colliding

Event Payload:

  • sourceFixture zerk.game.engine.system.physics.box2d.fixture

    Source fixture

  • targetFixture zerk.game.engine.system.physics.box2d.fixture

    Target fixture

  • impulse Object