Class b2RevoluteJoint

A revolute joint constrains to bodies to share a common point while they are free to rotate about the point. The relative rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is provided so that infinite forces are not generated.

Hierarchy (View Summary)

b2Joint
- b2RevoluteJoint

Constructors

constructor

new b2RevoluteJoint(): b2RevoluteJoint
Returns b2RevoluteJoint
Inherited from b2Joint.constructor

Methods

EnableLimit

EnableLimit(flag: boolean): void
Enable/disable the joint limit.
Parameters
- flag: boolean
  True to enable, false to disable.
Returns void
- Defined in typings/box2dweb.d.ts:5292

EnableMotor

EnableMotor(flag: boolean): void
Enable/disable the joint motor.
Parameters
- flag: boolean
  True to enable, false to diasable.
Returns void
- Defined in typings/box2dweb.d.ts:5298

GetAnchorA

GetAnchorA(): b2Vec2
Get the anchor point on bodyA in world coordinates.

Returns b2Vec2
Body A anchor.
Overrides b2Joint.GetAnchorA
- Defined in typings/box2dweb.d.ts:5304

GetAnchorB

GetAnchorB(): b2Vec2
Get the anchor point on bodyB in world coordinates.

Returns b2Vec2
Body B anchor.
Overrides b2Joint.GetAnchorB
- Defined in typings/box2dweb.d.ts:5310

GetBodyA

GetBodyA(): b2Body
Get the first body attached to this joint.

Returns b2Body
Body A.
Inherited from b2Joint.GetBodyA
- Defined in typings/box2dweb.d.ts:4230

GetBodyB

GetBodyB(): b2Body
Get the second body attached to this joint.

Returns b2Body
Body B.
Inherited from b2Joint.GetBodyB
- Defined in typings/box2dweb.d.ts:4236

GetJointAngle

GetJointAngle(): number
Get the current joint angle in radians.

Returns number
Joint angle.
- Defined in typings/box2dweb.d.ts:5316

GetJointSpeed

GetJointSpeed(): number
Get the current joint angle speed in radians per second.

Returns number
Joint speed.
- Defined in typings/box2dweb.d.ts:5322

GetLowerLimit

GetLowerLimit(): number
Get the lower joint limit in radians.

Returns number
Lower limit.
- Defined in typings/box2dweb.d.ts:5328

GetMotorSpeed

GetMotorSpeed(): number
Get the motor speed in radians per second.

Returns number
Motor speed.
- Defined in typings/box2dweb.d.ts:5334

GetMotorTorque

GetMotorTorque(): number
Get the current motor torque, usually in N-m.

Returns number
Motor torque.
- Defined in typings/box2dweb.d.ts:5340

GetNext

GetNext(): b2Joint
Get the next joint the world joint list.

Returns b2Joint
Next joint.
Inherited from b2Joint.GetNext
- Defined in typings/box2dweb.d.ts:4242

GetReactionForce

GetReactionForce(inv_dt: number): b2Vec2
Get the reaction force on body2 at the joint anchor in N.
Parameters
- inv_dt: number
Returns b2Vec2
Reaction force in N.
Overrides b2Joint.GetReactionForce
- Defined in typings/box2dweb.d.ts:5347

GetReactionTorque

GetReactionTorque(inv_dt: number): number
Get the reaction torque on body 2 in N.
Parameters
- inv_dt: number
Returns number
Reaction torque in N.
Overrides b2Joint.GetReactionTorque
- Defined in typings/box2dweb.d.ts:5354

GetType

GetType(): number
Get the type of the concrete joint.

Returns number
Joint type.
Inherited from b2Joint.GetType
- Defined in typings/box2dweb.d.ts:4262

GetUpperLimit

GetUpperLimit(): number
Get the upper joint limit in radians.

Returns number
Upper limit.
- Defined in typings/box2dweb.d.ts:5360

GetUserData

GetUserData(): any
Get the user data pointer.

Returns any
User data. Cast to your data type.
Inherited from b2Joint.GetUserData
- Defined in typings/box2dweb.d.ts:4268

IsActive

IsActive(): boolean
Short-cut function to determine if either body is inactive.

Returns boolean
True if active, otherwise false.
Inherited from b2Joint.IsActive
- Defined in typings/box2dweb.d.ts:4274

IsLimitEnabled

IsLimitEnabled(): boolean
Is the joint limit enabled?

Returns boolean
True if enabled, false if disabled.
- Defined in typings/box2dweb.d.ts:5366

IsMotorEnabled

IsMotorEnabled(): boolean
Is the joint motor enabled?

Returns boolean
True if enabled, false if disabled.
- Defined in typings/box2dweb.d.ts:5372

SetLimits

SetLimits(lower: number, upper: number): void
Set the joint limits in radians.
Parameters
- lower: number
  New lower limit.
- upper: number
  New upper limit.
Returns void
- Defined in typings/box2dweb.d.ts:5379

SetMaxMotorTorque

SetMaxMotorTorque(torque: number): void
Set the maximum motor torque, usually in N-m.
Parameters
- torque: number
  New max torque.
Returns void
- Defined in typings/box2dweb.d.ts:5385

SetMotorSpeed

SetMotorSpeed(speed: number): void
Set the motor speed in radians per second.
Parameters
- speed: number
  New motor speed.
Returns void
- Defined in typings/box2dweb.d.ts:5391

SetUserData

SetUserData(data: any): void
Set the user data pointer.
Parameters
- data: any
  Your custom data.
Returns void
Inherited from b2Joint.SetUserData
- Defined in typings/box2dweb.d.ts:4280

Class b2RevoluteJoint

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Returns b2RevoluteJoint

Methods

EnableLimit

Parameters

Returns void

EnableMotor

Parameters

Returns void

GetAnchorA

Returns b2Vec2

GetAnchorB

Returns b2Vec2

GetBodyA

Returns b2Body

GetBodyB

Returns b2Body

GetJointAngle

Returns number

GetJointSpeed

Returns number

GetLowerLimit

Returns number

GetMotorSpeed

Returns number

GetMotorTorque

Returns number

GetNext

Returns b2Joint

GetReactionForce

Parameters

Returns b2Vec2

GetReactionTorque

Parameters

Returns number

GetType

Returns number

GetUpperLimit

Returns number

GetUserData

Returns any

IsActive

Returns boolean

IsLimitEnabled

Returns boolean

IsMotorEnabled

Returns boolean

SetLimits

Parameters

Returns void

SetMaxMotorTorque

Parameters

Returns void

SetMotorSpeed

Parameters

Returns void

SetUserData

Parameters

Returns void

Settings

On This Page