B2.RevoluteJoint: Difference between revisions

From GiderosMobile
No edit summary
m Text replacement - "</source" to "</syntaxhighlight"
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<languages />
<!-- GIDEROSOBJ:b2.RevoluteJoint -->
<!-- GIDEROSOBJ:b2.RevoluteJoint -->
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]]<br/>
'''<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/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/b2.Joint|b2.Joint]]<br/>
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/b2.Joint|b2.Joint]]<br/>
=== <translate>Description</translate> ===
=== <translate>Description</translate> ===
<translate><br />
A revolute joint constrains two bodies to share a common point while they are free to rotate about the point. The relative rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is provided so that infinite forces are not generated.
A revolute joint constrains two bodies to share a common point while they are free to rotate about the point. The relative rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is provided so that infinite forces are not generated. <br />
 
<br /></translate>
=== <translate>Examples</translate> ===
=== <translate>Examples</translate> ===
'''Revolute joint'''<br/>
'''Revolute joint'''
<source lang="lua">--create empty box2d body for joint
<syntaxhighlight lang="lua">
--create empty box2d body for joint
local ground = world:createBody({})
local ground = world:createBody({})
ground:setPosition(300, 480)
ground:setPosition(300, 480)
Line 18: Line 20:
--will not let ball spin for ever
--will not let ball spin for ever
revoluteJoint:setMaxMotorTorque(1)
revoluteJoint:setMaxMotorTorque(1)
revoluteJoint:enableMotor(true)</source>
revoluteJoint:enableMotor(true)
</syntaxhighlight>
 
{|-
{|-
| style="width: 50%; vertical-align:top;"|
| style="width: 50%; vertical-align:top;"|
=== <translate>Methods</translate> ===
=== <translate>Methods</translate> ===
[[Special:MyLanguage/b2.RevoluteJoint:enableLimit|b2.RevoluteJoint:enableLimit]] ''<translate>enables or disables the joint limit</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:enableLimit -->
[[Special:MyLanguage/b2.RevoluteJoint:enableLimit|b2.RevoluteJoint:enableLimit]] ''<translate>enables or disables the joint limit</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:enableLimit(flag) enables or disables the joint limit -->
[[Special:MyLanguage/b2.RevoluteJoint:enableMotor|b2.RevoluteJoint:enableMotor]] ''<translate>enables or disables the joint motor</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:enableMotor -->
[[Special:MyLanguage/b2.RevoluteJoint:enableMotor|b2.RevoluteJoint:enableMotor]] ''<translate>enables or disables the joint motor</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:enableMotor(flag) enables or disables the joint motor -->
[[Special:MyLanguage/b2.RevoluteJoint:getJointAngle|b2.RevoluteJoint:getJointAngle]] ''<translate>returns the current joint angle in radians</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getJointAngle -->
[[Special:MyLanguage/b2.RevoluteJoint:getJointAngle|b2.RevoluteJoint:getJointAngle]] ''<translate>returns the current joint angle in radians</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getJointAngle() returns the current joint angle in radians -->
[[Special:MyLanguage/b2.RevoluteJoint:getJointSpeed|b2.RevoluteJoint:getJointSpeed]] ''<translate>returns the current joint angle speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getJointSpeed -->
[[Special:MyLanguage/b2.RevoluteJoint:getJointSpeed|b2.RevoluteJoint:getJointSpeed]] ''<translate>returns the current joint angle speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getJointSpeed() returns the current joint angle speed in radians per second -->
[[Special:MyLanguage/b2.RevoluteJoint:getLimits|b2.RevoluteJoint:getLimits]] ''<translate>returns the lower and upper joint limit in radians</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getLimits -->
[[Special:MyLanguage/b2.RevoluteJoint:getLimits|b2.RevoluteJoint:getLimits]] ''<translate>returns the lower and upper joint limit in radians</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getLimits() returns the lower and upper joint limit in radians -->
[[Special:MyLanguage/b2.RevoluteJoint:getMotorSpeed|b2.RevoluteJoint:getMotorSpeed]] ''<translate>returns the motor speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getMotorSpeed -->
[[Special:MyLanguage/b2.RevoluteJoint:getMotorSpeed|b2.RevoluteJoint:getMotorSpeed]] ''<translate>returns the motor speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getMotorSpeed() returns the motor speed in radians per second -->
[[Special:MyLanguage/b2.RevoluteJoint:getMotorTorque|b2.RevoluteJoint:getMotorTorque]] ''<translate>returns the current motor torque given the inverse time step</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getMotorTorque -->
[[Special:MyLanguage/b2.RevoluteJoint:getMotorTorque|b2.RevoluteJoint:getMotorTorque]] ''<translate>returns the current motor torque given the inverse time step</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:getMotorTorque(inv_dt) returns the current motor torque given the inverse time step -->
[[Special:MyLanguage/b2.RevoluteJoint:isLimitEnabled|b2.RevoluteJoint:isLimitEnabled]] ''<translate>is the joint limit enabled?</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:isLimitEnabled -->
[[Special:MyLanguage/b2.RevoluteJoint:isLimitEnabled|b2.RevoluteJoint:isLimitEnabled]] ''<translate>is the joint limit enabled?</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:isLimitEnabled() is the joint limit enabled? -->
[[Special:MyLanguage/b2.RevoluteJoint:isMotorEnabled|b2.RevoluteJoint:isMotorEnabled]] ''<translate>is the joint motor enabled?</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:isMotorEnabled -->
[[Special:MyLanguage/b2.RevoluteJoint:isMotorEnabled|b2.RevoluteJoint:isMotorEnabled]] ''<translate>is the joint motor enabled?</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:isMotorEnabled() is the joint motor enabled? -->
[[Special:MyLanguage/b2.RevoluteJoint:setLimits|b2.RevoluteJoint:setLimits]] ''<translate>sets the joint limits in radians</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:setLimits -->
[[Special:MyLanguage/b2.RevoluteJoint:setLimits|b2.RevoluteJoint:setLimits]] ''<translate>sets the joint limits in radians</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:setLimits(lower,upper) sets the joint limits in radians -->
[[Special:MyLanguage/b2.RevoluteJoint:setMaxMotorTorque|b2.RevoluteJoint:setMaxMotorTorque]] ''<translate>sets the maximum motor torque in N*m</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:setMaxMotorTorque -->
[[Special:MyLanguage/b2.RevoluteJoint:setMaxMotorTorque|b2.RevoluteJoint:setMaxMotorTorque]] ''<translate>sets the maximum motor torque in N*m</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:setMaxMotorTorque(torque) sets the maximum motor torque in N*m -->
[[Special:MyLanguage/b2.RevoluteJoint:setMotorSpeed|b2.RevoluteJoint:setMotorSpeed]] ''<translate>sets the motor speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:setMotorSpeed -->
[[Special:MyLanguage/b2.RevoluteJoint:setMotorSpeed|b2.RevoluteJoint:setMotorSpeed]] ''<translate>sets the motor speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.RevoluteJoint:setMotorSpeed(speed) sets the motor speed in radians per second -->
 
| style="width: 50%; vertical-align:top;"|
| style="width: 50%; vertical-align:top;"|
=== <translate>Events</translate> ===
=== <translate>Events</translate> ===
=== <translate>Constants</translate> ===
=== <translate>Constants</translate> ===
|}
|}
----
*'''[[B2.Joint]]'''
*'''[[LiquidFun]]'''

Latest revision as of 15:51, 12 July 2023


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

Description

A revolute joint constrains two bodies to share a common point while they are free to rotate about the point. The relative rotation about the shared point is the joint angle. You can limit the relative rotation with a joint limit that specifies a lower and upper angle. You can use a motor to drive the relative rotation about the shared point. A maximum motor torque is provided so that infinite forces are not generated.

Examples

Revolute joint

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

local jointDef = b2.createRevoluteJointDef(body, ground, 300, 300)
local revoluteJoint = world:createJoint(jointDef)
--will not let ball spin for ever
revoluteJoint:setMaxMotorTorque(1)
revoluteJoint:enableMotor(true)

Methods

b2.RevoluteJoint:enableLimit enables or disables the joint limit
b2.RevoluteJoint:enableMotor enables or disables the joint motor
b2.RevoluteJoint:getJointAngle returns the current joint angle in radians
b2.RevoluteJoint:getJointSpeed returns the current joint angle speed in radians per second
b2.RevoluteJoint:getLimits returns the lower and upper joint limit in radians
b2.RevoluteJoint:getMotorSpeed returns the motor speed in radians per second
b2.RevoluteJoint:getMotorTorque returns the current motor torque given the inverse time step
b2.RevoluteJoint:isLimitEnabled is the joint limit enabled?
b2.RevoluteJoint:isMotorEnabled is the joint motor enabled?
b2.RevoluteJoint:setLimits sets the joint limits in radians
b2.RevoluteJoint:setMaxMotorTorque sets the maximum motor torque in N*m
b2.RevoluteJoint:setMotorSpeed sets the motor speed in radians per second

Events

Constants