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

Index

Methods

Methods

public GetAnchorA(): b2Vec2

Get the anchor point on bodyA in world coordinates.

Returns

b2Vec2

Body A anchor.

public GetAnchorB(): b2Vec2

Get the anchor point on bodyB in world coordinates.

Returns

b2Vec2

Body B anchor.

public GetBodyA(): b2Body

Get the first body attached to this joint.

Returns

b2Body

Body A.

public GetBodyB(): b2Body

Get the second body attached to this joint.

Returns

b2Body

Body B.

public GetDampingRatio(): number

Gets the damping ratio.

Returns

number

Damping ratio.

public GetFrequency(): number

Gets the frequency.

Returns

number

Frequency.

public GetMaxForce(): number

Gets the max force.

Returns

number

Max force.

public GetNext(): b2Joint

Get the next joint the world joint list.

Returns

b2Joint

Next joint.

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

public GetReactionTorque(inv_dt: number): number

Get the reaction torque on body 2 in N.

Parameters

  • inv_dt: number

Returns

number

Reaction torque in N.

public GetTarget(): b2Vec2

Gets the target.

Returns

b2Vec2

Target.

public GetType(): number

Get the type of the concrete joint.

Returns

number

Joint type.

public GetUserData(): any

Get the user data pointer.

Returns

any

User data. Cast to your data type.

public IsActive(): boolean

Short-cut function to determine if either body is inactive.

Returns

boolean

True if active, otherwise false.

public SetDampingRatio(ratio: number)

Sets the damping ratio.

Parameters

  • ratio: number

    New damping ratio.

public SetFrequency(hz: number)

Sets the frequency.

Parameters

  • hz: number

    New frequency (hertz).

public SetMaxForce(maxForce: number)

Sets the max force.

Parameters

  • maxForce: number

    New max force.

public SetTarget(target: b2Vec2)

Use this to update the target point.

Parameters

public SetUserData(data: any)

Set the user data pointer.

Parameters

  • data: any

    Your custom data.