public class PrismaticJointDef

  1. Object
  2. JointDef
  3. 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.
Warning. at least one body should by dynamic with a non-fixed rotation.

Fields

public final Vec2 localAnchorAThe local anchor point relative to body1’s origin.
public final Vec2 localAnchorBThe local anchor point relative to body2’s origin.
public final Vec2 localAxisAThe local translation axis in body1.
public float referenceAngleThe constrained angle between the bodies: body2_angle - body1_angle.
public boolean enableLimitEnable/disable the joint limit.
public float lowerTranslationThe lower translation limit, usually in meters.
public float upperTranslationThe upper translation limit, usually in meters.
public boolean enableMotorEnable/disable the joint motor.
public float maxMotorForceThe maximum motor torque, usually in N-m.
public float motorSpeedThe desired motor speed in radians per second.

Constructors

public PrismaticJointDef()

Methods

public void initialize(Body b1, Body b2, Vec2 anchor, Vec2 axis)Initialize the bodies, anchors, axis, and reference angle using the world anchor and world axis.

Inherited fields

Inherited methods

Field details

localAnchorA

public final Vec2 localAnchorA
The local anchor point relative to body1’s origin.

localAnchorB

public final Vec2 localAnchorB
The local anchor point relative to body2’s origin.

localAxisA

public final Vec2 localAxisA
The local translation axis in body1.

referenceAngle

public float referenceAngle
The constrained angle between the bodies: body2_angle - body1_angle.

enableLimit

public boolean enableLimit
Enable/disable the joint limit.

lowerTranslation

public float lowerTranslation
The lower translation limit, usually in meters.

upperTranslation

public float upperTranslation
The upper translation limit, usually in meters.

enableMotor

public boolean enableMotor
Enable/disable the joint motor.

maxMotorForce

public float maxMotorForce
The maximum motor torque, usually in N-m.

motorSpeed

public float motorSpeed
The desired motor speed in radians per second.

Constructor details

PrismaticJointDef

public PrismaticJointDef()

Method details

initialize

public void initialize(Body b1, Body b2, Vec2 anchor, Vec2 axis)
Initialize the bodies, anchors, axis, and reference angle using the world anchor and world axis.