Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

Methods

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 = 1

Static GEAR

GEAR: 2 = 2

Static LOCK

LOCK: 3 = 3

Static OTHER

OTHER: -1 = -1

Static PRISMATIC

PRISMATIC: 4 = 4

Static REVOLUTE

REVOLUTE: 5 = 5

Methods

disableMotor

  • disableMotor(): void

  • Disable the rotational motor

    Returns void

enableMotor

  • enableMotor(): void

  • Enable the motor

    Returns void

setLimits

  • setLimits(lower: number, upper: number): void

  • Set the constraint limits.

    Parameters

    • lower: number

      lower limit

    • upper: number

      upper limit

    Returns void

setMaxBias

  • setMaxBias(maxBias: number): void

  • Set max bias for this constraint.

    Parameters

    • maxBias: number

    Returns void

setRelaxation

  • setRelaxation(relaxation: number): void

  • Set relaxation for this constraint.

    Parameters

    • relaxation: number

    Returns void

setStiffness

  • setStiffness(stiffness: number): void

  • Set stiffness for this constraint.

    Parameters

    • stiffness: number

    Returns void

update

  • update(): void

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

    Returns void