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

2.9 KiB
Raw Permalink Blame History

Planck.js API Doc › Globals › WheelJointOpt

Interface: WheelJointOpt

Wheel 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.

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/WheelJoint.ts:63

Suspension damping ratio, one indicates critical damping.


Optional enableMotor

• enableMotor? : boolean

Defined in src/dynamics/joint/WheelJoint.ts:47

Enable/disable the joint motor.


Optional frequencyHz

• frequencyHz? : number

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

Suspension frequency, zero indicates no suspension.


Optional maxMotorTorque

• maxMotorTorque? : number

Defined in src/dynamics/joint/WheelJoint.ts:51

The maximum motor torque, usually in N-m.


Optional motorSpeed

• motorSpeed? : number

Defined in src/dynamics/joint/WheelJoint.ts:55

The desired motor speed in radians per second.


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.