cannon
Version:
A lightweight 3D physics engine written in JavaScript.
1,306 lines (898 loc) • 111 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Body - cannon</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="cannon" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.6.1</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/AABB.html">AABB</a></li>
<li><a href="../classes/ArrayCollisionMatrix.html">ArrayCollisionMatrix</a></li>
<li><a href="../classes/Body.html">Body</a></li>
<li><a href="../classes/Box.html">Box</a></li>
<li><a href="../classes/Broadphase.html">Broadphase</a></li>
<li><a href="../classes/ConeEquation.html">ConeEquation</a></li>
<li><a href="../classes/ConeTwistConstraint.html">ConeTwistConstraint</a></li>
<li><a href="../classes/Constraint.html">Constraint</a></li>
<li><a href="../classes/ContactEquation.html">ContactEquation</a></li>
<li><a href="../classes/ContactMaterial.html">ContactMaterial</a></li>
<li><a href="../classes/ConvexPolyhedron.html">ConvexPolyhedron</a></li>
<li><a href="../classes/Cylinder.html">Cylinder</a></li>
<li><a href="../classes/Demo.html">Demo</a></li>
<li><a href="../classes/DistanceConstraint.html">DistanceConstraint</a></li>
<li><a href="../classes/Equation.html">Equation</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/FrictionEquation.html">FrictionEquation</a></li>
<li><a href="../classes/GridBroadphase.html">GridBroadphase</a></li>
<li><a href="../classes/GSSolver.html">GSSolver</a></li>
<li><a href="../classes/Heightfield.html">Heightfield</a></li>
<li><a href="../classes/HingeConstraint.html">HingeConstraint</a></li>
<li><a href="../classes/JacobianElement.html">JacobianElement</a></li>
<li><a href="../classes/LockConstraint.html">LockConstraint</a></li>
<li><a href="../classes/Mat3.html">Mat3</a></li>
<li><a href="../classes/Material.html">Material</a></li>
<li><a href="../classes/NaiveBroadphase.html">NaiveBroadphase</a></li>
<li><a href="../classes/Narrowphase.html">Narrowphase</a></li>
<li><a href="../classes/ObjectCollisionMatrix.html">ObjectCollisionMatrix</a></li>
<li><a href="../classes/Octree.html">Octree</a></li>
<li><a href="../classes/OctreeNode.html">OctreeNode</a></li>
<li><a href="../classes/Particle.html">Particle</a></li>
<li><a href="../classes/Plane.html">Plane</a></li>
<li><a href="../classes/PointToPointConstraint.html">PointToPointConstraint</a></li>
<li><a href="../classes/Pool.html">Pool</a></li>
<li><a href="../classes/Quaternion.html">Quaternion</a></li>
<li><a href="../classes/Ray.html">Ray</a></li>
<li><a href="../classes/RaycastResult.html">RaycastResult</a></li>
<li><a href="../classes/RaycastVehicle.html">RaycastVehicle</a></li>
<li><a href="../classes/RigidVehicle.html">RigidVehicle</a></li>
<li><a href="../classes/RotationalEquation.html">RotationalEquation</a></li>
<li><a href="../classes/RotationalMotorEquation.html">RotationalMotorEquation</a></li>
<li><a href="../classes/SAPBroadphase.html">SAPBroadphase</a></li>
<li><a href="../classes/Shape.html">Shape</a></li>
<li><a href="../classes/Solver.html">Solver</a></li>
<li><a href="../classes/Sphere.html">Sphere</a></li>
<li><a href="../classes/SPHSystem.html">SPHSystem</a></li>
<li><a href="../classes/SplitSolver.html">SplitSolver</a></li>
<li><a href="../classes/Spring.html">Spring</a></li>
<li><a href="../classes/Transform.html">Transform</a></li>
<li><a href="../classes/Trimesh.html">Trimesh</a></li>
<li><a href="../classes/TupleDictionary.html">TupleDictionary</a></li>
<li><a href="../classes/Vec3.html">Vec3</a></li>
<li><a href="../classes/Vec3Pool.html">Vec3Pool</a></li>
<li><a href="../classes/WheelInfo.html">WheelInfo</a></li>
<li><a href="../classes/World.html">World</a></li>
</ul>
<ul id="api-modules" class="apis modules">
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>Body Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/EventTarget.html" class="crosslink">EventTarget</a>
</div>
<div class="foundat">
Defined in: <a href="../files/src_objects_Body.js.html#l12"><code>src/objects/Body.js:12</code></a>
</div>
</div>
<div class="box intro">
<p>Base class for all body types.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_Body" class="method item">
<h3 class="name"><code>Body</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l12"><code>src/objects/Body.js:12</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type">Object</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[position]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[velocity]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[angularVelocity]</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[quaternion]</code>
<span class="type"><a href="../classes/Quaternion.html" class="crosslink">Quaternion</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[mass]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[material]</code>
<span class="type"><a href="../classes/Material.html" class="crosslink">Material</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[type]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[linearDamping=0.01]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[angularDamping=0.01]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[allowSleep=true]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[sleepSpeedLimit=0.1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[sleepTimeLimit=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[collisionFilterGroup=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[collisionFilterMask=1]</code>
<span class="type">Number</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[fixedRotation=false]</code>
<span class="type">Boolean</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name optional">[shape]</code>
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code>var body = new Body({
mass: 1
});
var shape = new Sphere(1);
body.addShape(shape);
world.add(body);
</code></pre>
</div>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods extends">
<li class="index-item method inherited">
<a href="#method_addEventListener">addEventListener</a>
</li>
<li class="index-item method">
<a href="#method_addShape">addShape</a>
</li>
<li class="index-item method">
<a href="#method_applyForce">applyForce</a>
</li>
<li class="index-item method">
<a href="#method_applyImpulse">applyImpulse</a>
</li>
<li class="index-item method">
<a href="#method_applyLocalForce">applyLocalForce</a>
</li>
<li class="index-item method">
<a href="#method_applyLocalImpulse">applyLocalImpulse</a>
</li>
<li class="index-item method">
<a href="#method_computeAABB">computeAABB</a>
</li>
<li class="index-item method inherited">
<a href="#method_dispatchEvent">dispatchEvent</a>
</li>
<li class="index-item method">
<a href="#method_getVelocityAtWorldPoint">getVelocityAtWorldPoint</a>
</li>
<li class="index-item method inherited">
<a href="#method_hasEventListener">hasEventListener</a>
</li>
<li class="index-item method">
<a href="#method_pointToLocalFrame">pointToLocalFrame</a>
</li>
<li class="index-item method">
<a href="#method_pointToWorldFrame">pointToWorldFrame</a>
</li>
<li class="index-item method inherited">
<a href="#method_removeEventListener">removeEventListener</a>
</li>
<li class="index-item method">
<a href="#method_sleep">sleep</a>
</li>
<li class="index-item method">
<a href="#method_sleepTick">sleepTick</a>
</li>
<li class="index-item method">
<a href="#method_updateBoundingRadius">updateBoundingRadius</a>
</li>
<li class="index-item method">
<a href="#method_updateInertiaWorld">updateInertiaWorld</a>
</li>
<li class="index-item method">
<a href="#method_updateMassProperties">updateMassProperties</a>
</li>
<li class="index-item method">
<a href="#method_updateSolveMassProperties">updateSolveMassProperties</a>
</li>
<li class="index-item method">
<a href="#method_vectorToLocalFrame">vectorToLocalFrame</a>
</li>
<li class="index-item method">
<a href="#method_vectorToWorldFrame">vectorToWorldFrame</a>
</li>
<li class="index-item method">
<a href="#method_wakeUp">wakeUp</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties extends">
<li class="index-item property">
<a href="#property_aabb">aabb</a>
</li>
<li class="index-item property">
<a href="#property_aabbNeedsUpdate">aabbNeedsUpdate</a>
</li>
<li class="index-item property">
<a href="#property_allowSleep">allowSleep</a>
</li>
<li class="index-item property">
<a href="#property_angularDamping">angularDamping</a>
</li>
<li class="index-item property">
<a href="#property_angularVelocity">angularVelocity</a>
</li>
<li class="index-item property">
<a href="#property_AWAKE">AWAKE</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_collisionFilterGroup">collisionFilterGroup</a>
</li>
<li class="index-item property">
<a href="#property_collisionFilterMask">collisionFilterMask</a>
</li>
<li class="index-item property">
<a href="#property_collisionResponse">collisionResponse</a>
</li>
<li class="index-item property">
<a href="#property_DYNAMIC">DYNAMIC</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_fixedRotation">fixedRotation</a>
</li>
<li class="index-item property">
<a href="#property_force">force</a>
</li>
<li class="index-item property">
<a href="#property_inertia">inertia</a>
</li>
<li class="index-item property">
<a href="#property_initAngularVelocity">initAngularVelocity</a>
</li>
<li class="index-item property">
<a href="#property_initPosition">initPosition</a>
</li>
<li class="index-item property">
<a href="#property_initQuaternion">initQuaternion</a>
</li>
<li class="index-item property">
<a href="#property_initVelocity">initVelocity</a>
</li>
<li class="index-item property">
<a href="#property_invInertia">invInertia</a>
</li>
<li class="index-item property">
<a href="#property_invInertiaSolve">invInertiaSolve</a>
</li>
<li class="index-item property">
<a href="#property_invInertiaWorld">invInertiaWorld</a>
</li>
<li class="index-item property">
<a href="#property_invInertiaWorldSolve">invInertiaWorldSolve</a>
</li>
<li class="index-item property">
<a href="#property_invMass">invMass</a>
</li>
<li class="index-item property">
<a href="#property_KINEMATIC">KINEMATIC</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_linearDamping">linearDamping</a>
</li>
<li class="index-item property">
<a href="#property_mass">mass</a>
</li>
<li class="index-item property">
<a href="#property_material">material</a>
</li>
<li class="index-item property">
<a href="#property_position">position</a>
</li>
<li class="index-item property deprecated">
<a href="#property_postStep">postStep</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item property deprecated">
<a href="#property_preStep">preStep</a>
<span class="flag deprecated">deprecated</span>
</li>
<li class="index-item property">
<a href="#property_previousPosition">previousPosition</a>
</li>
<li class="index-item property">
<a href="#property_quaternion">quaternion</a>
</li>
<li class="index-item property">
<a href="#property_shapeOffsets">shapeOffsets</a>
</li>
<li class="index-item property">
<a href="#property_shapeOrientations">shapeOrientations</a>
</li>
<li class="index-item property">
<a href="#property_shapes">shapes</a>
</li>
<li class="index-item property">
<a href="#property_SLEEPING">SLEEPING</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_sleepSpeedLimit">sleepSpeedLimit</a>
</li>
<li class="index-item property">
<a href="#property_sleepState">sleepState</a>
</li>
<li class="index-item property">
<a href="#property_sleepTimeLimit">sleepTimeLimit</a>
</li>
<li class="index-item property">
<a href="#property_SLEEPY">SLEEPY</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_STATIC">STATIC</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_torque">torque</a>
</li>
<li class="index-item property">
<a href="#property_type">type</a>
</li>
<li class="index-item property">
<a href="#property_velocity">velocity</a>
</li>
<li class="index-item property">
<a href="#property_world">world</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_addEventListener" class="method item inherited">
<h3 class="name"><code>addEventListener</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>type</code>
</li>
<li class="arg">
<code>listener</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_addEventListener">EventTarget</a>:
<a href="../files/src_utils_EventTarget.js.html#l15"><code>src/utils/EventTarget.js:15</code></a>
</p>
</div>
<div class="description">
<p>Add an event listener</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">listener</code>
<span class="type">Function</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
<p>The self object, for chainability.</p>
</div>
</div>
</div>
<div id="method_addShape" class="method item">
<h3 class="name"><code>addShape</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>shape</code>
</li>
<li class="arg">
<code>offset</code>
</li>
<li class="arg">
<code>quaternion</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l507"><code>src/objects/Body.js:507</code></a>
</p>
</div>
<div class="description">
<p>Add a shape to the body with a local offset and orientation.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">shape</code>
<span class="type"><a href="../classes/Shape.html" class="crosslink">Shape</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">offset</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">quaternion</code>
<span class="type"><a href="../classes/Quaternion.html" class="crosslink">Quaternion</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>:
<p>The body object, for chainability.</p>
</div>
</div>
</div>
<div id="method_applyForce" class="method item">
<h3 class="name"><code>applyForce</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>force</code>
</li>
<li class="arg">
<code>worldPoint</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l637"><code>src/objects/Body.js:637</code></a>
</p>
</div>
<div class="description">
<p>Apply force to a world point. This could for example be a point on the Body surface. Applying force this way will add to Body.force and Body.torque.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">force</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>The amount of force to add.</p>
</div>
</li>
<li class="param">
<code class="param-name">worldPoint</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>A world point to apply the force on.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_applyImpulse" class="method item">
<h3 class="name"><code>applyImpulse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>impulse</code>
</li>
<li class="arg">
<code>worldPoint</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l688"><code>src/objects/Body.js:688</code></a>
</p>
</div>
<div class="description">
<p>Apply impulse to a world point. This could for example be a point on the Body surface. An impulse is a force added to a body during a short period of time (impulse = force * time). Impulses will be added to Body.velocity and Body.angularVelocity.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">impulse</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>The amount of impulse to add.</p>
</div>
</li>
<li class="param">
<code class="param-name">worldPoint</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>A world point to apply the force on.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_applyLocalForce" class="method item">
<h3 class="name"><code>applyLocalForce</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>force</code>
</li>
<li class="arg">
<code>localPoint</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l665"><code>src/objects/Body.js:665</code></a>
</p>
</div>
<div class="description">
<p>Apply force to a local point in the body.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">force</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>The force vector to apply, defined locally in the body frame.</p>
</div>
</li>
<li class="param">
<code class="param-name">localPoint</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>A local point in the body to apply the force on.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_applyLocalImpulse" class="method item">
<h3 class="name"><code>applyLocalImpulse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>force</code>
</li>
<li class="arg">
<code>localPoint</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l729"><code>src/objects/Body.js:729</code></a>
</p>
</div>
<div class="description">
<p>Apply locally-defined impulse to a local point in the body.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">force</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>The force vector to apply, defined locally in the body frame.</p>
</div>
</li>
<li class="param">
<code class="param-name">localPoint</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
<p>A local point in the body to apply the force on.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_computeAABB" class="method item">
<h3 class="name"><code>computeAABB</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l562"><code>src/objects/Body.js:562</code></a>
</p>
</div>
<div class="description">
<p>Updates the .aabb</p>
</div>
</div>
<div id="method_dispatchEvent" class="method item inherited">
<h3 class="name"><code>dispatchEvent</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>event</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventTarget.html#method_dispatchEvent">EventTarget</a>:
<a href="../files/src_utils_EventTarget.js.html#l68"><code>src/utils/EventTarget.js:68</code></a>
</p>
</div>
<div class="description">
<p>Emit an event.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Object</span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">type</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EventTarget.html" class="crosslink">EventTarget</a></span>:
<p>The self object, for chainability.</p>
</div>
</div>
</div>
<div id="method_getVelocityAtWorldPoint" class="method item">
<h3 class="name"><code>getVelocityAtWorldPoint</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>worldPoint</code>
</li>
<li class="arg">
<code>result</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_objects_Body.js.html#l782"><code>src/objects/Body.js:782</code></a>
</p>
</div>
<div class="description">
<p>Get world velocity of a point in the body.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">worldPoint</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">result</code>
<span class="type"><a href="../classes/Vec3.html" class="crosslink">Vec3</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="t