Skip to content

Latest commit

 

History

History
112 lines (84 loc) · 2.61 KB

MouseJoint.md

File metadata and controls

112 lines (84 loc) · 2.61 KB
Raw

MouseJoint

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 documented in the manual because it was developed to be used in the testbed. If you want to learn how to use the mouse joint, look at the testbed.

Constructor

Box2dWorld:CreateJoint(def)

Create a joint to constrain bodies together. This may cause the connected bodies to cease colliding. Warning: This function is locked during callbacks.

PARAMETERS

RETURN

JointDef

Mouse joint definition. This requires a world target point, tuning parameters, and the time step.

local Box2dMouseJointDef = {
    --region JointNeeded
    --endregion

    --region JointOptional
    The linear stiffness in N/m
    stiffness = 0,

    The linear damping in N*s/m
    damping = 0,

    The initial world target point. This is assumed
    to coincide with the body anchor initially.
    target = vmath.vector3(0),

    The maximum constraint force that can be exerted
    to move the candidate body. Usually you will express
    as some multiple of the weight (multiplier * mass * gravity).
    maxForce = 0
    --endregion
}

Methods

Box2dMouseJoint:SetTarget(target)

Use this to update the target point.

PARAMETERS

  • target (vector3) -

Box2dMouseJoint:GetTarget()

RETURN

  • (vector3)

Box2dMouseJoint:SetMaxForce(force)

Set/get the maximum force in Newtons.

PARAMETERS

  • force (number) -

Box2dMouseJoint:GetMaxForce()

RETURN

  • (number)

Box2dMouseJoint:SetStiffness(stiffness)

Set/get the linear stiffness in N/m

PARAMETERS

  • stiffness (number) -

Box2dMouseJoint:GetStiffness()

RETURN

  • (number)

Box2dMouseJoint:SetDamping(damping)

Set/get linear damping in N*s/m

PARAMETERS

  • damping (number) -

Box2dMouseJoint:GetDamping()

RETURN

  • (number)