Class b2MouseJoint

A mouse joint is used to make a point on a body track a specified world point. This a soft constraint with a maximum force. This allows the constraint to stretch and without applying huge forces. Note: this joint is not fully documented as it is intended primarily for the testbed. See that for more instructions.

Hierarchy (View Summary)

b2Joint
- b2MouseJoint

Constructors

constructor

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

Methods

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:4858

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:4864

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

GetDampingRatio

GetDampingRatio(): number
Gets the damping ratio.

Returns number
Damping ratio.
- Defined in typings/box2dweb.d.ts:4870

GetFrequency

GetFrequency(): number
Gets the frequency.

Returns number
Frequency.
- Defined in typings/box2dweb.d.ts:4876

GetMaxForce

GetMaxForce(): number
Gets the max force.

Returns number
Max force.
- Defined in typings/box2dweb.d.ts:4882

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:4889

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:4896

GetTarget

GetTarget(): b2Vec2
Gets the target.

Returns b2Vec2
Target.
- Defined in typings/box2dweb.d.ts:4902

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

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

SetDampingRatio

SetDampingRatio(ratio: number): void
Sets the damping ratio.
Parameters
- ratio: number
  New damping ratio.
Returns void
- Defined in typings/box2dweb.d.ts:4908

SetFrequency

SetFrequency(hz: number): void
Sets the frequency.
Parameters
- hz: number
  New frequency (hertz).
Returns void
- Defined in typings/box2dweb.d.ts:4914

SetMaxForce

SetMaxForce(maxForce: number): void
Sets the max force.
Parameters
- maxForce: number
  New max force.
Returns void
- Defined in typings/box2dweb.d.ts:4920

SetTarget

SetTarget(target: b2Vec2): void
Use this to update the target point.
Parameters
- target: b2Vec2
  New target.
Returns void
- Defined in typings/box2dweb.d.ts:4926

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