Skip to main content

Interface: PrismaticJointOptions

Defined in: physics/joints/prismatic-joint.ts:7

Options for creating a PrismaticJoint.

Properties​

anchorA?​

optional anchorA?: Vector2

Defined in: physics/joints/prismatic-joint.ts:22

The anchor point, relative to bodyA's center of mass and unrotated by bodyA's angle (i.e. in bodyA's local space).

anchorB?​

optional anchorB?: Vector2

Defined in: physics/joints/prismatic-joint.ts:28

The anchor point, relative to bodyB's center of mass and unrotated by bodyB's angle (i.e. in bodyB's local space).

axis?​

optional axis?: Vector2

Defined in: physics/joints/prismatic-joint.ts:35

The axis bodyB's anchor is constrained to slide along, in bodyA's local space. Rotates with bodyA. Does not need to be normalized; it is normalized when the joint is constructed.

bodyA​

bodyA: RigidBody

Defined in: physics/joints/prismatic-joint.ts:11

The first body connected by the joint.

bodyB​

bodyB: RigidBody

Defined in: physics/joints/prismatic-joint.ts:16

The second body connected by the joint.

enableLimit?​

optional enableLimit?: boolean

Defined in: physics/joints/prismatic-joint.ts:42

Whether lowerTranslation/upperTranslation are enforced. When false, the joint still prevents rotation and translation perpendicular to axis, but translation along axis is unbounded.

lowerTranslation?​

optional lowerTranslation?: number

Defined in: physics/joints/prismatic-joint.ts:48

The minimum allowed PrismaticJoint.translation. Only enforced when enableLimit is true.

upperTranslation?​

optional upperTranslation?: number

Defined in: physics/joints/prismatic-joint.ts:54

The maximum allowed PrismaticJoint.translation. Only enforced when enableLimit is true.