B2.createPulleyJointDef: Difference between revisions
No edit summary |
m Text replacement - "</source>" to "</syntaxhighlight>" |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
<languages /> | |||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
'''Class:''' [[Special:MyLanguage/b2|b2]]<br/> | |||
=== Description === | === Description === | ||
Creates and returns a pulley joint definition table with the bodies, anchors, lengths, max lengths, and ratio using the world anchors. | |||
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). | (Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a pulley joint). | ||
<syntaxhighlight lang="lua"> | |||
< | |||
(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) | ||
</ | </syntaxhighlight> | ||
'''bodyA''': (b2.Body) the first attached body | |||
'''bodyB''': (b2.Body) the second attached body | === Parameters === | ||
'''groundAnchorAx''': (number) the x coordinate of the first ground anchor in world coordinates. This point never moves. | '''bodyA''': (b2.Body) the first attached body <br/> | ||
'''groundAnchorAy''': (number) the y coordinate of the first ground anchor in world coordinates. This point never moves. | '''bodyB''': (b2.Body) the second attached body <br/> | ||
'''groundAnchorBx''': (number) the x coordinate of the second ground anchor in world coordinates. This point never moves. | '''groundAnchorAx''': (number) the x coordinate of the first ground anchor in world coordinates. This point never moves. <br/> | ||
'''groundAnchorBy''': (number) the y coordinate of the second 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. <br/> | ||
'''anchorAx''': (number) the x coordinate of the world anchor point of bodyA | '''groundAnchorBx''': (number) the x coordinate of the second ground anchor in world coordinates. This point never moves. <br/> | ||
'''anchorAy''': (number) the y coordinate of the world anchor point of bodyA | '''groundAnchorBy''': (number) the y coordinate of the second ground anchor in world coordinates. This point never moves. <br/> | ||
'''anchorBx''': (number) the x coordinate of the world anchor point of bodyB | '''anchorAx''': (number) the x coordinate of the world anchor point of bodyA <br/> | ||
'''anchorBy''': (number) the y coordinate of the world anchor point of bodyB | '''anchorAy''': (number) the y coordinate of the world anchor point of bodyA <br/> | ||
'''ratio''': (number) the pulley ratio, used to simulate a block-and-tackle | '''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/> | |||
'''ratio''': (number) the pulley ratio, used to simulate a block-and-tackle <br/> | |||
=== Return values === | |||
'''Returns''' (table) A new pulley joint definition table<br/> | '''Returns''' (table) A new pulley joint definition table<br/> | ||
=== Examples === | |||
'''Pulley joint''' | |||
<syntaxhighlight lang="lua"> | |||
--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) | |||
</syntaxhighlight> | |||
{{B2}} | |||
Latest revision as of 13:26, 13 July 2023
Available since: Gideros 2011.6
Class: b2
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)