API Docs for: 0.7.1
Show:

LockConstraint Class

Extends Constraint
Defined in: src/constraints/LockConstraint.js:7

Locks the relative position and rotation between two bodies.

Constructor

LockConstraint

(
  • bodyA
  • bodyB
  • [options]
)

Defined in src/constraints/LockConstraint.js:7

Parameters:

  • bodyA Body
  • bodyB Body
  • [options] Object optional
    • [localOffsetB] Array optional

      The offset of bodyB in bodyA's frame. If not given the offset is computed from current positions.

    • [localAngleB] Number optional

      The angle of bodyB in bodyA's frame. If not given, the angle is computed from current angles.

    • [maxForce] Number optional

Example:

// Locks the relative position and rotation between bodyA and bodyB
        var constraint = new LockConstraint(bodyA, bodyB);
        world.addConstraint(constraint);

Methods

getMaxForce

() Number

Defined in src/constraints/LockConstraint.js:132

Get the max force.

Returns:

Number:

setMaxForce

(
  • force
)

Defined in src/constraints/LockConstraint.js:119

Set the maximum force to be applied.

Parameters:

  • force Number

setRelaxation

(
  • relaxation
)

Inherited from Constraint: src/constraints/Constraint.js:123

Set relaxation for this constraint.

Parameters:

  • relaxation Number

setStiffness

(
  • stiffness
)

Inherited from Constraint: src/constraints/Constraint.js:109

Set stiffness for this constraint.

Parameters:

  • stiffness Number

update

()

Inherited from Constraint: src/constraints/Constraint.js:71

Updates the internal constraint parameters before solve.

Properties

bodyA

Body

Inherited from Constraint: src/constraints/Constraint.js:38

First body participating in the constraint.

bodyB

Body

Inherited from Constraint: src/constraints/Constraint.js:45

Second body participating in the constraint.

collideConnected

Boolean

Inherited from Constraint: src/constraints/Constraint.js:52

Set to true if you want the connected bodies to collide.

Default: true

equations

Array

Inherited from Constraint: src/constraints/Constraint.js:30

Equations to be solved in this constraint

localAngleB

Number

Defined in src/constraints/LockConstraint.js:101

The offset angle of bodyB in bodyA's frame.

localOffsetB

Array

Defined in src/constraints/LockConstraint.js:88

The offset of bodyB in bodyA's frame.

type

Number

Inherited from Constraint: src/constraints/Constraint.js:19

The type of constraint. May be one of Constraint.DISTANCE, Constraint.GEAR, Constraint.LOCK, Constraint.PRISMATIC or Constraint.REVOLUTE.