Difference between revisions of "B2.createDistanceJointDef"

Line 9: Line 9:
 
(table) = b2.createDistanceJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy)
 
(table) = b2.createDistanceJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy)
 
</source>
 
</source>
'''bodyA''': (b2.Body) the first attached body ''''''<br/>
+
=== Parameters ===
'''bodyB''': (b2.Body) the second attached body ''''''<br/>
+
'''bodyA''': (b2.Body) the first attached body <br/>
'''anchorAx''': (number) the x coordinate of the world anchor point of bodyA ''''''<br/>
+
'''bodyB''': (b2.Body) the second attached body <br/>
'''anchorAy''': (number) the y coordinate of the world anchor point of bodyA ''''''<br/>
+
'''anchorAx''': (number) the x coordinate of the world anchor point of bodyA <br/>
'''anchorBx''': (number) the x coordinate of the world anchor point of bodyB ''''''<br/>
+
'''anchorAy''': (number) the y coordinate of the world anchor point of bodyA <br/>
'''anchorBy''': (number) the y coordinate of the world anchor point of bodyB ''''''<br/>
+
'''anchorBx''': (number) the x coordinate of the world anchor point of bodyB <br/>
 +
'''anchorBy''': (number) the y coordinate of the world anchor point of bodyB <br/>
 +
=== Return values ===
 
'''Returns''' (table) A new distance joint definition table<br/>
 
'''Returns''' (table) A new distance joint definition table<br/>
 +
=== Examples ===
 +
'''Distance joint'''<br/>
 +
<source lang="lua">local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100)
 +
local distanceJoint = world:createJoint(jointDef)
 +
--by default length between two bodies is the length they have between them when joint was created
 +
--but it is possilbe to change it using
 +
distanceJoint:setLength(200)
 +
distanceJoint:setDampingRatio(0.5)
 +
distanceJoint:setFrequency(4)</source>

Revision as of 11:40, 23 August 2018

Available since: Gideros 2011.6

Description


Creates and returns a distance joint definition table with the bodies, anchors, and length using the world anchors.
(Please refer to b2.World:createJoint function for more information about all the information needed to create a distance joint).

(table) = b2.createDistanceJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy)

Parameters

bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
anchorAx: (number) the x coordinate of the world anchor point of bodyA
anchorAy: (number) the y coordinate of the world anchor point of bodyA
anchorBx: (number) the x coordinate of the world anchor point of bodyB
anchorBy: (number) the y coordinate of the world anchor point of bodyB

Return values

Returns (table) A new distance joint definition table

Examples

Distance joint

local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100)
local distanceJoint = world:createJoint(jointDef)
--by default length between two bodies is the length they have between them when joint was created
--but it is possilbe to change it using
distanceJoint:setLength(200)
distanceJoint:setDampingRatio(0.5)
distanceJoint:setFrequency(4)