API Docs for: 0.7.1
Show:

RotationalSpring Class

Extends Spring
Defined in: src/objects/RotationalSpring.js:6

A rotational spring, connecting two bodies rotation. This spring explicitly adds angularForce (torque) to the bodies.

The spring can be combined with a RevoluteConstraint to make, for example, a mouse trap.

Constructor

RotationalSpring

(
  • bodyA
  • bodyB
  • [options]
)

Defined in src/objects/RotationalSpring.js:6

Parameters:

  • bodyA Body
  • bodyB Body
  • [options] Object optional
    • [restAngle] Number optional

      The relative angle of bodies at which the spring is at rest. If not given, it's set to the current relative angle between the bodies.

    • [stiffness=100] Number optional

      Spring constant (see Hookes Law). A number >= 0.

    • [damping=1] Number optional

      A number >= 0.

Item Index

Methods

Properties

Methods

applyForce

()

Inherited from Spring but overwritten in src/objects/RotationalSpring.js:36

Apply the spring force to the connected bodies.

Properties

bodyA

Body

Inherited from Spring: src/objects/Spring.js:41

First connected body.

bodyB

Body

Inherited from Spring: src/objects/Spring.js:48

Second connected body.

damping

Number

Inherited from Spring: src/objects/Spring.js:34

Damping of the spring.

restAngle

Number

Defined in src/objects/RotationalSpring.js:26

Rest angle of the spring.

stiffness

Number

Inherited from Spring: src/objects/Spring.js:27

Stiffness of the spring.