Difference between revisions of "B2.createPulleyJointDef"

Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
+
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
=== Description ===
+
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
 
Creates and returns a pulley joint definition table with the bodies, anchors, lengths, max lengths, and ratio using the world anchors.<br />
 
Creates and returns a pulley joint definition table with the bodies, anchors, lengths, max lengths, and ratio using the world anchors.<br />
Line 9: Line 9:
 
(table) = b2.createPulleyJointDef(bodyA,bodyB,groundAnchorAx,groundAnchorAy,groundAnchorBx,groundAnchorBy,anchorAx,anchorAy,anchorBx,anchorBy,ratio)
 
(table) = b2.createPulleyJointDef(bodyA,bodyB,groundAnchorAx,groundAnchorAy,groundAnchorBx,groundAnchorBy,anchorAx,anchorAy,anchorBx,anchorBy,ratio)
 
</source>
 
</source>
=== Parameters ===
+
=== <translate>Parameters</translate> ===
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
 
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
 
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
Line 21: Line 21:
 
'''anchorBy''': (number) <translate>the y coordinate of the world anchor point of bodyB</translate> <br/>
 
'''anchorBy''': (number) <translate>the y coordinate of the world anchor point of bodyB</translate> <br/>
 
'''ratio''': (number) <translate>the pulley ratio, used to simulate a block-and-tackle</translate> <br/>
 
'''ratio''': (number) <translate>the pulley ratio, used to simulate a block-and-tackle</translate> <br/>
=== Return values ===
+
=== <translate>Return values</translate> ===
'''Returns''' (table) <translate>A new pulley joint definition table</translate><br/>
+
'''<translate>Returns</translate>''' (table) <translate>A new pulley joint definition table</translate><br/>
=== Examples ===
+
=== <translate>Examples</translate> ===
 
'''Pulley joint'''<br/>
 
'''Pulley joint'''<br/>
 
<source lang="lua">--create empty box2d body for joint
 
<source lang="lua">--create empty box2d body for joint

Revision as of 08:30, 24 August 2018

Available since: Gideros 2011.6

Description


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

(table) = b2.createPulleyJointDef(bodyA,bodyB,groundAnchorAx,groundAnchorAy,groundAnchorBx,groundAnchorBy,anchorAx,anchorAy,anchorBx,anchorBy,ratio)

Parameters

bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
groundAnchorAx: (number) the x coordinate of the first ground anchor in world coordinates. This point never moves.
groundAnchorAy: (number) the y coordinate of the first ground anchor in world coordinates. This point never moves.
groundAnchorBx: (number) the x coordinate of the second ground anchor in world coordinates. This point never moves.
groundAnchorBy: (number) the y coordinate of the second ground anchor in world coordinates. This point never moves.
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
ratio: (number) the pulley ratio, used to simulate a block-and-tackle

Return values

Returns (table) A new pulley joint definition table

Examples

Pulley joint

--create empty box2d body for joint
local ground = world:createBody({})

local jointDef = b2.createPulleyJointDef(body1, body2, 
	200, 100, --coordinates where "imaginary string" is attached in the air for body 1
	350, 100, --coordinates where "imaginary string" is attached in the air for body 2
	200, 300, --coordinates where "imaginary string" is attached to the body 1
	350, 300, --coordinates where "imaginary string" is attached in the body 2
	1) -- ratio (if < 1 -> makes body 2 heavier, > 1 makes body 1 heavier, =1 makes them equal
local pulleyJoint = world:createJoint(jointDef)