Difference between revisions of "B2.DistanceJoint"

From GiderosMobile
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<!-- GIDEROSOBJ:b2.DistanceJoint -->
 
<!-- GIDEROSOBJ:b2.DistanceJoint -->
'''<translate>Supported platforms</translate>:''' [[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/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/b2.Joint|b2.Joint]]<br/>
+
'''Inherits from:''' [[b2.Joint]]<br/>
=== <translate>Description</translate> ===
+
 
<translate><br />
+
=== 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. <br />
+
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.
<br /></translate>
+
 
=== <translate>Examples</translate> ===
+
=== Examples ===
'''Distance joint'''<br/>
+
'''Distance joint'''
<source lang="lua">local jointDef = b2.createDistanceJointDef(body1, body2, 100, 100, 200, 100)
+
<syntaxhighlight 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 possilbe 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)
 +
</syntaxhighlight>
 +
 
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== <translate>Methods</translate> ===
+
=== Methods ===
[[Special:MyLanguage/b2.DistanceJoint:getDampingRatio|b2.DistanceJoint:getDampingRatio]] ''<translate>returns the damping ratio</translate>''<br/><!-- GIDEROSMTD:b2.DistanceJoint:getDampingRatio -->
+
[[b2.DistanceJoint:getDampingRatio]] ''returns the damping ratio''<br/><!--GIDEROSMTD:b2.DistanceJoint:getDampingRatio() returns the damping ratio-->
[[Special:MyLanguage/b2.DistanceJoint:getFrequency|b2.DistanceJoint:getFrequency]] ''<translate>returns the mass-spring-damper frequency in Hertz</translate>''<br/><!-- GIDEROSMTD:b2.DistanceJoint:getFrequency -->
+
[[b2.DistanceJoint:getFrequency]] ''returns the mass-spring-damper frequency in Hertz''<br/><!--GIDEROSMTD:b2.DistanceJoint:getFrequency() returns the mass-spring-damper frequency in Hertz-->
[[Special:MyLanguage/b2.DistanceJoint:getLength|b2.DistanceJoint:getLength]] ''<translate>returns the length of this distance joint in meters</translate>''<br/><!-- GIDEROSMTD:b2.DistanceJoint:getLength -->
+
[[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-->
[[Special:MyLanguage/b2.DistanceJoint:setDampingRatio|b2.DistanceJoint:setDampingRatio]] ''<translate>sets the damping ratio (0 = no damping, 1 = critical damping)</translate>''<br/><!-- GIDEROSMTD:b2.DistanceJoint:setDampingRatio -->
+
[[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)-->
[[Special:MyLanguage/b2.DistanceJoint:setFrequency|b2.DistanceJoint:setFrequency]] ''<translate>sets the mass-spring-damper frequency in Hertz</translate>''<br/><!-- GIDEROSMTD:b2.DistanceJoint:setFrequency -->
+
[[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-->
[[Special:MyLanguage/b2.DistanceJoint:setLength|b2.DistanceJoint:setLength]] ''<translate>sets the natural joint length in meters</translate>''<br/><!-- GIDEROSMTD:b2.DistanceJoint:setLength -->
+
[[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;"|
=== <translate>Events</translate> ===
+
=== Events ===
=== <translate>Constants</translate> ===
+
=== Constants ===
 
|}
 
|}
 +
 +
----
 +
*'''[[B2.Joint]]'''
 +
*'''[[LiquidFun]]'''

Latest revision as of 01:53, 1 December 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
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)

Methods

b2.DistanceJoint:getDampingRatio returns the damping ratio
b2.DistanceJoint:getFrequency returns the mass-spring-damper frequency in Hertz
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)
b2.DistanceJoint:setFrequency sets the mass-spring-damper frequency in Hertz
b2.DistanceJoint:setLength sets the natural joint length in meters

Events

Constants