Difference between revisions of "B2.createPulleyJointDef"
From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === <br /> Creates and returns a pulley joint definition table with the bodies, anchors, lengths, max leng...") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (8 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) | + | </syntaxhighlight> |
| − | </ | + | |
| − | '''bodyA | + | === Parameters === |
| − | '''bodyB | + | '''bodyA''': (b2.Body) the first attached body <br/> |
| − | '''groundAnchorAx | + | '''bodyB''': (b2.Body) the second attached body <br/> |
| − | '''groundAnchorAy | + | '''groundAnchorAx''': (number) the x coordinate of the first ground anchor in world coordinates. This point never moves. <br/> |
| − | '''groundAnchorBx | + | '''groundAnchorAy''': (number) the y coordinate of the first ground anchor in world coordinates. This point never moves. <br/> |
| − | '''groundAnchorBy | + | '''groundAnchorBx''': (number) the x coordinate of the second ground anchor in world coordinates. This point never moves. <br/> |
| − | '''anchorAx | + | '''groundAnchorBy''': (number) the y coordinate of the second ground anchor in world coordinates. This point never moves. <br/> |
| − | '''anchorAy | + | '''anchorAx''': (number) the x coordinate of the world anchor point of bodyA <br/> |
| − | '''anchorBx | + | '''anchorAy''': (number) the y coordinate of the world anchor point of bodyA <br/> |
| − | '''anchorBy | + | '''anchorBx''': (number) the x coordinate of the world anchor point of bodyB <br/> |
| − | '''ratio | + | '''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 14: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)
