Planck.js Docs

Appearance

Interface: PrismaticJointDef ​

Prismatic joint definition. This requires defining a line of motion using an axis and an anchor point. The definition uses local anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint translation is zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when saving and loading a game.

Extends ​

Properties ​

bodyA ​

bodyA: Body

The first attached body.

Inherited from ​

JointDef.bodyA

bodyB ​

bodyB: Body

The second attached body.

Inherited from ​

JointDef.bodyB

collideConnected? ​

optional collideConnected: boolean

Set this flag to true if the attached bodies should collide.

Inherited from ​

JointDef.collideConnected

enableLimit? ​

optional enableLimit: boolean

Enable/disable the joint limit.

Inherited from ​

PrismaticJointOpt.enableLimit

enableMotor? ​

optional enableMotor: boolean

Enable/disable the joint motor.

Inherited from ​

PrismaticJointOpt.enableMotor

localAnchorA ​

localAnchorA: Vec2Value

The local anchor point relative to bodyA's origin.

localAnchorB ​

localAnchorB: Vec2Value

The local anchor point relative to bodyB's origin.

localAxisA ​

localAxisA: Vec2Value

The local translation unit axis in bodyA.

lowerTranslation? ​

optional lowerTranslation: number

The lower translation limit, usually in meters.

Inherited from ​

PrismaticJointOpt.lowerTranslation

maxMotorForce? ​

optional maxMotorForce: number

The maximum motor torque, usually in N-m.

Inherited from ​

PrismaticJointOpt.maxMotorForce

motorSpeed? ​

optional motorSpeed: number

The desired motor speed in radians per second.

Inherited from ​

PrismaticJointOpt.motorSpeed

referenceAngle? ​

optional referenceAngle: number

referenceAngle The constrained angle between the bodies: bodyB_angle - bodyA_angle.

style? ​

optional style: Style

Styling for dev-tools.

Inherited from ​

JointDef.style

upperTranslation? ​

optional upperTranslation: number

The upper translation limit, usually in meters.

Inherited from ​

PrismaticJointOpt.upperTranslation

userData? ​

optional userData: any

Use this to attach application specific data to your joints.

Inherited from ​

JointDef.userData