planck
Version:
2D JavaScript/TypeScript physics engine for cross-platform HTML5 game development
57 lines (29 loc) • 993 B
Markdown
# Interface: GearJointOpt
Gear joint definition.
## Extends
- [`JointOpt`](/api/interfaces/JointOpt)
## Extended by
- [`GearJointDef`](/api/interfaces/GearJointDef)
## Properties
### collideConnected?
> `optional` **collideConnected**: `boolean`
Set this flag to true if the attached bodies
should collide.
#### Inherited from
[`JointOpt`](/api/interfaces/JointOpt).[`collideConnected`](/api/interfaces/JointOpt#collideconnected)
***
### ratio?
> `optional` **ratio**: `number`
The gear ratio. See [GearJoint](/api/classes/GearJoint) for explanation.
***
### style?
> `optional` **style**: [`Style`](/api/interfaces/Style)
Styling for dev-tools.
#### Inherited from
[`JointOpt`](/api/interfaces/JointOpt).[`style`](/api/interfaces/JointOpt#style)
***
### userData?
> `optional` **userData**: `any`
Use this to attach application specific data to your joints.
#### Inherited from
[`JointOpt`](/api/interfaces/JointOpt).[`userData`](/api/interfaces/JointOpt#userdata)