API Docs for: 0.1.0
Show:

zerk.game.engine.physics Class

Extends zerk.observable
Defined in: src/zerk/class/game/engine/physics.js:1
Module: zerk

Physics engine interface

Box2dWeb implementation.

Methods

_addContactListener

() protected

Defined in src/zerk/class/game/engine/physics.js:807

Registers the contact listener event handlers

_cleanup

() protected

Defined in src/zerk/class/game/engine/physics.js:318

Destroy bodies and joints schedules to be removed from the world

_createBody

(
  • entity
  • body
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:847

Creates a body

Parameters:

Returns:

Object: Body handle

_createFixture

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:901

Delegate method for fixture creation

Parameters:

Returns:

Object: Fixture handle

_createFixtureCircle

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:988

Creates a circle shaped fixture

Parameters:

Returns:

Object: Fixture handle

_createFixturePolygon

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:1035

Creates a polygon shaped fixture

Parameters:

Returns:

Object: Fixture handle

_createFixtureRectangle

(
  • entity
  • body
  • fixture
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:938

Creates a rectangle shaped fixture

Parameters:

Returns:

Object: Fixture handle

_createJoint

(
  • entity
  • joint
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:1091

Delgate method for joint creation

Parameters:

Returns:

Object: Joint handle

_createJointDistance

(
  • entity
  • joint
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:1111

Creates a distance joint

Parameters:

Returns:

Object: Joint handle

_createJointMouse

(
  • body
  • targetX
  • targetY
)
Object protected

Defined in src/zerk/class/game/engine/physics.js:1193

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/physics.js:1156

Creates a revolute join

Parameters:

Returns:

Object: Joint handle

_destroyBody

(
  • entity
  • body
)
protected

Defined in src/zerk/class/game/engine/physics.js:372

Destroys a body

Parameters:

_destroyJoint

(
  • entity
  • joint
)
protected

Defined in src/zerk/class/game/engine/physics.js:392

Destroys a joint

Parameters:

_getBodyAtMouseCallback

(
  • fixture
)
Boolean protected

Defined in src/zerk/class/game/engine/physics.js:1272

Callbak method for internal processing of getBodyAtMouse

Parameters:

  • fixture Object

    Box2D fixture

Returns:

Boolean:

_log

(
  • msg
)
protected

Defined in src/zerk/class/game/engine/physics.js:1304

Local log method

Parameters:

  • msg String

    Log message

_onContactBegin

(
  • contact
)
protected

Defined in src/zerk/class/game/engine/physics.js:613

Contact begin event handler

Parameters:

  • contact Object

    Contact information

_onContactEnd

(
  • contact
)
protected

Defined in src/zerk/class/game/engine/physics.js:670

Contact end event handler

Parameters:

  • contact Object

    Contact information

_onContactPostSolve

(
  • contact
  • impulse
)
protected

Defined in src/zerk/class/game/engine/physics.js:729

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/physics.js:791

Contact pre solve event handler

Parameters:

  • contact Object

    Contact information

  • oldManifold Object

_processMouseJoint

() protected

Defined in src/zerk/class/game/engine/physics.js:1220

Process mouse joint

createPhysics

(
  • entity
)

Defined in src/zerk/class/game/engine/physics.js:412

Create the physics engine representation for an entity

Parameters:

dumpPhysicsData

()

Defined in src/zerk/class/game/engine/physics.js:582

Dumps elements currently contained in physics simulation to console

fireEvent

(
  • event
)
Boolen

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

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/physics.js:456

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/physics.js:489

Returns an array of entities inside given area

Parameters:

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

Returns:

Array: Entities inside given area

init

(
  • engine
)

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

Class constructor

Parameters:

on

(
  • event
  • callback
  • scope
)

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

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

removePhysics

(
  • entity
)

Defined in src/zerk/class/game/engine/physics.js:434

Removes the physics engine representation for an entity

Parameters:

scheduleDestroyBody

(
  • entity
  • body
)

Defined in src/zerk/class/game/engine/physics.js:346

Schedules a body to be destroyed after current simulation tick

Parameters:

scheduleDestroyJoint

(
  • entity
  • body
)

Defined in src/zerk/class/game/engine/physics.js:359

Schedules a join to be destroyed after current simulation tick

Parameters:

syncEntityPhysics

(
  • entity
)

Defined in src/zerk/class/game/engine/physics.js:545

Synchronize the physic simulation properties of an entity

Parameters:

tick

()

Defined in src/zerk/class/game/engine/physics.js:288

Physics engine tick

un

(
  • event
  • callback
)
Boolen

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

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

Properties

__destroyJointList

Array protected

Defined in src/zerk/class/game/engine/physics.js:91

List of joints to be destroyed after current simulation tick

_b2AABB

Object protected

Defined in src/zerk/class/game/engine/physics.js:109

Shortcut for Box2D.Collision.b2AABB

_b2Body

Object protected

Defined in src/zerk/class/game/engine/physics.js:127

Shortcut for Box2D.Dynamics.b2Body

_b2BodyDef

Object protected

Defined in src/zerk/class/game/engine/physics.js:118

Shortcut for Box2D.Dynamics.b2BodyDef

_b2CircleShape

Object protected

Defined in src/zerk/class/game/engine/physics.js:163

Shortcut for Box2D.Collision.Shapes.b2CircleShape

_b2ContactListener

Object protected

Defined in src/zerk/class/game/engine/physics.js:208

Shortcut for Box2D.Dynamics.b2ContactListener

_b2DebugDraw

Object protected

Defined in src/zerk/class/game/engine/physics.js:172

Shortcut for Box2D.Dynamics.b2DebugDraw

_b2DistanceJointDef

Object protected

Defined in src/zerk/class/game/engine/physics.js:199

Shortcut for Box2D.Dynamics.Joints.b2DistanceJointDef

_b2FixtureDef

Object protected

Defined in src/zerk/class/game/engine/physics.js:136

Shortcut for Box2D.Dynamics.b2FixtureDef

_b2MouseJointDef

Object protected

Defined in src/zerk/class/game/engine/physics.js:181

Shortcut for Box2D.Dynamics.Joints.b2MouseJointDef

_b2PolygonShape

Object protected

Defined in src/zerk/class/game/engine/physics.js:154

Shortcut for Box2D.Collision.Shapes.b2PolygonShape

_b2RevoluteJointDef

Object protected

Defined in src/zerk/class/game/engine/physics.js:190

Shortcut for Box2D.Dynamics.Joints.b2RevoluteJointDef

_b2Vec2

Object protected

Defined in src/zerk/class/game/engine/physics.js:100

Shortcut for Box2D.Common.Math.b2Vec2

_b2World

Object protected

Defined in src/zerk/class/game/engine/physics.js:145

Shortcut for Box2D.Dynamics.b2World

_config

Object protected

Defined in src/zerk/class/game/engine/physics.js:28

Physics configuration

_destroyBodyList

Array protected

Defined in src/zerk/class/game/engine/physics.js:82

List of bodies to be destroyed after current simulation tick

_engine

zerk.game.engine protected

Defined in src/zerk/class/game/engine/physics.js:37

Game engine

_eventListeners

Array protected

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

List of event handlers

_mouseJoint

Object protected

Defined in src/zerk/class/game/engine/physics.js:55

Handle for the mouse joint

_mouseJointVec

Object protected

Defined in src/zerk/class/game/engine/physics.js:64

Stores a vector for the mouse joint function

_selectedBody

Object protected

Defined in src/zerk/class/game/engine/physics.js:73

Stores the last selected body

_world

Box2D.Dynamics.b2World protected

Defined in src/zerk/class/game/engine/physics.js:46

Box2D world

Events

contactbegin

Defined in src/zerk/class/game/engine/physics.js:630

Fires when two fixtures start colliding

Event Payload:

contactend

Defined in src/zerk/class/game/engine/physics.js:687

Fires when two fixtures stop colliding

Event Payload:

contactpostsolve

Defined in src/zerk/class/game/engine/physics.js:747

Fires before two fixtures start colliding

Event Payload: