Difference between revisions of "B2.DistanceJoint"
From GiderosMobile
m (Text replacement - "</source" to "</syntaxhighlight") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
<!-- GIDEROSOBJ:b2.DistanceJoint --> | <!-- GIDEROSOBJ:b2.DistanceJoint --> | ||
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/> | '''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/> | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| − | '''Inherits from:''' [[ | + | '''Inherits from:''' [[b2.Joint]]<br/> |
=== Description === | === Description === | ||
| Line 11: | Line 10: | ||
=== Examples === | === Examples === | ||
'''Distance joint''' | '''Distance joint''' | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100) | local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100) | ||
local distanceJoint = world:createJoint(jointDef) | local distanceJoint = world:createJoint(jointDef) | ||
| Line 23: | Line 22: | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
=== Methods === | === Methods === | ||
| − | [[ | + | [[b2.DistanceJoint:getDampingRatio]] ''returns the damping ratio''<br/><!--GIDEROSMTD:b2.DistanceJoint:getDampingRatio() returns the damping ratio--> |
| − | [[ | + | [[b2.DistanceJoint:getFrequency]] ''returns the mass-spring-damper frequency in Hertz''<br/><!--GIDEROSMTD:b2.DistanceJoint:getFrequency() returns the mass-spring-damper frequency in Hertz--> |
| − | [[ | + | [[b2.DistanceJoint:getLength]] ''returns the length of this distance joint in meters''<br/><!--GIDEROSMTD:b2.DistanceJoint:getLength() returns the length of this distance joint in meters--> |
| − | [[ | + | [[b2.DistanceJoint:setDampingRatio]] ''sets the damping ratio (0 = no damping, 1 = critical damping)''<br/><!--GIDEROSMTD:b2.DistanceJoint:setDampingRatio(ratio) sets the damping ratio (0 = no damping, 1 = critical damping)--> |
| − | [[ | + | [[b2.DistanceJoint:setFrequency]] ''sets the mass-spring-damper frequency in Hertz''<br/><!--GIDEROSMTD:b2.DistanceJoint:setFrequency(frequency) sets the mass-spring-damper frequency in Hertz--> |
| − | [[ | + | [[b2.DistanceJoint:setLength]] ''sets the natural joint length in meters''<br/><!--GIDEROSMTD:b2.DistanceJoint:setLength(length) sets the natural joint length in meters--> |
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
Latest revision as of 01:53, 1 December 2023
Supported platforms: 
Available since: Gideros 2011.6
Inherits from: b2.Joint
Description
A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod.
Examples
Distance joint
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 possilbe to change it using
distanceJoint:setLength(200)
distanceJoint:setDampingRatio(0.5)
distanceJoint:setFrequency(4)
Methodsb2.DistanceJoint:getDampingRatio returns the damping ratio |
EventsConstants |
