API Docs for: 0.7.1
Show:

RevoluteConstraint Class

Extends Constraint
Defined in: src/constraints/RevoluteConstraint.js:15

Connects two bodies at given offset points, letting them rotate relative to each other around this point.

Constructor

RevoluteConstraint

(
  • bodyA
  • bodyB
  • [options]
)

Defined in src/constraints/RevoluteConstraint.js:15

Parameters:

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

      A pivot point given in world coordinates. If specified, localPivotA and localPivotB are automatically computed from this value.

    • [localPivotA] Array optional

      The point relative to the center of mass of bodyA which bodyA is constrained to.

    • [localPivotB] Array optional

      See localPivotA.

    • [maxForce] Number optional

      The maximum force that should be applied to constrain the bodies.

Example:

// This will create a revolute constraint between two bodies with pivot point in between them.
        var bodyA = new Body({ mass: 1, position: [-1, 0] });
        var bodyB = new Body({ mass: 1, position: [1, 0] });
        var constraint = new RevoluteConstraint(bodyA, bodyB, {
            worldPivot: [0, 0]
        });
        world.addConstraint(constraint);
        
        // Using body-local pivot points, the constraint could have been constructed like this:
        var constraint = new RevoluteConstraint(bodyA, bodyB, {
            localPivotA: [1, 0],
            localPivotB: [-1, 0]
        });

Methods

disableMotor

()

Defined in src/constraints/RevoluteConstraint.js:279

Disable the rotational motor

enableMotor

()

Defined in src/constraints/RevoluteConstraint.js:267

Enable the rotational motor

getMotorSpeed

() Number

Defined in src/constraints/RevoluteConstraint.js:315

Get the speed of the rotational constraint motor

Returns:

Number:

The current speed, or false if the motor is not enabled.

motorIsEnabled

() Boolean deprecated

Defined in src/constraints/RevoluteConstraint.js:292

Deprecated: use property motorEnabled instead.

Check if the motor is enabled.

Returns:

Boolean:

setLimits

(
  • lower
  • upper
)

Defined in src/constraints/RevoluteConstraint.js:157

Set the constraint angle limits.

Parameters:

  • lower Number

    Lower angle limit.

  • upper Number

    Upper angle limit.

setMotorSpeed

(
  • speed
)

Defined in src/constraints/RevoluteConstraint.js:302

Set the speed of the rotational constraint motor

Parameters:

  • speed 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

angle

Number

Defined in src/constraints/RevoluteConstraint.js:113

The constraint position.

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

lowerLimit

Boolean

Defined in src/constraints/RevoluteConstraint.js:135

The lower limit on the constraint angle.

lowerLimitEnabled

Boolean

Defined in src/constraints/RevoluteConstraint.js:121

Set to true to enable lower limit

motorEnabled

Boolean

Defined in src/constraints/RevoluteConstraint.js:106

Indicates whether the motor is enabled. Use .enableMotor() to enable the constraint motor.

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.

upperLimit

Boolean

Defined in src/constraints/RevoluteConstraint.js:142

The upper limit on the constraint angle.

upperLimitEnabled

Boolean

Defined in src/constraints/RevoluteConstraint.js:128

Set to true to enable upper limit