B2.FrictionJoint: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<languages />
<!-- GIDEROSOBJ:b2.FrictionJoint -->
<!-- GIDEROSOBJ:b2.FrictionJoint -->
'''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:''' [[Special:MyLanguage/b2.Joint|b2.Joint]]<br/>
'''Inherits from:''' [[b2.Joint]]<br/>


=== Description ===
=== Description ===
Line 11: Line 10:
=== Examples ===
=== Examples ===
'''Friction joint'''
'''Friction joint'''
<source lang="lua">
<syntaxhighlight lang="lua">
--create empty box2d body for joint
--create empty box2d body for joint
local ground = world:createBody({})
local ground = world:createBody({})
Line 22: Line 21:
--set maximum friction force to slow down the ball
--set maximum friction force to slow down the ball
frictionJoint:setMaxForce(100)
frictionJoint:setMaxForce(100)
</source>
</syntaxhighlight>


{|-
{|-
| style="width: 50%; vertical-align:top;"|
| style="width: 50%; vertical-align:top;"|
=== Methods ===
=== Methods ===
[[Special:MyLanguage/b2.FrictionJoint:getMaxForce|b2.FrictionJoint:getMaxForce]] ''returns the maximum friction force in N''<br/><!-- GIDEROSMTD:b2.FrictionJoint:getMaxForce() returns the maximum friction force in N -->
[[b2.FrictionJoint:getMaxForce]] ''returns the maximum friction force in N''<br/><!--GIDEROSMTD:b2.FrictionJoint:getMaxForce() returns the maximum friction force in N-->
[[Special:MyLanguage/b2.FrictionJoint:getMaxTorque|b2.FrictionJoint:getMaxTorque]] ''returns the maximum friction torque in N*m''<br/><!-- GIDEROSMTD:b2.FrictionJoint:getMaxTorque() returns the maximum friction torque in N*m -->
[[b2.FrictionJoint:getMaxTorque]] ''returns the maximum friction torque in N*m''<br/><!--GIDEROSMTD:b2.FrictionJoint:getMaxTorque() returns the maximum friction torque in N*m-->
[[Special:MyLanguage/b2.FrictionJoint:setMaxForce|b2.FrictionJoint:setMaxForce]] ''sets the maximum friction force in N''<br/><!-- GIDEROSMTD:b2.FrictionJoint:setMaxForce(force) sets the maximum friction force in N -->
[[b2.FrictionJoint:setMaxForce]] ''sets the maximum friction force in N''<br/><!--GIDEROSMTD:b2.FrictionJoint:setMaxForce(force) sets the maximum friction force in N-->
[[Special:MyLanguage/b2.FrictionJoint:setMaxTorque|b2.FrictionJoint:setMaxTorque]] ''sets the maximum friction torque in N*m''<br/><!-- GIDEROSMTD:b2.FrictionJoint:setMaxTorque(torque) sets the maximum friction torque in N*m -->
[[b2.FrictionJoint:setMaxTorque]] ''sets the maximum friction torque in N*m''<br/><!--GIDEROSMTD:b2.FrictionJoint:setMaxTorque(torque) sets the maximum friction torque in N*m-->


| style="width: 50%; vertical-align:top;"|
| style="width: 50%; vertical-align:top;"|

Latest revision as of 00:54, 1 December 2023

Supported platforms:
Available since: Gideros 2011.6
Inherits from: b2.Joint

Description

Friction joint. This is used for top-down friction. It provides 2D translational friction and angular friction.

Examples

Friction joint

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

--create friction joint
local jointDef = b2.createFrictionJointDef(body, ground, 350, 200)
local frictionJoint = world:createJoint(jointDef)

--set maximum friction force to slow down the ball
frictionJoint:setMaxForce(100)

Methods

b2.FrictionJoint:getMaxForce returns the maximum friction force in N
b2.FrictionJoint:getMaxTorque returns the maximum friction torque in N*m
b2.FrictionJoint:setMaxForce sets the maximum friction force in N
b2.FrictionJoint:setMaxTorque sets the maximum friction torque in N*m

Events

Constants