API Docs for: 0.7.1
Show:

Constraint Class

Defined in: src/constraints/Constraint.js:5

Base constraint class.

Constructor

Constraint

(
  • bodyA
  • bodyB
  • type
  • [options]
)

Defined in src/constraints/Constraint.js:5

Parameters:

  • bodyA Body
  • bodyB Body
  • type Number
  • [options] Object optional
    • [collideConnected=true] Object optional

Item Index

Methods

Properties

Methods

setRelaxation

(
  • relaxation
)

Defined in src/constraints/Constraint.js:123

Set relaxation for this constraint.

Parameters:

  • relaxation Number

setStiffness

(
  • stiffness
)

Defined in src/constraints/Constraint.js:109

Set stiffness for this constraint.

Parameters:

  • stiffness Number

update

()

Defined in src/constraints/Constraint.js:71

Updates the internal constraint parameters before solve.

Properties

bodyA

Body

Defined in src/constraints/Constraint.js:38

First body participating in the constraint.

bodyB

Body

Defined in src/constraints/Constraint.js:45

Second body participating in the constraint.

collideConnected

Boolean

Defined in src/constraints/Constraint.js:52

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

Default: true

DISTANCE

Number static

Defined in src/constraints/Constraint.js:79

equations

Array

Defined in src/constraints/Constraint.js:30

Equations to be solved in this constraint

GEAR

Number static

Defined in src/constraints/Constraint.js:85

LOCK

Number static

Defined in src/constraints/Constraint.js:91

PRISMATIC

Number static

Defined in src/constraints/Constraint.js:97

REVOLUTE

Number static

Defined in src/constraints/Constraint.js:103

type

Number

Defined in src/constraints/Constraint.js:19

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