Difference between revisions of "B2.createWheelJointDef"

From GiderosMobile
Line 9: Line 9:
 
(table) = b2.createWheelJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
 
(table) = b2.createWheelJointDef(bodyA,bodyB,anchorx,anchory,axisx,axisy)
 
</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/>
'''anchorx''': (number) the x coordinate of the world anchor point ''''''<br/>
+
'''bodyB''': (b2.Body) the second attached body <br/>
'''anchory''': (number) the y coordinate of the world anchor point ''''''<br/>
+
'''anchorx''': (number) the x coordinate of the world anchor point <br/>
'''axisx''': (number) the x coordinate of the world translation axis in bodyA ''''''<br/>
+
'''anchory''': (number) the y coordinate of the world anchor point <br/>
'''axisy''': (number) the y coordinate of the world translation axis in bodyA ''''''<br/>
+
'''axisx''': (number) the x coordinate of the world translation axis in bodyA <br/>
 +
'''axisy''': (number) the y coordinate of the world translation axis in bodyA <br/>
 +
=== Return values ===
 
'''Returns''' (table) A new wheel joint definition table<br/>
 
'''Returns''' (table) A new wheel joint definition table<br/>
 +
=== Examples ===
 +
'''Wheel joint'''<br/>
 +
<source lang="lua">--create empty box2d body for joint
 +
local ground = world:createBody({})
 +
ground:setPosition(350, 480)
 +
 +
--axisx, axisy values usually between 0 and 1
 +
--0 0 moves freely
 +
--0 1 force pulling back on y axis
 +
--1 0 force pulling back on x axis
 +
--1 1 force pulling back all diretions
 +
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
 +
local wheelJoint = world:createJoint(jointDef)</source>

Revision as of 11:45, 23 August 2018

Available since: Gideros 2011.6

Description


Creates and returns a wheel joint definition table.
(Please refer to b2.World:createJoint function for more information about all the information needed to create a wheel joint).

(table) = b2.createWheelJointDef(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 translation axis in bodyA
axisy: (number) the y coordinate of the world translation axis in bodyA

Return values

Returns (table) A new wheel joint definition table

Examples

Wheel joint

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

--axisx, 	axisy	values usually between 0 and 1
--0			0		moves freely
--0			1		force pulling back on y axis
--1			0		force pulling back on x axis
--1			1		force pulling back all diretions
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
local wheelJoint = world:createJoint(jointDef)