[Planck.js API Doc](../README.md) › [Globals](../globals.md) › [Joint](joint.md) # Class: Joint The base joint class. Joints are used to constraint two bodies together in various fashions. Some joints also feature limits and motors. ## Hierarchy * **Joint** ↳ [DistanceJoint](distancejoint.md) ↳ [FrictionJoint](frictionjoint.md) ↳ [RevoluteJoint](revolutejoint.md) ↳ [PrismaticJoint](prismaticjoint.md) ↳ [GearJoint](gearjoint.md) ↳ [MotorJoint](motorjoint.md) ↳ [MouseJoint](mousejoint.md) ↳ [PulleyJoint](pulleyjoint.md) ↳ [RopeJoint](ropejoint.md) ↳ [WeldJoint](weldjoint.md) ↳ [WheelJoint](wheeljoint.md) ## Index ### Constructors * [constructor](joint.md#constructor) ### Methods * [getAnchorA](joint.md#abstract-getanchora) * [getAnchorB](joint.md#abstract-getanchorb) * [getBodyA](joint.md#getbodya) * [getBodyB](joint.md#getbodyb) * [getCollideConnected](joint.md#getcollideconnected) * [getNext](joint.md#getnext) * [getReactionForce](joint.md#abstract-getreactionforce) * [getReactionTorque](joint.md#abstract-getreactiontorque) * [getType](joint.md#gettype) * [getUserData](joint.md#getuserdata) * [initVelocityConstraints](joint.md#abstract-initvelocityconstraints) * [isActive](joint.md#isactive) * [setUserData](joint.md#setuserdata) * [shiftOrigin](joint.md#shiftorigin) * [solvePositionConstraints](joint.md#abstract-solvepositionconstraints) * [solveVelocityConstraints](joint.md#abstract-solvevelocityconstraints) ## Constructors ### constructor \+ **new Joint**(`def`: [JointDef](../interfaces/jointdef.md)): *[Joint](joint.md)* *Defined in [src/dynamics/Joint.ts:110](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L110)* **Parameters:** Name | Type | ------ | ------ | `def` | [JointDef](../interfaces/jointdef.md) | **Returns:** *[Joint](joint.md)* \+ **new Joint**(`def`: [JointOpt](../interfaces/jointopt.md), `bodyA`: [Body](body.md), `bodyB`: [Body](body.md)): *[Joint](joint.md)* *Defined in [src/dynamics/Joint.ts:112](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L112)* **Parameters:** Name | Type | ------ | ------ | `def` | [JointOpt](../interfaces/jointopt.md) | `bodyA` | [Body](body.md) | `bodyB` | [Body](body.md) | **Returns:** *[Joint](joint.md)* ## Methods ### `Abstract` getAnchorA ▸ **getAnchorA**(): *[Vec2](vec2.md)* *Defined in [src/dynamics/Joint.ts:197](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L197)* Get the anchor point on bodyA in world coordinates. **Returns:** *[Vec2](vec2.md)* ___ ### `Abstract` getAnchorB ▸ **getAnchorB**(): *[Vec2](vec2.md)* *Defined in [src/dynamics/Joint.ts:202](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L202)* Get the anchor point on bodyB in world coordinates. **Returns:** *[Vec2](vec2.md)* ___ ### getBodyA ▸ **getBodyA**(): *[Body](body.md)* *Defined in [src/dynamics/Joint.ts:159](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L159)* Get the first body attached to this joint. **Returns:** *[Body](body.md)* ___ ### getBodyB ▸ **getBodyB**(): *[Body](body.md)* *Defined in [src/dynamics/Joint.ts:166](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L166)* Get the second body attached to this joint. **Returns:** *[Body](body.md)* ___ ### getCollideConnected ▸ **getCollideConnected**(): *boolean* *Defined in [src/dynamics/Joint.ts:190](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L190)* Get collide connected. Note: modifying the collide connect flag won't work correctly because the flag is only checked when fixture AABBs begin to overlap. **Returns:** *boolean* ___ ### getNext ▸ **getNext**(): *[Joint](joint.md)* *Defined in [src/dynamics/Joint.ts:173](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L173)* Get the next joint the world joint list. **Returns:** *[Joint](joint.md)* ___ ### `Abstract` getReactionForce ▸ **getReactionForce**(`inv_dt`: number): *[Vec2](vec2.md)* *Defined in [src/dynamics/Joint.ts:207](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L207)* Get the reaction force on bodyB at the joint anchor in Newtons. **Parameters:** Name | Type | ------ | ------ | `inv_dt` | number | **Returns:** *[Vec2](vec2.md)* ___ ### `Abstract` getReactionTorque ▸ **getReactionTorque**(`inv_dt`: number): *number* *Defined in [src/dynamics/Joint.ts:212](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L212)* Get the reaction torque on bodyB in N*m. **Parameters:** Name | Type | ------ | ------ | `inv_dt` | number | **Returns:** *number* ___ ### getType ▸ **getType**(): *string* *Defined in [src/dynamics/Joint.ts:152](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L152)* Get the type of the concrete joint. **Returns:** *string* ___ ### getUserData ▸ **getUserData**(): *unknown* *Defined in [src/dynamics/Joint.ts:177](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L177)* **Returns:** *unknown* ___ ### `Abstract` initVelocityConstraints ▸ **initVelocityConstraints**(`step`: [TimeStep](timestep.md)): *void* *Defined in [src/dynamics/Joint.ts:219](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L219)* **Parameters:** Name | Type | ------ | ------ | `step` | [TimeStep](timestep.md) | **Returns:** *void* ___ ### isActive ▸ **isActive**(): *boolean* *Defined in [src/dynamics/Joint.ts:145](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L145)* Short-cut function to determine if either body is inactive. **Returns:** *boolean* ___ ### setUserData ▸ **setUserData**(`data`: unknown): *void* *Defined in [src/dynamics/Joint.ts:181](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L181)* **Parameters:** Name | Type | ------ | ------ | `data` | unknown | **Returns:** *void* ___ ### shiftOrigin ▸ **shiftOrigin**(`newOrigin`: [Vec2](vec2.md)): *void* *Defined in [src/dynamics/Joint.ts:217](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L217)* Shift the origin for any points stored in world coordinates. **Parameters:** Name | Type | ------ | ------ | `newOrigin` | [Vec2](vec2.md) | **Returns:** *void* ___ ### `Abstract` solvePositionConstraints ▸ **solvePositionConstraints**(`step`: [TimeStep](timestep.md)): *boolean* *Defined in [src/dynamics/Joint.ts:226](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L226)* This returns true if the position errors are within tolerance. **Parameters:** Name | Type | ------ | ------ | `step` | [TimeStep](timestep.md) | **Returns:** *boolean* ___ ### `Abstract` solveVelocityConstraints ▸ **solveVelocityConstraints**(`step`: [TimeStep](timestep.md)): *void* *Defined in [src/dynamics/Joint.ts:221](https://github.com/shakiba/planck.js/blob/acc3bd8/src/dynamics/Joint.ts#L221)* **Parameters:** Name | Type | ------ | ------ | `step` | [TimeStep](timestep.md) | **Returns:** *void*