API Docs for: GoblinPhysics
Show:

World Class

Defined in: src\classes\World.js:1
Module: Goblin

Manages the physics simulation

Constructor

World

(
  • broadphase
  • nearphase
)

Defined in src\classes\World.js:1

Parameters:

  • broadphase Goblin.Broadphase

    the broadphase used by the world to find possible contacts

  • nearphase Goblin.NearPhase

    the nearphase used by the world to generate valid contacts

Methods

addConstraint

(
  • constraint
)

Defined in src\classes\World.js:213

adds a constraint to the world

Parameters:

  • constraint Goblin.Constraint

    constraint to be added

addForceGenerator

(
  • force_generator
)

Defined in src\classes\World.js:179

Adds a force generator to the world

Parameters:

  • force_generator Goblin.ForceGenerator

    force generator object to be added

addRigidBody

(
  • rigid_body
)

Defined in src\classes\World.js:147

Adds a rigid body to the world

Parameters:

  • rigid_body Goblin.RigidBody

    rigid body to add to the world

removeConstraint

(
  • constraint
)

Defined in src\classes\World.js:223

removes a constraint from the world

Parameters:

  • constraint Goblin.Constraint

    constraint to be removed

removeForceGenerator

(
  • force_generatorv
)

Defined in src\classes\World.js:197

removes a force generator from the world

Parameters:

  • force_generatorv Goblin.ForceGenerator

    force generator object to be removed

removeRigidBody

(
  • rigid_body
)

Defined in src\classes\World.js:160

Removes a rigid body from the world

Parameters:

  • rigid_body Goblin.RigidBody

    rigid body to remove from the world

step

(
  • time_delta
  • [max_step]
)

Defined in src\classes\World.js:75

Steps the physics simulation according to the time delta

Parameters:

  • time_delta Number

    amount of time to simulate, in seconds

  • [max_step] Number optional

    maximum time step size, in seconds

Properties

broadphase

Goblin.Broadphase

Defined in src\classes\World.js:18

The broadphase used by the world to find possible contacts

end {vec3{ end point of the segment

Vec3

Defined in src\classes\World.js:233

Checks if a ray segment intersects with objects in the world

force_generators

Array private

Defined in src\classes\World.js:61

array of force generators in the world

Default: []

gravity

Vec3

Defined in src\classes\World.js:52

the world's gravity, applied by default to all objects in the world

Default: [ 0, -9.8, 0 ]

nearphasee

Goblin.NearPhase

Defined in src\classes\World.js:26

The nearphase used by the world to generate valid contacts

rigid_bodies

Array private

Defined in src\classes\World.js:42

Array of rigid_bodies in the world

Default: []

solver

Unknown

Defined in src\classes\World.js:34

The contact solver used by the world to calculate and apply impulses resulting from contacts

ticks

Number

Defined in src\classes\World.js:10

How many time steps have been simulated. If the steps are always the same length then total simulation time = world.ticks * time_step