Skip to content

Interface: MouseJointOpt ​

Mouse joint definition. This requires a world target point, tuning parameters, and the time step.

Extends ​

Extended by ​

Properties ​

collideConnected? ​

optional collideConnected: boolean

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

Inherited from ​

JointOpt.collideConnected


dampingRatio? ​

optional dampingRatio: number

[dampingRatio = 0.7] The damping ratio. 0 = no damping, 1 = critical damping.


frequencyHz? ​

optional frequencyHz: number

[frequencyHz = 5.0] The response speed.


maxForce? ​

optional maxForce: number

[maxForce = 0.0] 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).


style? ​

optional style: Style

Styling for dev-tools.

Inherited from ​

JointOpt.style


userData? ​

optional userData: any

Use this to attach application specific data to your joints.

Inherited from ​

JointOpt.userData