b2MouseJoint^(native)

A mouse joint is used to make a point on a body track a specified world point.

Properties

• dampingRatio : Float
  The damping ratio (dimensionless).
• frequency : Float
  The frequency in Hertz.
• maxForce : Float
  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).

Methods

• getTarget() : Multivalue
  Use this to get the target point.
• setTarget(x, y) : b2MouseJoint
  Use this to update the target point.

Remarks

This a soft constraint with a maximum force. This allows the constraint to stretch and without applying huge forces. NOTE: this joint is not documented in the manual because it was developed to be used in the testbed. If you want to learn how to use the mouse joint, look at the testbed.