public class MouseJointDef

  1. Object
  2. JointDef
  3. MouseJointDef
Mouse joint definition. This requires a world target point, tuning parameters, and the time step.

Fields

public final Vec2 targetThe initial world target point.
public float maxForceThe maximum constraint force that can be exerted to move the candidate body.
public float frequencyHzThe response speed.
public float dampingRatioThe damping ratio.

Constructors

public MouseJointDef()

Inherited fields

From JointDef

type, userData, bodyA, bodyB, collideConnected

Inherited methods

From Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait, clone

Field details

target

public final Vec2 target
The initial world target point. This is assumed to coincide with the body anchor initially.

maxForce

public float maxForce
The maximum constraint force that can be exerted to move the candidate body. Usually you will express as some multiple of the weight (multiplier * mass * gravity).

frequencyHz

public float frequencyHz
The response speed.

dampingRatio

public float dampingRatio
The damping ratio. 0 = no damping, 1 = critical damping.

Constructor details

MouseJointDef

public MouseJointDef()