Difference between revisions of "B2.createDistanceJointDef"

m
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
=== <translate>Description</translate> ===
+
'''Class:''' [[b2]]<br/>
<translate><br />
+
 
Creates and returns a distance joint definition table with the bodies, anchors, and length using the world anchors.<br />
+
=== Description ===
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a distance joint).<br />
+
Creates and returns a distance joint definition table with the bodies, anchors, and length using the world anchors.
<br /></translate>
+
 
 +
(Please refer to [[b2.World:createJoint]] function for more information about all the information needed to create a distance joint).
 
<source lang="lua">
 
<source lang="lua">
 
(table) = b2.createDistanceJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy)
 
(table) = b2.createDistanceJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy)
 
</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/>
'''anchorAx''': (number) <translate>the x coordinate of the world anchor point of bodyA</translate> <br/>
+
'''bodyB''': (b2.Body) the second attached body<br/>
'''anchorAy''': (number) <translate>the y coordinate of the world anchor point of bodyA</translate> <br/>
+
'''anchorAx''': (number) the x coordinate of the world anchor point of bodyA<br/>
'''anchorBx''': (number) <translate>the x coordinate of the world anchor point of bodyB</translate> <br/>
+
'''anchorAy''': (number) the y coordinate of the world anchor point of bodyA<br/>
'''anchorBy''': (number) <translate>the y coordinate of the world anchor point of bodyB</translate> <br/>
+
'''anchorBx''': (number) the x coordinate of the world anchor point of bodyB<br/>
=== <translate>Return values</translate> ===
+
'''anchorBy''': (number) the y coordinate of the world anchor point of bodyB<br/>
'''<translate>Returns</translate>''' (table) <translate>A new distance joint definition table</translate><br/>
+
 
=== <translate>Examples</translate> ===
+
=== Return values ===
'''Distance joint'''<br/>
+
'''Returns''' (table) a new distance joint definition table<br/>
<source lang="lua">local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100)
+
 
 +
=== Example ===
 +
<source lang="lua">
 +
local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100)
 
local distanceJoint = world:createJoint(jointDef)
 
local distanceJoint = world:createJoint(jointDef)
--by default length between two bodies is the length they have between them when joint was created
+
--by default length between two bodies is the length they have between them when joint was created but it is possible to change it using:
--but it is possilbe to change it using
 
 
distanceJoint:setLength(200)
 
distanceJoint:setLength(200)
 
distanceJoint:setDampingRatio(0.5)
 
distanceJoint:setDampingRatio(0.5)
distanceJoint:setFrequency(4)</source>
+
distanceJoint:setFrequency(4)
 +
</source>
 +
 
 +
{{B2}}

Latest revision as of 07:13, 9 January 2022

Available since: Gideros 2011.6
Class: b2

Description

Creates and returns a distance joint definition table with the bodies, anchors, and length using the world anchors.

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

(table) = b2.createDistanceJointDef(bodyA,bodyB,anchorAx,anchorAy,anchorBx,anchorBy)

Parameters

bodyA: (b2.Body) the first attached body
bodyB: (b2.Body) the second attached body
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

Return values

Returns (table) a new distance joint definition table

Example

local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100)
local distanceJoint = world:createJoint(jointDef)
--by default length between two bodies is the length they have between them when joint was created but it is possible to change it using:
distanceJoint:setLength(200)
distanceJoint:setDampingRatio(0.5)
distanceJoint:setFrequency(4)





LiquidFun