<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sun Nov 03 15:35:46 CET 2013 -->
<title>WheelJoint (libgdx API)
</title>
<meta name="date" content="2013-11-03">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WheelJoint (libgdx API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.
</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/WheelJoint.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../../../index-all.html">Index
</a></li>
<li><a href="../../../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>
libgdx API
<style>
body, td, th { font-family:Helvetica, Tahoma, Arial, sans-serif; font-size:10pt }
pre, code, tt { font-size:9pt; font-family:Lucida Console, Courier New, sans-serif }
h1, h2, h3, .FrameTitleFont, .FrameHeadingFont, .TableHeadingColor font { font-size:105%; font-weight:bold }
.TableHeadingColor { background:#EEEEFF; }
a { text-decoration:none }
a:hover { text-decoration:underline }
a:link, a:visited { color:blue }
table { border:0px }
.TableRowColor td:first-child { border-left:1px solid black }
.TableRowColor td { border:0px; border-bottom:1px solid black; border-right:1px solid black }
hr { border:0px; border-bottom:1px solid #333366; }
</style>
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WeldJointDef.html" title="class in com.badlogic.gdx.physics.box2d.joints"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJointDef.html" title="class in com.badlogic.gdx.physics.box2d.joints"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/badlogic/gdx/physics/box2d/joints/WheelJoint.html" target="_top">Frames
</a></li>
<li><a href="WheelJoint.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li><a href="#fields_inherited_from_class_com.badlogic.gdx.physics.box2d.Joint">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.badlogic.gdx.physics.box2d.joints
</div>
<h2 title="Class WheelJoint" class="title">Class WheelJoint
</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object
</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html" title="class in com.badlogic.gdx.physics.box2d">com.badlogic.gdx.physics.box2d.Joint
</a></li>
<li>
<ul class="inheritance">
<li>com.badlogic.gdx.physics.box2d.joints.WheelJoint
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class
<span class="strong">WheelJoint
</span>
extends
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html" title="class in com.badlogic.gdx.physics.box2d">Joint
</a></pre>
<div class="block">A wheel joint. This joint provides two degrees of freedom: translation along an axis fixed in body1 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.
</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary
</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_com.badlogic.gdx.physics.box2d.Joint">
<!-- -->
</a>
<h3>Fields inherited from class
com.badlogic.gdx.physics.box2d.
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html" title="class in com.badlogic.gdx.physics.box2d">Joint
</a></h3>
<code><a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#addr">addr
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#jointEdgeA">jointEdgeA
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#jointEdgeB">jointEdgeB
</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description
</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#WheelJoint(com.badlogic.gdx.physics.box2d.World, long)">WheelJoint
</a></strong>(
<a href="../../../../../../com/badlogic/gdx/physics/box2d/World.html" title="class in com.badlogic.gdx.physics.box2d">World
</a> world,
long
addr)
</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Method and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#enableMotor(boolean)">enableMotor
</a></strong>(boolean
flag)
</code>
<div class="block">Enable/disable the joint motor.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#getJointSpeed()">getJointSpeed
</a></strong>()
</code>
<div class="block">Get the current joint translation speed, usually in meters per second.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#getJointTranslation()">getJointTranslation
</a></strong>()
</code>
<div class="block">Get the current joint translation, usually in meters.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#getMaxMotorTorque()">getMaxMotorTorque
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#getMotorSpeed()">getMotorSpeed
</a></strong>()
</code>
<div class="block">Get the motor speed, usually in radians per second.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#getMotorTorque(float)">getMotorTorque
</a></strong>(float
invDt)
</code>
<div class="block">Get the current motor torque given the inverse time step, usually in N-m.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#getSpringDampingRatio()">getSpringDampingRatio
</a></strong>()
</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#getSpringFrequencyHz()">getSpringFrequencyHz
</a></strong>()
</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#setMaxMotorTorque(float)">setMaxMotorTorque
</a></strong>(float
torque)
</code>
<div class="block">Set/Get the maximum motor force, usually in N-m.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#setMotorSpeed(float)">setMotorSpeed
</a></strong>(float
speed)
</code>
<div class="block">Set the motor speed, usually in radians per second.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#setSpringDampingRatio(float)">setSpringDampingRatio
</a></strong>(float
ratio)
</code>
<div class="block">Set/Get the spring damping ratio
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void
</code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJoint.html#setSpringFrequencyHz(float)">setSpringFrequencyHz
</a></strong>(float
hz)
</code>
<div class="block">Set/Get the spring frequency in hertz.
</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.badlogic.gdx.physics.box2d.Joint">
<!-- -->
</a>
<h3>Methods inherited from class
com.badlogic.gdx.physics.box2d.
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html" title="class in com.badlogic.gdx.physics.box2d">Joint
</a></h3>
<code><a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getAnchorA()">getAnchorA
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getAnchorB()">getAnchorB
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getBodyA()">getBodyA
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getBodyB()">getBodyB
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getReactionForce(float)">getReactionForce
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getReactionTorque(float)">getReactionTorque
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getType()">getType
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#getUserData()">getUserData
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#isActive()">isActive
</a>,
<a href="../../../../../../com/badlogic/gdx/physics/box2d/Joint.html#setUserData(java.lang.Object)">setUserData
</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class
java.lang.Object
</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="WheelJoint(com.badlogic.gdx.physics.box2d.World, long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WheelJoint
</h4>
<pre>public
WheelJoint(
<a href="../../../../../../com/badlogic/gdx/physics/box2d/World.html" title="class in com.badlogic.gdx.physics.box2d">World
</a> world,
long
addr)
</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail
</h3>
<a name="getJointTranslation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJointTranslation
</h4>
<pre>public
float
getJointTranslation()
</pre>
<div class="block">Get the current joint translation, usually in meters.
</div>
</li>
</ul>
<a name="getJointSpeed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJointSpeed
</h4>
<pre>public
float
getJointSpeed()
</pre>
<div class="block">Get the current joint translation speed, usually in meters per second.
</div>
</li>
</ul>
<a name="enableMotor(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableMotor
</h4>
<pre>public
void
enableMotor(boolean
flag)
</pre>
<div class="block">Enable/disable the joint motor.
</div>
</li>
</ul>
<a name="setMotorSpeed(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMotorSpeed
</h4>
<pre>public
void
setMotorSpeed(float
speed)
</pre>
<div class="block">Set the motor speed, usually in radians per second.
</div>
</li>
</ul>
<a name="getMotorSpeed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMotorSpeed
</h4>
<pre>public
float
getMotorSpeed()
</pre>
<div class="block">Get the motor speed, usually in radians per second.
</div>
</li>
</ul>
<a name="setMaxMotorTorque(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxMotorTorque
</h4>
<pre>public
void
setMaxMotorTorque(float
torque)
</pre>
<div class="block">Set/Get the maximum motor force, usually in N-m.
</div>
</li>
</ul>
<a name="getMaxMotorTorque()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxMotorTorque
</h4>
<pre>public
float
getMaxMotorTorque()
</pre>
</li>
</ul>
<a name="getMotorTorque(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMotorTorque
</h4>
<pre>public
float
getMotorTorque(float
invDt)
</pre>
<div class="block">Get the current motor torque given the inverse time step, usually in N-m.
</div>
</li>
</ul>
<a name="setSpringFrequencyHz(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSpringFrequencyHz
</h4>
<pre>public
void
setSpringFrequencyHz(float
hz)
</pre>
<div class="block">Set/Get the spring frequency in hertz. Setting the frequency to zero disables the spring.
</div>
</li>
</ul>
<a name="getSpringFrequencyHz()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpringFrequencyHz
</h4>
<pre>public
float
getSpringFrequencyHz()
</pre>
</li>
</ul>
<a name="setSpringDampingRatio(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSpringDampingRatio
</h4>
<pre>public
void
setSpringDampingRatio(float
ratio)
</pre>
<div class="block">Set/Get the spring damping ratio
</div>
</li>
</ul>
<a name="getSpringDampingRatio()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSpringDampingRatio
</h4>
<pre>public
float
getSpringDampingRatio()
</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview
</a></li>
<li><a href="package-summary.html">Package
</a></li>
<li class="navBarCell1Rev">Class
</li>
<li><a href="class-use/WheelJoint.html">Use
</a></li>
<li><a href="package-tree.html">Tree
</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated
</a></li>
<li><a href="../../../../../../index-all.html">Index
</a></li>
<li><a href="../../../../../../help-doc.html">Help
</a></li>
</ul>
<div class="aboutLanguage"><em>libgdx API
</em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WeldJointDef.html" title="class in com.badlogic.gdx.physics.box2d.joints"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../../../com/badlogic/gdx/physics/box2d/joints/WheelJointDef.html" title="class in com.badlogic.gdx.physics.box2d.joints"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/badlogic/gdx/physics/box2d/joints/WheelJoint.html" target="_top">Frames
</a></li>
<li><a href="WheelJoint.html" target="_top">No Frames
</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes
</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:
</li>
<li>Nested
|
</li>
<li><a href="#fields_inherited_from_class_com.badlogic.gdx.physics.box2d.Joint">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#method_summary">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li>Field
|
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li><a href="#method_detail">Method
</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
<div style="font-size:9pt"><i>
Copyright
© 2010-2013 Mario Zechner (contact@badlogicgames.com), Nathan Sweet (admin@esotericsoftware.com)
</i></div>
</small></p>
</body>
</html>