Difference between revisions of "B2.WheelJoint"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
'''Supported platforms:''' android, ios, mac, pc<br/>
+
<languages />
−
'''Available since:''' Gideros 2011.6<br/>
+
<!-- GIDEROSOBJ:b2.WheelJoint -->
−
=== Description ===
+
'''<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><br />
+
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
−
A wheel joint provides two degrees of freedom: translation along an axis fixed in bodyA and rotation in the plane. You can use a <br />
+
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/b2.Joint|b2.Joint]]<br/>
−
joint limit to restrict the range of motion and a joint motor to drive the rotation or to model rotational friction. This joint <br />
+
 
−
is designed for vehicle suspensions.<br />
+
=== <translate>Description</translate> ===
−
<br /></translate>
+
A wheel joint provides two degrees of freedom: translation along an axis fixed in bodyA and rotation in the plane. You can use a joint limit to restrict the range of motion and a joint motor to drive the rotation or to model rotational friction. This joint is designed for vehicle suspensions.
−
=== Examples ===
+
 
−
'''Wheel joint'''<br/>
+
=== <translate>Examples</translate> ===
−
<source lang="lua">--create empty box2d body for joint
+
'''Wheel joint'''
 +
<syntaxhighlight lang="lua">
 +
--create empty box2d body for joint
 
local ground = world:createBody({})
 
local ground = world:createBody({})
 
ground:setPosition(350, 480)
 
ground:setPosition(350, 480)
  
−
--axisx, axisy values usually between 0 and 1
+
--axisx, axisy values usually between 0 and 1
−
--0 0 moves freely
+
--0 0 moves freely
−
--0 1 force pulling back on y axis
+
--0 1 force pulling back on y axis
−
--1 0 force pulling back on x axis
+
--1 0 force pulling back on x axis
−
--1 1 force pulling back all diretions
+
--1 1 force pulling back all diretions
 
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
 
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
−
local wheelJoint = world:createJoint(jointDef)</source>
+
local wheelJoint = world:createJoint(jointDef)
 +
</syntaxhighlight>
 +
 
 
{|-
 
{|-
−
| style="width: 50%;"|
+
| style="width: 50%; vertical-align:top;"|
−
=== Methods ===
+
=== <translate>Methods</translate> ===
−
[[b2.WheelJoint:enableMotor]] {{<translate>enables or disables the joint motor</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:enableMotor|b2.WheelJoint:enableMotor]] ''<translate>enables or disables the joint motor</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:enableMotor(flag) enables or disables the joint motor -->
−
[[b2.WheelJoint:getJointSpeed]] {{<translate>returns the current joint translation speed in meters per second.</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:getJointSpeed|b2.WheelJoint:getJointSpeed]] ''<translate>returns the current joint translation speed in meters per second.</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:getJointSpeed() returns the current joint translation speed in meters per second. -->
−
[[b2.WheelJoint:getJointTranslation]] {{<translate>returns the current joint translation in meters.</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:getJointTranslation|b2.WheelJoint:getJointTranslation]] ''<translate>returns the current joint translation in meters.</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:getJointTranslation() returns the current joint translation in meters. -->
−
[[b2.WheelJoint:getMaxMotorTorque]] {{<translate>returns the maximum motor torque in N*m</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:getMaxMotorTorque|b2.WheelJoint:getMaxMotorTorque]] ''<translate>returns the maximum motor torque in N*m</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:getMaxMotorTorque() returns the maximum motor torque in N*m -->
−
[[b2.WheelJoint:getMotorSpeed]] {{<translate>returns the motor speed in radians per second</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:getMotorSpeed|b2.WheelJoint:getMotorSpeed]] ''<translate>returns the motor speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:getMotorSpeed() returns the motor speed in radians per second -->
−
[[b2.WheelJoint:getSpringDampingRatio]] {{<translate>returns the spring damping ratio</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:getSpringDampingRatio|b2.WheelJoint:getSpringDampingRatio]] ''<translate>returns the spring damping ratio</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:getSpringDampingRatio() returns the spring damping ratio -->
−
[[b2.WheelJoint:getSpringFrequencyHz]] {{<translate>returns the spring frequency in Hertz</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:getSpringFrequencyHz|b2.WheelJoint:getSpringFrequencyHz]] ''<translate>returns the spring frequency in Hertz</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:getSpringFrequencyHz() returns the spring frequency in Hertz -->
−
[[b2.WheelJoint:isMotorEnabled]] {{<translate>is the joint motor enabled?</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:isMotorEnabled|b2.WheelJoint:isMotorEnabled]] ''<translate>is the joint motor enabled?</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:isMotorEnabled() is the joint motor enabled? -->
−
[[b2.WheelJoint:setMaxMotorTorque]] {{<translate>sets the maximum motor torque in N*m</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:setMaxMotorTorque|b2.WheelJoint:setMaxMotorTorque]] ''<translate>sets the maximum motor torque in N*m</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:setMaxMotorTorque(torque) sets the maximum motor torque in N*m -->
−
[[b2.WheelJoint:setMotorSpeed]] {{<translate>sets the motor speed in radians per second</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:setMotorSpeed|b2.WheelJoint:setMotorSpeed]] ''<translate>sets the motor speed in radians per second</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:setMotorSpeed(speed) sets the motor speed in radians per second -->
−
[[b2.WheelJoint:setSpringDampingRatio]] {{<translate>sets the spring damping ratio</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:setSpringDampingRatio|b2.WheelJoint:setSpringDampingRatio]] ''<translate>sets the spring damping ratio</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:setSpringDampingRatio(damping) sets the spring damping ratio -->
−
[[b2.WheelJoint:setSpringFrequencyHz]] {{<translate>sets the spring frequency in Hertz (0 = disable the spring)</translate>}}<br/>
+
[[Special:MyLanguage/b2.WheelJoint:setSpringFrequencyHz|b2.WheelJoint:setSpringFrequencyHz]] ''<translate>sets the spring frequency in Hertz (0 = disable the spring)</translate>''<br/><!-- GIDEROSMTD:b2.WheelJoint:setSpringFrequencyHz(frequency) sets the spring frequency in Hertz (0 = disable the spring) -->
−
| style="width: 50%;"|
+
 
−
=== Events ===
+
| style="width: 50%; vertical-align:top;"|
−
=== Constants ===
+
=== <translate>Events</translate> ===
 +
=== <translate>Constants</translate> ===
 
|}
 
|}
 +
 +
----
 +
*'''[[B2.Joint]]'''
 +
*'''[[LiquidFun]]'''

Latest revision as of 14:26, 13 July 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 wheel joint provides two degrees of freedom: translation along an axis fixed in bodyA and rotation in the plane. You can use a joint limit to restrict the range of motion and a joint motor to drive the rotation or to model rotational friction. This joint is designed for vehicle suspensions.

Examples

Wheel joint 

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

--axisx, axisy values usually between 0 and 1
--0 0 moves freely
--0 1 force pulling back on y axis
--1 0 force pulling back on x axis
--1 1 force pulling back all diretions
local jointDef = b2.createWheelJointDef(body, ground, 350, 200, 1, 1)
local wheelJoint = world:createJoint(jointDef)

Methods

b2.WheelJoint:enableMotor enables or disables the joint motor
b2.WheelJoint:getJointSpeed returns the current joint translation speed in meters per second.
b2.WheelJoint:getJointTranslation returns the current joint translation in meters.
b2.WheelJoint:getMaxMotorTorque returns the maximum motor torque in N*m
b2.WheelJoint:getMotorSpeed returns the motor speed in radians per second
b2.WheelJoint:getSpringDampingRatio returns the spring damping ratio
b2.WheelJoint:getSpringFrequencyHz returns the spring frequency in Hertz
b2.WheelJoint:isMotorEnabled is the joint motor enabled?
b2.WheelJoint:setMaxMotorTorque sets the maximum motor torque in N*m
b2.WheelJoint:setMotorSpeed sets the motor speed in radians per second
b2.WheelJoint:setSpringDampingRatio sets the spring damping ratio
b2.WheelJoint:setSpringFrequencyHz sets the spring frequency in Hertz (0 = disable the spring)

Events

Constants

Retrieved from ‘https://wiki.gideros.rocks/index.php?title=B2.WheelJoint&oldid=20122’