Difference between revisions of "B2.createPrismaticJointDef"

From GiderosMobile
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<languages />
 
<languages />
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/b2|b2]]<br/>
+
'''Class:''' [[Special:MyLanguage/b2|b2]]<br/>
=== <translate>Description</translate> ===
+
 
<translate><br />
+
=== Description ===
Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis.<br />
+
Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis.
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a prismatic joint).<br />
+
 
<br /></translate>
+
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a prismatic joint).
 
<source lang="lua">
 
<source lang="lua">
 
(table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
 
(table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
 
</source>
 
</source>
=== <translate>Parameters</translate> ===
+
 
'''bodyA''': (b2.Body) <translate>the first attached body</translate> <br/>
+
=== Parameters ===
'''bodyB''': (b2.Body) <translate>the second attached body</translate> <br/>
+
'''bodyA''': (b2.Body) the first attached body <br/>
'''anchorx''': (number) <translate>the x coordinate of the world anchor point</translate> <br/>
+
'''bodyB''': (b2.Body) the second attached body <br/>
'''anchory''': (number) <translate>the y coordinate of the world anchor point</translate> <br/>
+
'''anchorx''': (number) the x coordinate of the world anchor point <br/>
'''axisx''': (number) <translate>the x coordinate of the world axis</translate> <br/>
+
'''anchory''': (number) the y coordinate of the world anchor point <br/>
'''axisy''': (number) <translate>the y coordinate of the world axis</translate> <br/>
+
'''axisx''': (number) the x coordinate of the world axis <br/>
=== <translate>Return values</translate> ===
+
'''axisy''': (number) the y coordinate of the world axis <br/>
'''<translate>Returns</translate>''' (table) <translate>A new prismatic joint definition table</translate><br/>
+
 
=== <translate>Examples</translate> ===
+
=== Return values ===
'''Prismatic joint'''<br/>
+
'''Returns''' (table) A new prismatic joint definition table<br/>
<source lang="lua">--create empty box2d body for joint
+
 
 +
=== Examples ===
 +
<source lang="lua">
 +
--create empty box2d body for joint
 
local ground = world:createBody({})
 
local ground = world:createBody({})
 
ground:setPosition(465, 480)
 
ground:setPosition(465, 480)
  
--axisx, axisy values usually between 0 and 1
+
--axisx, axisy values usually between 0 and 1
--0 0 moves freely
+
--0 0 moves freely
--0 1 moves on y axis
+
--0 1 moves on y axis
--1 0 moves on x axis
+
--1 0 moves on x axis
--1 1 moves on diagonal
+
--1 1 moves on diagonal
 
local jointDef = b2.createPrismaticJointDef(body, ground, 350, 100, 0.3, 1)
 
local jointDef = b2.createPrismaticJointDef(body, ground, 350, 100, 0.3, 1)
local prismaticJoint = world:createJoint(jointDef)</source>
+
local prismaticJoint = world:createJoint(jointDef)
 +
</source>
 +
 
 +
{{B2}}

Revision as of 04:50, 17 February 2020


Available since: Gideros 2011.6
Class: b2

Description

Creates and returns a prismatic joint definition table with the bodies, anchors, axis, and reference angle using the world anchor and world axis.

(Please refer to b2.World:createJoint function for more information about all the information needed to create a prismatic joint).

(table) = b2.createPrismaticJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)

Parameters

bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
anchorx: (number) the x coordinate of the world anchor point
anchory: (number) the y coordinate of the world anchor point
axisx: (number) the x coordinate of the world axis
axisy: (number) the y coordinate of the world axis

Return values

Returns (table) A new prismatic joint definition table

Examples

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

--axisx, axisy values usually between 0 and 1
--0 0 moves freely
--0 1 moves on y axis
--1 0 moves on x axis
--1 1 moves on diagonal
local jointDef = b2.createPrismaticJointDef(body, ground, 350, 100, 0.3, 1)
local prismaticJoint = world:createJoint(jointDef)





LiquidFun