API Docs for: 0.7.1
Show:

PrismaticConstraint Class

Extends Constraint
Defined in: src/constraints/PrismaticConstraint.js:9

Constraint that only allows bodies to move along a line, relative to each other. See this tutorial. Also called "slider constraint".

Constructor

PrismaticConstraint

(
  • bodyA
  • bodyB
  • [options]
)

Defined in src/constraints/PrismaticConstraint.js:9

Parameters:

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

      Max force to be applied by the constraint

    • [localAnchorA] Array optional

      Body A's anchor point, defined in its own local frame.

    • [localAnchorB] Array optional

      Body B's anchor point, defined in its own local frame.

    • [localAxisA] Array optional

      An axis, defined in body A frame, that body B's anchor point may slide along.

    • [disableRotationalLock] Boolean optional

      If set to true, bodyB will be free to rotate around its anchor point.

    • [upperLimit] Number optional
    • [lowerLimit] Number optional

Methods

disableMotor

()

Defined in src/constraints/PrismaticConstraint.js:316

Disable the rotational motor

enableMotor

()

Defined in src/constraints/PrismaticConstraint.js:304

Enable the motor

setLimits

(
  • lower
  • upper
)

Defined in src/constraints/PrismaticConstraint.js:329

Set the constraint limits.

Parameters:

  • lower Number

    Lower limit.

  • upper Number

    Upper limit.

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 but overwritten in src/constraints/PrismaticConstraint.js:207

Update the constraint equations. Should be done if any of the bodies changed position, before solving.

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

localAnchorA

Array

Defined in src/constraints/PrismaticConstraint.js:40

localAnchorB

Array

Defined in src/constraints/PrismaticConstraint.js:46

localAxisA

Array

Defined in src/constraints/PrismaticConstraint.js:52

lowerLimit

Number

Defined in src/constraints/PrismaticConstraint.js:138

Lower constraint limit. The constraint position is forced to be larger than this value.

lowerLimitEnabled

Boolean

Defined in src/constraints/PrismaticConstraint.js:124

Set to true to enable lower limit.

motorEnabled

Boolean

Defined in src/constraints/PrismaticConstraint.js:167

The current motor state. Enable or disable the motor using .enableMotor

motorEquation

Equation

Defined in src/constraints/PrismaticConstraint.js:160

Equation used for the motor.

motorSpeed

Number

Defined in src/constraints/PrismaticConstraint.js:174

Set the target speed for the motor.

position

Number

Defined in src/constraints/PrismaticConstraint.js:114

The position of anchor A relative to anchor B, along the constraint axis.

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

Number

Defined in src/constraints/PrismaticConstraint.js:145

Upper constraint limit. The constraint position is forced to be smaller than this value.

upperLimitEnabled

Boolean

Defined in src/constraints/PrismaticConstraint.js:131

Set to true to enable upper limit.