p2s
Version:
A JavaScript 2D physics engine.
1,553 lines (1,034 loc) • 122 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>World - p2.js</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="p2.js" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.7.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/AngleLockEquation.html">AngleLockEquation</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/Capsule.html">Capsule</a></li>
<li><a href="../classes/Circle.html">Circle</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/Convex.html">Convex</a></li>
<li><a href="../classes/DistanceConstraint.html">DistanceConstraint</a></li>
<li><a href="../classes/Equation.html">Equation</a></li>
<li><a href="../classes/EventEmitter.html">EventEmitter</a></li>
<li><a href="../classes/FrictionEquation.html">FrictionEquation</a></li>
<li><a href="../classes/GearConstraint.html">GearConstraint</a></li>
<li><a href="../classes/GSSolver.html">GSSolver</a></li>
<li><a href="../classes/Heightfield.html">Heightfield</a></li>
<li><a href="../classes/Island.html">Island</a></li>
<li><a href="../classes/IslandManager.html">IslandManager</a></li>
<li><a href="../classes/IslandNode.html">IslandNode</a></li>
<li><a href="../classes/Line.html">Line</a></li>
<li><a href="../classes/LinearSpring.html">LinearSpring</a></li>
<li><a href="../classes/LockConstraint.html">LockConstraint</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/Object pooling utility..html">Object pooling utility.</a></li>
<li><a href="../classes/OverlapKeeper.html">OverlapKeeper</a></li>
<li><a href="../classes/OverlapKeeperRecord.html">OverlapKeeperRecord</a></li>
<li><a href="../classes/Particle.html">Particle</a></li>
<li><a href="../classes/Plane.html">Plane</a></li>
<li><a href="../classes/PrismaticConstraint.html">PrismaticConstraint</a></li>
<li><a href="../classes/Ray.html">Ray</a></li>
<li><a href="../classes/RaycastResult.html">RaycastResult</a></li>
<li><a href="../classes/RevoluteConstraint.html">RevoluteConstraint</a></li>
<li><a href="../classes/RotationalLockEquation.html">RotationalLockEquation</a></li>
<li><a href="../classes/.html"></a></li>
<li><a href="../classes/RotationalSpring.html">RotationalSpring</a></li>
<li><a href="../classes/RotationalVelocityEquation.html">RotationalVelocityEquation</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/Spring.html">Spring</a></li>
<li><a href="../classes/TopDownVehicle.html">TopDownVehicle</a></li>
<li><a href="../classes/TupleDictionary.html">TupleDictionary</a></li>
<li><a href="../classes/Utils.html">Utils</a></li>
<li><a href="../classes/vec2.html">vec2</a></li>
<li><a href="../classes/WheelConstraint.html">WheelConstraint</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>World Class</h1>
<div class="box meta">
<div class="extends">
Extends <a href="../classes/EventEmitter.html" class="crosslink">EventEmitter</a>
</div>
<div class="foundat">
Defined in: <a href="../files/src_world_World.js.html#l35"><code>src/world/World.js:35</code></a>
</div>
</div>
<div class="box intro">
<p>The dynamics world, where all bodies and constraints live.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_World" class="method item">
<h3 class="name"><code>World</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_world_World.js.html#l35"><code>src/world/World.js:35</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">[solver]</code>
<span class="type"><a href="../classes/Solver.html" class="crosslink">Solver</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Defaults to GSSolver.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[gravity]</code>
<span class="type">Array</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Defaults to y=-9.78.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[broadphase]</code>
<span class="type"><a href="../classes/Broadphase.html" class="crosslink">Broadphase</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Defaults to SAPBroadphase</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[islandSplit=true]</code>
<span class="type">Boolean</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 world = new World({
gravity: [0, -10],
broadphase: new SAPBroadphase()
});
world.addBody(new 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>
<li class="api-class-tab events"><a href="#events">Events</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">
<a href="#method_addBody">addBody</a>
</li>
<li class="index-item method">
<a href="#method_addConstraint">addConstraint</a>
</li>
<li class="index-item method">
<a href="#method_addContactMaterial">addContactMaterial</a>
</li>
<li class="index-item method">
<a href="#method_addSpring">addSpring</a>
</li>
<li class="index-item method">
<a href="#method_clear">clear</a>
</li>
<li class="index-item method">
<a href="#method_disableBodyCollision">disableBodyCollision</a>
</li>
<li class="index-item method inherited">
<a href="#method_emit">emit</a>
</li>
<li class="index-item method">
<a href="#method_enableBodyCollision">enableBodyCollision</a>
</li>
<li class="index-item method">
<a href="#method_getBodyById">getBodyById</a>
</li>
<li class="index-item method">
<a href="#method_getContactMaterial">getContactMaterial</a>
</li>
<li class="index-item method inherited">
<a href="#method_has">has</a>
</li>
<li class="index-item method">
<a href="#method_hitTest">hitTest</a>
</li>
<li class="index-item method private">
<a href="#method_internalStep">internalStep</a>
</li>
<li class="index-item method inherited">
<a href="#method_off">off</a>
</li>
<li class="index-item method inherited">
<a href="#method_on">on</a>
</li>
<li class="index-item method">
<a href="#method_raycast">raycast</a>
</li>
<li class="index-item method">
<a href="#method_removeBody">removeBody</a>
</li>
<li class="index-item method">
<a href="#method_removeConstraint">removeConstraint</a>
</li>
<li class="index-item method">
<a href="#method_removeContactMaterial">removeContactMaterial</a>
</li>
<li class="index-item method">
<a href="#method_removeSpring">removeSpring</a>
</li>
<li class="index-item method">
<a href="#method_runNarrowphase">runNarrowphase</a>
</li>
<li class="index-item method">
<a href="#method_setGlobalRelaxation">setGlobalRelaxation</a>
</li>
<li class="index-item method">
<a href="#method_setGlobalStiffness">setGlobalStiffness</a>
</li>
<li class="index-item method">
<a href="#method_step">step</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_applyDamping">applyDamping</a>
</li>
<li class="index-item property">
<a href="#property_applyGravity">applyGravity</a>
</li>
<li class="index-item property">
<a href="#property_applySpringForces">applySpringForces</a>
</li>
<li class="index-item property">
<a href="#property_bodies">bodies</a>
</li>
<li class="index-item property private">
<a href="#property_bodiesToBeRemoved">bodiesToBeRemoved</a>
</li>
<li class="index-item property">
<a href="#property_BODY_SLEEPING">BODY_SLEEPING</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_broadphase">broadphase</a>
</li>
<li class="index-item property">
<a href="#property_constraints">constraints</a>
</li>
<li class="index-item property">
<a href="#property_contactMaterials">contactMaterials</a>
</li>
<li class="index-item property">
<a href="#property_defaultContactMaterial">defaultContactMaterial</a>
</li>
<li class="index-item property">
<a href="#property_defaultMaterial">defaultMaterial</a>
</li>
<li class="index-item property private">
<a href="#property_disabledBodyCollisionPairs">disabledBodyCollisionPairs</a>
</li>
<li class="index-item property">
<a href="#property_emitImpactEvent">emitImpactEvent</a>
</li>
<li class="index-item property">
<a href="#property_frictionGravity">frictionGravity</a>
</li>
<li class="index-item property">
<a href="#property_gravity">gravity</a>
</li>
<li class="index-item property">
<a href="#property_ISLAND_SLEEPING">ISLAND_SLEEPING</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_islandManager">islandManager</a>
</li>
<li class="index-item property">
<a href="#property_islandSplit">islandSplit</a>
</li>
<li class="index-item property">
<a href="#property_lastTimeStep">lastTimeStep</a>
</li>
<li class="index-item property">
<a href="#property_narrowphase">narrowphase</a>
</li>
<li class="index-item property">
<a href="#property_NO_SLEEPING">NO_SLEEPING</a>
<span class="flag static">static</span>
</li>
<li class="index-item property">
<a href="#property_overlapKeeper">overlapKeeper</a>
</li>
<li class="index-item property">
<a href="#property_sleepMode">sleepMode</a>
</li>
<li class="index-item property">
<a href="#property_solveConstraints">solveConstraints</a>
</li>
<li class="index-item property">
<a href="#property_solver">solver</a>
</li>
<li class="index-item property">
<a href="#property_springs">springs</a>
</li>
<li class="index-item property">
<a href="#property_stepping">stepping</a>
</li>
<li class="index-item property">
<a href="#property_time">time</a>
</li>
<li class="index-item property">
<a href="#property_useFrictionGravityOnZeroGravity">useFrictionGravityOnZeroGravity</a>
</li>
<li class="index-item property">
<a href="#property_useWorldGravityAsFrictionGravity">useWorldGravityAsFrictionGravity</a>
</li>
</ul>
</div>
<div class="index-section events">
<h3>Events</h3>
<ul class="index-list events extends">
<li class="index-item event">
<a href="#event_addBody">addBody</a>
</li>
<li class="index-item event">
<a href="#event_addSpring">addSpring</a>
</li>
<li class="index-item event">
<a href="#event_beginContact">beginContact</a>
</li>
<li class="index-item event">
<a href="#event_endContact">endContact</a>
</li>
<li class="index-item event">
<a href="#event_impact">impact</a>
</li>
<li class="index-item event">
<a href="#event_postBroadphase">postBroadphase</a>
</li>
<li class="index-item event">
<a href="#event_postStep">postStep</a>
</li>
<li class="index-item event">
<a href="#event_preSolve">preSolve</a>
</li>
<li class="index-item event">
<a href="#event_removeBody">removeBody</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_addBody" class="method item">
<h3 class="name"><code>addBody</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>body</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l982"><code>src/world/World.js:982</code></a>
</p>
</div>
<div class="description">
<p>Add a body to the simulation</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">body</code>
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code>var world = new World(),
body = new Body();
world.addBody(body);
</code></pre>
</div>
</div>
</div>
<div id="method_addConstraint" class="method item">
<h3 class="name"><code>addConstraint</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>constraint</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l399"><code>src/world/World.js:399</code></a>
</p>
</div>
<div class="description">
<p>Add a constraint to the simulation.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">constraint</code>
<span class="type"><a href="../classes/Constraint.html" class="crosslink">Constraint</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code>var constraint = new LockConstraint(bodyA, bodyB);
world.addConstraint(constraint);
</code></pre>
</div>
</div>
</div>
<div id="method_addContactMaterial" class="method item">
<h3 class="name"><code>addContactMaterial</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>contactMaterial</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l412"><code>src/world/World.js:412</code></a>
</p>
</div>
<div class="description">
<p>Add a ContactMaterial to the simulation.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">contactMaterial</code>
<span class="type"><a href="../classes/ContactMaterial.html" class="crosslink">ContactMaterial</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_addSpring" class="method item">
<h3 class="name"><code>addSpring</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>spring</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l955"><code>src/world/World.js:955</code></a>
</p>
</div>
<div class="description">
<p>Add a spring to the simulation</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">spring</code>
<span class="type"><a href="../classes/Spring.html" class="crosslink">Spring</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_clear" class="method item">
<h3 class="name"><code>clear</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l1070"><code>src/world/World.js:1070</code></a>
</p>
</div>
<div class="description">
<p>Resets the World, removes all bodies, constraints and springs.</p>
</div>
</div>
<div id="method_disableBodyCollision" class="method item">
<h3 class="name"><code>disableBodyCollision</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>bodyA</code>
</li>
<li class="arg">
<code>bodyB</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l1044"><code>src/world/World.js:1044</code></a>
</p>
</div>
<div class="description">
<p>Disable collision between two bodies</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">bodyA</code>
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">bodyB</code>
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_emit" class="method item inherited">
<h3 class="name"><code>emit</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/EventEmitter.html" class="crosslink">EventEmitter</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventEmitter.html#method_emit">EventEmitter</a>:
<a href="../files/src_events_EventEmitter.js.html#l79"><code>src/events/EventEmitter.js:79</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/EventEmitter.html" class="crosslink">EventEmitter</a></span>:
<p>The self object, for chainability.</p>
</div>
</div>
</div>
<div id="method_enableBodyCollision" class="method item">
<h3 class="name"><code>enableBodyCollision</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>bodyA</code>
</li>
<li class="arg">
<code>bodyB</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l1054"><code>src/world/World.js:1054</code></a>
</p>
</div>
<div class="description">
<p>Enable collisions between the given two bodies</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">bodyA</code>
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">bodyB</code>
<span class="type"><a href="../classes/Body.html" class="crosslink">Body</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_getBodyById" class="method item">
<h3 class="name"><code>getBodyById</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</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_world_World.js.html#l1027"><code>src/world/World.js:1027</code></a>
</p>
</div>
<div class="description">
<p>Get a body by its id.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type">Number</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, or false if it was not found.</p>
</div>
</div>
</div>
<div id="method_getContactMaterial" class="method item">
<h3 class="name"><code>getContactMaterial</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>materialA</code>
</li>
<li class="arg">
<code>materialB</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="../classes/ContactMaterial.html" class="crosslink">ContactMaterial</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l434"><code>src/world/World.js:434</code></a>
</p>
</div>
<div class="description">
<p>Get a contact material given two materials</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">materialA</code>
<span class="type"><a href="../classes/Material.html" class="crosslink">Material</a></span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">materialB</code>
<span class="type"><a href="../classes/Material.html" class="crosslink">Material</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/ContactMaterial.html" class="crosslink">ContactMaterial</a></span>:
<p>The matching ContactMaterial, or false on fail.</p>
</div>
</div>
</div>
<div id="method_has" class="method item inherited">
<h3 class="name"><code>has</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">Boolean</span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventEmitter.html#method_has">EventEmitter</a>:
<a href="../files/src_events_EventEmitter.js.html#l35"><code>src/events/EventEmitter.js:35</code></a>
</p>
</div>
<div class="description">
<p>Check if an event listener is added</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">Boolean</span>:
</div>
</div>
</div>
<div id="method_hitTest" class="method item">
<h3 class="name"><code>hitTest</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>bodies</code>
</li>
<li class="arg">
<code>precision</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Array</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l1115"><code>src/world/World.js:1115</code></a>
</p>
</div>
<div class="description">
<p>Test if a world point overlaps bodies</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">worldPoint</code>
<span class="type">Array</span>
<div class="param-description">
<p>Point to use for intersection tests</p>
</div>
</li>
<li class="param">
<code class="param-name">bodies</code>
<span class="type">Array</span>
<div class="param-description">
<p>A list of objects to check for intersection</p>
</div>
</li>
<li class="param">
<code class="param-name">precision</code>
<span class="type">Number</span>
<div class="param-description">
<p>Used for matching against particles and lines. Adds some margin to these infinitesimal objects.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Array</span>:
<p>Array of bodies that overlap the point</p>
</div>
</div>
</div>
<div id="method_internalStep" class="method item private">
<h3 class="name"><code>internalStep</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dt</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_world_World.js.html#l560"><code>src/world/World.js:560</code></a>
</p>
</div>
<div class="description">
<p>Make a fixed step.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">dt</code>
<span class="type">Number</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_off" class="method item inherited">
<h3 class="name"><code>off</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/EventEmitter.html" class="crosslink">EventEmitter</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventEmitter.html#method_off">EventEmitter</a>:
<a href="../files/src_events_EventEmitter.js.html#l60"><code>src/events/EventEmitter.js:60</code></a>
</p>
</div>
<div class="description">
<p>Remove 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/EventEmitter.html" class="crosslink">EventEmitter</a></span>:
<p>The self object, for chainability.</p>
</div>
</div>
</div>
<div id="method_on" class="method item inherited">
<h3 class="name"><code>on</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/EventEmitter.html" class="crosslink">EventEmitter</a></span>
</span>
<div class="meta">
<p>Inherited from
<a href="../classes/EventEmitter.html#method_on">EventEmitter</a>:
<a href="../files/src_events_EventEmitter.js.html#l13"><code>src/events/EventEmitter.js:13</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/EventEmitter.html" class="crosslink">EventEmitter</a></span>:
<p>The self object, for chainability.</p>
</div>
</div>
</div>
<div id="method_raycast" class="method item">
<h3 class="name"><code>raycast</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<l