<!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:41 CET 2013 -->
<title>BodyDef (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="BodyDef (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/BodyDef.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/Body.html" title="class in com.badlogic.gdx.physics.box2d"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.BodyType.html" title="enum in com.badlogic.gdx.physics.box2d"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/badlogic/gdx/physics/box2d/BodyDef.html" target="_top">Frames
</a></li>
<li><a href="BodyDef.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><a href="#nested_class_summary">Nested
</a> |
</li>
<li><a href="#field_summary">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#methods_inherited_from_class_java.lang.Object">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li><a href="#field_detail">Field
</a> |
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li>Method
</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
</div>
<h2 title="Class BodyDef" class="title">Class BodyDef
</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object
</li>
<li>
<ul class="inheritance">
<li>com.badlogic.gdx.physics.box2d.BodyDef
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class
<span class="strong">BodyDef
</span>
extends java.lang.Object
</pre>
<div class="block">A body definition holds all the data needed to construct a rigid body. You can safely re-use body definitions. Shapes are added
to a body after construction.
</div>
<dl><dt><span class="strong">Author:
</span></dt>
<dd>mzechner
</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Class and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class
</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.BodyType.html" title="enum in com.badlogic.gdx.physics.box2d">BodyDef.BodyType
</a></strong></code>
<div class="block">The body type.
</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary
</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields
</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type
</th>
<th class="colLast" scope="col">Field and Description
</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#active">active
</a></strong></code>
<div class="block">Does this body start out active?
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#allowSleep">allowSleep
</a></strong></code>
<div class="block">Set this flag to false if this body should never fall asleep.
</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/BodyDef.html#angle">angle
</a></strong></code>
<div class="block">The world angle of the body in radians.
</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/BodyDef.html#angularDamping">angularDamping
</a></strong></code>
<div class="block">Angular damping is use to reduce the angular velocity.
</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/BodyDef.html#angularVelocity">angularVelocity
</a></strong></code>
<div class="block">The angular velocity of the body.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#awake">awake
</a></strong></code>
<div class="block">Is this body initially awake or sleeping?
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#bullet">bullet
</a></strong></code>
<div class="block">Is this a fast moving body that should be prevented from tunneling through other moving bodies? Note that all bodies are
prevented from tunneling through kinematic and static bodies.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean
</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#fixedRotation">fixedRotation
</a></strong></code>
<div class="block">Should this body be prevented from rotating? Useful for characters.
</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/BodyDef.html#gravityScale">gravityScale
</a></strong></code>
<div class="block">Scale the gravity applied to this body.
</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/BodyDef.html#linearDamping">linearDamping
</a></strong></code>
<div class="block">Linear damping is use to reduce the linear velocity.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#linearVelocity">linearVelocity
</a></strong></code>
<div class="block">The linear velocity of the body's origin in world co-ordinates.
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#position">position
</a></strong></code>
<div class="block">The world position of the body.
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.BodyType.html" title="enum in com.badlogic.gdx.physics.box2d">BodyDef.BodyType
</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.html#type">type
</a></strong></code>
<div class="block">The body type: static, kinematic, or dynamic.
</div>
</td>
</tr>
</table>
</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/BodyDef.html#BodyDef()">BodyDef
</a></strong>()
</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary
</h3>
<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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail
</h3>
<a name="type">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type
</h4>
<pre>public
<a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.BodyType.html" title="enum in com.badlogic.gdx.physics.box2d">BodyDef.BodyType
</a> type
</pre>
<div class="block">The body type: static, kinematic, or dynamic. Note: if a dynamic body would have zero mass, the mass is set to one.
</div>
</li>
</ul>
<a name="position">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>position
</h4>
<pre>public final
<a href="../../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> position
</pre>
<div class="block">The world position of the body. Avoid creating bodies at the origin since this can lead to many overlapping shapes.
</div>
</li>
</ul>
<a name="angle">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>angle
</h4>
<pre>public
float angle
</pre>
<div class="block">The world angle of the body in radians.
</div>
</li>
</ul>
<a name="linearVelocity">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>linearVelocity
</h4>
<pre>public final
<a href="../../../../../com/badlogic/gdx/math/Vector2.html" title="class in com.badlogic.gdx.math">Vector2
</a> linearVelocity
</pre>
<div class="block">The linear velocity of the body's origin in world co-ordinates.
</div>
</li>
</ul>
<a name="angularVelocity">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>angularVelocity
</h4>
<pre>public
float angularVelocity
</pre>
<div class="block">The angular velocity of the body.
</div>
</li>
</ul>
<a name="linearDamping">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>linearDamping
</h4>
<pre>public
float linearDamping
</pre>
<div class="block">Linear damping is use to reduce the linear velocity. The damping parameter can be larger than 1.0f but the damping effect
becomes sensitive to the time step when the damping parameter is large.
</div>
</li>
</ul>
<a name="angularDamping">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>angularDamping
</h4>
<pre>public
float angularDamping
</pre>
<div class="block">Angular damping is use to reduce the angular velocity. The damping parameter can be larger than 1.0f but the damping effect
becomes sensitive to the time step when the damping parameter is large.
</div>
</li>
</ul>
<a name="allowSleep">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowSleep
</h4>
<pre>public
boolean allowSleep
</pre>
<div class="block">Set this flag to false if this body should never fall asleep. Note that this increases CPU usage.
</div>
</li>
</ul>
<a name="awake">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>awake
</h4>
<pre>public
boolean awake
</pre>
<div class="block">Is this body initially awake or sleeping?
</div>
</li>
</ul>
<a name="fixedRotation">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixedRotation
</h4>
<pre>public
boolean fixedRotation
</pre>
<div class="block">Should this body be prevented from rotating? Useful for characters.
</div>
</li>
</ul>
<a name="bullet">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bullet
</h4>
<pre>public
boolean bullet
</pre>
<div class="block">Is this a fast moving body that should be prevented from tunneling through other moving bodies? Note that all bodies are
prevented from tunneling through kinematic and static bodies. This setting is only considered on dynamic bodies.
</div>
</li>
</ul>
<a name="active">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>active
</h4>
<pre>public
boolean active
</pre>
<div class="block">Does this body start out active?
</div>
</li>
</ul>
<a name="gravityScale">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>gravityScale
</h4>
<pre>public
float gravityScale
</pre>
<div class="block">Scale the gravity applied to this body.
</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail
</h3>
<a name="BodyDef()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BodyDef
</h4>
<pre>public
BodyDef()
</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/BodyDef.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/Body.html" title="class in com.badlogic.gdx.physics.box2d"><span class="strong">Prev Class
</span></a></li>
<li><a href="../../../../../com/badlogic/gdx/physics/box2d/BodyDef.BodyType.html" title="enum in com.badlogic.gdx.physics.box2d"><span class="strong">Next Class
</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/badlogic/gdx/physics/box2d/BodyDef.html" target="_top">Frames
</a></li>
<li><a href="BodyDef.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><a href="#nested_class_summary">Nested
</a> |
</li>
<li><a href="#field_summary">Field
</a> |
</li>
<li><a href="#constructor_summary">Constr
</a> |
</li>
<li><a href="#methods_inherited_from_class_java.lang.Object">Method
</a></li>
</ul>
<ul class="subNavList">
<li>Detail:
</li>
<li><a href="#field_detail">Field
</a> |
</li>
<li><a href="#constructor_detail">Constr
</a> |
</li>
<li>Method
</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>