2021-05-11 18:30:36 -07:00

2.2 KiB
Raw Permalink Blame History

Planck.js API Doc › Globals › MouseJointOpt

Interface: MouseJointOpt

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

Hierarchy

Index

Properties

Properties

Optional collideConnected

• collideConnected? : boolean

Inherited from JointOpt.collideConnected

Defined in src/dynamics/Joint.ts:69

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


Optional dampingRatio

• dampingRatio? : number

Defined in src/dynamics/joint/MouseJoint.ts:59

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


Optional frequencyHz

• frequencyHz? : number

Defined in src/dynamics/joint/MouseJoint.ts:54

[frequencyHz = 5.0] The response speed.


Optional maxForce

• maxForce? : number

Defined in src/dynamics/joint/MouseJoint.ts:50

[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).


Optional userData

• userData? : any

Inherited from JointOpt.userData

Defined in src/dynamics/Joint.ts:64

Use this to attach application specific data to your joints.