Class PrismaticConstraint

Constraint that only allows bodies to move along a line, relative to each other.

Also called "slider constraint".

See

http://www.iforce2d.net/b2dtut/joints-prismatic

Todo

Ability to create using only a point and a worldAxis

Example

var constraint = new PrismaticConstraint(bodyA, bodyB, {
        localAxisA: [0, 1]
    });
    world.addConstraint(constraint);

Hierarchy

Constructors

constructor

Properties

bodyA bodyB collideConnected equations localAnchorA localAnchorB localAxisA lowerLimit lowerLimitEnabled lowerLimitEquation maxForce motorEnabled motorEquation motorSpeed position type upperLimit upperLimitEnabled upperLimitEquation DISTANCE GEAR LOCK OTHER PRISMATIC REVOLUTE

Methods

disableMotor enableMotor setLimits setMaxBias setRelaxation setStiffness update

Constructors

constructor

Properties

bodyA

bodyA: Body

First body participating in the constraint.

bodyB

bodyB: Body

Second body participating in the constraint.

collideConnected

collideConnected: boolean

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

Default

true

equations

equations: Equation[]

Equations to be solved in this constraint

localAnchorA

localAnchorA: Vec2

localAnchorB

localAnchorB: Vec2

localAxisA

localAxisA: Vec2

lowerLimit

lowerLimit: number

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

lowerLimitEnabled

lowerLimitEnabled: boolean

Set to true to enable lower limit.

lowerLimitEquation

lowerLimitEquation: ContactEquation

maxForce

maxForce: number

Max force for the motor

motorEnabled

motorEnabled: boolean

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

motorEquation

motorEquation: Equation

Equation used for the motor.

motorSpeed

motorSpeed: number

Set the target speed for the motor.

position

position: number

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

type

type: 2 | 1 | -1 | 3 | 4 | 5

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

upperLimit

upperLimit: number

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

upperLimitEnabled

upperLimitEnabled: boolean

Set to true to enable upper limit.

upperLimitEquation

upperLimitEquation: ContactEquation

Static DISTANCE

DISTANCE: 1 = ...

Static GEAR

GEAR: 2 = ...

Static LOCK

LOCK: 3 = ...

Static OTHER

OTHER: -1 = ...

Static PRISMATIC

PRISMATIC: 4 = ...

Static REVOLUTE

REVOLUTE: 5 = ...

Methods

disableMotor

  • Disable the rotational motor

    Returns void

enableMotor

  • Enable the motor

    Returns void

setLimits

  • Set the constraint limits.

    Parameters

    • lower: number

      lower limit

    • upper: number

      upper limit

    Returns void

setMaxBias

  • Set max bias for this constraint.

    Parameters

    • maxBias: number

    Returns void

setRelaxation

  • Set relaxation for this constraint.

    Parameters

    • relaxation: number

    Returns void

setStiffness

  • Set stiffness for this constraint.

    Parameters

    • stiffness: number

    Returns void

update

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

    Returns void

Settings

Member Visibility

Theme

On This Page