p2s

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Ray - 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>Ray Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/src_collision_Ray.js.html#l8"><code>src/collision/Ray.js:8</code></a> </div> </div> <div class="box intro"> <p>A line with a start and end point that is used to intersect shapes. For an example, see <a href="../classes/World.html#method_raycast" class="crosslink">World.raycast</a></p> </div> <div class="constructor"> <h2>Constructor</h2> <div id="method_Ray" class="method item"> <h3 class="name"><code>Ray</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_collision_Ray.js.html#l8"><code>src/collision/Ray.js:8</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">[from]</code> <span class="type">Array</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">[to]</code> <span class="type">Array</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">[checkCollisionResponse=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">[skipBackfaces=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">[collisionMask=-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">[collisionGroup=-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">[mode=Ray.ANY]</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">[callback]</code> <span class="type">Number</span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> </div> </li> </ul> </li> </ul> </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"> <li class="index-item method"> <a href="#method_getAABB">getAABB</a> </li> <li class="index-item method"> <a href="#method_intersectBodies">intersectBodies</a> </li> <li class="index-item method private"> <a href="#method_intersectBody">intersectBody</a> </li> <li class="index-item method private"> <a href="#method_intersectShape">intersectShape</a> </li> <li class="index-item method private"> <a href="#method_reportIntersection">reportIntersection</a> </li> <li class="index-item method"> <a href="#method_update">update</a> </li> </ul> </div> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties"> <li class="index-item property"> <a href="#property_ALL">ALL</a> <span class="flag static">static</span> </li> <li class="index-item property"> <a href="#property_ANY">ANY</a> <span class="flag static">static</span> </li> <li class="index-item property"> <a href="#property_callback">callback</a> </li> <li class="index-item property"> <a href="#property_checkCollisionResponse">checkCollisionResponse</a> </li> <li class="index-item property"> <a href="#property_CLOSEST">CLOSEST</a> <span class="flag static">static</span> </li> <li class="index-item property"> <a href="#property_collisionGroup">collisionGroup</a> </li> <li class="index-item property"> <a href="#property_collisionMask">collisionMask</a> </li> <li class="index-item property"> <a href="#property_direction">direction</a> </li> <li class="index-item property"> <a href="#property_from">from</a> </li> <li class="index-item property"> <a href="#property_length">length</a> </li> <li class="index-item property"> <a href="#property_mode">mode</a> </li> <li class="index-item property"> <a href="#property_skipBackfaces">skipBackfaces</a> </li> <li class="index-item property"> <a href="#property_to">to</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_getAABB" class="method item"> <h3 class="name"><code>getAABB</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>aabb</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l211"><code>src/collision/Ray.js:211</code></a> </p> </div> <div class="description"> <p>Get the AABB of the ray.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">aabb</code> <span class="type"><a href="../classes/AABB.html" class="crosslink">AABB</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_intersectBodies" class="method item"> <h3 class="name"><code>intersectBodies</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>bodies</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l125"><code>src/collision/Ray.js:125</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">bodies</code> <span class="type">Array</span> <div class="param-description"> <p>An array of Body objects.</p> </div> </li> </ul> </div> </div> <div id="method_intersectBody" class="method item private"> <h3 class="name"><code>intersectBody</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> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l141"><code>src/collision/Ray.js:141</code></a> </p> </div> <div class="description"> <p>Shoot a ray at a body, get back information about the hit.</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> <div id="method_intersectShape" class="method item private"> <h3 class="name"><code>intersectShape</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>angle</code> </li> <li class="arg"> <code>position</code> </li> <li class="arg"> <code>body</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l186"><code>src/collision/Ray.js:186</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">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">angle</code> <span class="type">Number</span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">position</code> <span class="type">Array</span> <div class="param-description"> </div> </li> <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> <div id="method_reportIntersection" class="method item private"> <h3 class="name"><code>reportIntersection</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>fraction</code> </li> <li class="arg"> <code>normal</code> </li> <li class="arg"> <code class="optional">[faceIndex=-1]</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Boolean</span> </span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l233"><code>src/collision/Ray.js:233</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">fraction</code> <span class="type">Number</span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">normal</code> <span class="type">Array</span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name optional">[faceIndex=-1]</code> <span class="type">Number</span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Boolean</span>: <p>True if the intersections should continue</p> </div> </div> </div> <div id="method_update" class="method item"> <h3 class="name"><code>update</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l111"><code>src/collision/Ray.js:111</code></a> </p> </div> <div class="description"> <p>Should be called if you change the from or to point.</p> </div> </div> </div> <div id="properties" class="api-class-tabpanel"> <h2 class="off-left">Properties</h2> <div id="property_ALL" class="property item"> <h3 class="name"><code>ALL</code></h3> <span class="type">Number</span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l104"><code>src/collision/Ray.js:104</code></a> </p> </div> <div class="description"> <p>This raycasting mode will traverse all intersection points and executes a callback for each one.</p> </div> </div> <div id="property_ANY" class="property item"> <h3 class="name"><code>ANY</code></h3> <span class="type">Number</span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l97"><code>src/collision/Ray.js:97</code></a> </p> </div> <div class="description"> <p>This raycasting mode will make the Ray stop when it finds the first intersection point.</p> </div> </div> <div id="property_callback" class="property item"> <h3 class="name"><code>callback</code></h3> <span class="type">Function</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l67"><code>src/collision/Ray.js:67</code></a> </p> </div> <div class="description"> <p>Current, user-provided result callback. Will be used if mode is Ray.ALL.</p> </div> </div> <div id="property_checkCollisionResponse" class="property item"> <h3 class="name"><code>checkCollisionResponse</code></h3> <span class="type">Boolean</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l37"><code>src/collision/Ray.js:37</code></a> </p> </div> <div class="description"> <p>Set to true if you want the Ray to take .collisionResponse flags into account on bodies and shapes.</p> </div> </div> <div id="property_CLOSEST" class="property item"> <h3 class="name"><code>CLOSEST</code></h3> <span class="type">Number</span> <span class="flag static">static</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l90"><code>src/collision/Ray.js:90</code></a> </p> </div> <div class="description"> <p>This raycasting mode will make the Ray traverse through all intersection points and only return the closest one.</p> </div> </div> <div id="property_collisionGroup" class="property item"> <h3 class="name"><code>collisionGroup</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l55"><code>src/collision/Ray.js:55</code></a> </p> </div> <div class="description"> </div> <p><strong>Default:</strong> -1</p> </div> <div id="property_collisionMask" class="property item"> <h3 class="name"><code>collisionMask</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l49"><code>src/collision/Ray.js:49</code></a> </p> </div> <div class="description"> </div> <p><strong>Default:</strong> -1</p> </div> <div id="property_direction" class="property item"> <h3 class="name"><code>direction</code></h3> <span class="type">Array</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l73"><code>src/collision/Ray.js:73</code></a> </p> </div> <div class="description"> </div> </div> <div id="property_from" class="property item"> <h3 class="name"><code>from</code></h3> <span class="type">Array</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l25"><code>src/collision/Ray.js:25</code></a> </p> </div> <div class="description"> <p>Ray start point.</p> </div> </div> <div id="property_length" class="property item"> <h3 class="name"><code>length</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l79"><code>src/collision/Ray.js:79</code></a> </p> </div> <div class="description"> <p>Length of the ray</p> </div> </div> <div id="property_mode" class="property item"> <h3 class="name"><code>mode</code></h3> <span class="type">Number</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l61"><code>src/collision/Ray.js:61</code></a> </p> </div> <div class="description"> <p>The intersection mode. Should be <a href="../classes/Ray.html#property_ANY" class="crosslink">Ray.ANY</a>, <a href="../classes/Ray.html#property_ALL" class="crosslink">Ray.ALL</a> or <a href="../classes/Ray.html#property_CLOSEST" class="crosslink">Ray.CLOSEST</a>.</p> </div> </div> <div id="property_skipBackfaces" class="property item"> <h3 class="name"><code>skipBackfaces</code></h3> <span class="type">Boolean</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l43"><code>src/collision/Ray.js:43</code></a> </p> </div> <div class="description"> <p>If set to true, the ray skips any hits with normal.dot(rayDirection) < 0.</p> </div> </div> <div id="property_to" class="property item"> <h3 class="name"><code>to</code></h3> <span class="type">Array</span> <div class="meta"> <p> Defined in <a href="../files/src_collision_Ray.js.html#l31"><code>src/collision/Ray.js:31</code></a> </p> </div> <div class="description"> <p>Ray end point</p> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> <script src="../assets/js/yui-prettify.js"></script> <script src="../assets/../api.js"></script> <script src="../assets/js/api-filter.js"></script> <script src="../assets/js/api-list.js"></script> <script src="../assets/js/api-search.js"></script> <script src="../assets/js/apidocs.js"></script> </body> </html>