Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-12-18 09:03:29 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.QuadTree.html

1701 lines
26 KiB
HTML
Raw Normal View History

Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: QuadTree</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<li class="dropdown">
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.html">Phaser</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="Phaser.Animation.html">Animation</a>
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationManager.html">AnimationManager</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.AnimationParser.html">AnimationParser</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
Updated documentation.
2013-11-28 15:57:09 +00:00
<li>
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li>
<a href="Phaser.Button.html">Button</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Cache.html">Cache</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Camera.html">Camera</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Canvas.html">Canvas</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Circle.html">Circle</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Color.html">Color</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Device.html">Device</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.DOMSprite.html">DOMSprite</a>
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.Easing.html">Easing</a>
</li>
<li>
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li>
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li>
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li>
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li>
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li>
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li>
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li>
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li>
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li>
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li>
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Events.html">Events</a>
</li>
Updated documentation.
2013-11-28 15:57:09 +00:00
<li>
<a href="Phaser.Filter.html">Filter</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
<li>
<a href="Phaser.FrameData.html">FrameData</a>
More Docs!
2013-10-03 00:21:08 +00:00
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Game.html">Game</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li>
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Graphics.html">Graphics</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Group.html">Group</a>
</li>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<li>
<a href="Phaser.Image.html">Image</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Input.html">Input</a>
</li>
<li>
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li>
<a href="Phaser.Key.html">Key</a>
</li>
<li>
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.Line.html">Line</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li>
<a href="Phaser.Loader.html">Loader</a>
</li>
<li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="Phaser.LoaderParser.html">LoaderParser</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li>
<li>
<a href="Phaser.Math.html">Math</a>
</li>
<li>
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li>
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
Yet more documentation done.
2013-10-02 19:18:24 +00:00
<li>
<a href="Phaser.Net.html">Net</a>
</li>
<li>
<a href="Phaser.Particles.html">Particles</a>
</li>
<li>
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Physics.html">Physics</a>
</li>
<li>
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
Updated docs and more tidying up.
2013-10-25 16:30:37 +00:00
<li>
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li>
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li>
<a href="Phaser.Point.html">Point</a>
</li>
<li>
<a href="Phaser.Pointer.html">Pointer</a>
</li>
Added in a Group.sort demo, also updated the documentation and build files.
2013-11-07 06:10:15 +00:00
<li>
<a href="Phaser.Polygon.html">Polygon</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li>
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li>
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Signal.html">Signal</a>
</li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
<a href="Phaser.Sound.html">Sound</a>
</li>
<li>
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Sprite.html">Sprite</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Stage.html">Stage</a>
</li>
More Docs!
2013-10-03 00:21:08 +00:00
<li>
<a href="Phaser.StageScaleMode.html">StageScaleMode</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.State.html">State</a>
</li>
<li>
<a href="Phaser.StateManager.html">StateManager</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.Text.html">Text</a>
</li>
Updated documentation.
2013-11-28 15:57:09 +00:00
<li>
<a href="Phaser.Tile.html">Tile</a>
</li>
<li>
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li>
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li>
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li>
<a href="Phaser.Tileset.html">Tileset</a>
</li>
Lots of doc updates!
2013-10-25 15:54:40 +00:00
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<li>
<a href="Phaser.Time.html">Time</a>
</li>
Updated documentation.
2013-11-28 15:57:09 +00:00
<li>
<a href="Phaser.Timer.html">Timer</a>
</li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<li>
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<li>
<a href="Phaser.Tween.html">Tween</a>
</li>
<li>
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li>
<a href="Phaser.Utils.html">Utils</a>
</li>
<li>
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<li>
<a href="Phaser.World.html">World</a>
</li>
<li>
<a href="SignalBinding.html">SignalBinding</a>
</li>
</ul>
</li>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="global.html#canUseNewCanvasBlendModes">canUseNewCanvasBlendModes</a>
</li>
<li>
<a href="global.html#getNextPowerOfTwo">getNextPowerOfTwo</a>
</li>
<li>
<a href="global.html#hex2rgb">hex2rgb</a>
</li>
<li>
<a href="global.html#hitTest">hitTest</a>
</li>
<li>
<a href="global.html#rgb2hex">rgb2hex</a>
</li>
</ul>
</li>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: QuadTree</h1>
<section>
<header>
<h2>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
QuadTree
</h2>
Updated doc files.
2014-02-05 06:29:17 +00:00
<div class="class-description"><p>A QuadTree implementation. The original code was a conversion of the Java code posted to GameDevTuts.
However I've tweaked it massively to add node indexing, removed lots of temp. var creation and significantly increased performance as a result.
Original version at <a href="https://github.com/timohausmann/quadtree-js/">https://github.com/timohausmann/quadtree-js/</a></p></div>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</header>
<article>
<div class="container-overview">
<dt>
Updated doc files.
2014-02-05 06:29:17 +00:00
<h4 class="name" id="QuadTree"><span class="type-signature"></span>new QuadTree<span class="signature">(x, y, width, height, <span class="optional">maxObjects</span>, <span class="optional">maxLevels</span>, <span class="optional">level</span>)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
<div class="description">
<p>QuadTree Constructor</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
Updated doc files.
2014-02-05 06:29:17 +00:00
<th>Argument</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<th>Default</th>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="name"><code>x</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The top left coordinate of the quadtree.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type">number</span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="default">
</td>
<td class="description last"><p>The top left coordinate of the quadtree.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>width</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The width of the quadtree in pixels.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>height</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="default">
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The height of the quadtree in pixels.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>maxObjects</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
<td class="default">
10
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The maximum number of objects per node.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>maxLevels</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
<td class="default">
4
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The maximum number of levels to iterate to.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
<tr>
<td class="name"><code>level</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="attributes">
&lt;optional><br>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
</td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="default">
0
</td>
<td class="description last"><p>Which level is this?</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Fixed up the namespace in the documentation and finished off all sections other than Game Objects and Physics (yuck).
2013-10-03 01:38:35 +00:00
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-60">line 60</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>/*
Clear the quadtree.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-267">line 267</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getIndex"><span class="type-signature"></span>getIndex<span class="signature">(rect)</span><span class="type-signature"> &rarr; {number}</span></h4>
</dt>
<dd>
<div class="description">
<p>/*
Determine which node the object belongs to.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rect</code></td>
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type"><a href="Phaser.Rectangle.html">Phaser.Rectangle</a></span>
|
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type">object</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The bounds in which to check.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-186">line 186</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Updated documentation.
2013-11-28 15:57:09 +00:00
<p>index - Index of the subnode (0-3), or -1 if rect cannot completely fit within a subnode and is part of the parent node.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="insert"><span class="type-signature"></span>insert<span class="signature">(body)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>/*
Updated doc files.
2014-02-05 06:29:17 +00:00
Insert the object into the node. If the node exceeds the capacity, it will split and add all objects to their corresponding subnodes.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>body</code></td>
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type"><a href="Phaser.Physics.Arcade.Body.html">Phaser.Physics.Arcade.Body</a></span>
|
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<span class="param-type">object</span>
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The Body object to insert into the quadtree.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-134">line 134</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
<dt>
Updated doc files.
2014-02-05 06:29:17 +00:00
<h4 class="name" id="populate"><span class="type-signature"></span>populate<span class="signature">(group)</span><span class="type-signature"></span></h4>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</dt>
<dd>
<div class="description">
<p>/*
Updated doc files.
2014-02-05 06:29:17 +00:00
Populates this quadtree with the members of the given Group.</p>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="name"><code>group</code></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
<td class="type">
Updated doc files.
2014-02-05 06:29:17 +00:00
<span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span>
</td>
<td class="description last"><p>The Group to add to the quadtree.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-84">line 84</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="populateHandler"><span class="type-signature"></span>populateHandler<span class="signature">(sprite)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>/*
Handler for the populate method.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
</td>
<td class="description last"><p>The Sprite to check.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-96">line 96</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="retrieve"><span class="type-signature"></span>retrieve<span class="signature">(sprite)</span><span class="type-signature"> &rarr; {array}</span></h4>
</dt>
<dd>
<div class="description">
<p>/*
Return all objects that could collide with the given Sprite.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sprite</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Sprite.html">Phaser.Sprite</a></span>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</td>
Updated doc files.
2014-02-05 06:29:17 +00:00
<td class="description last"><p>The sprite to check against.</p></td>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-230">line 230</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>Array with all detected objects.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="split"><span class="type-signature"></span>split<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>/*
Split the node into 4 subnodes</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
Updated doc files.
2014-02-05 06:29:17 +00:00
<a href="QuadTree.js.html">math/QuadTree.js</a>, <a href="QuadTree.js.html#sunlight-1-line-111">line 111</a>
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Updated doc files.
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</span>
<br />
<span class="jsdoc-message">
Lots of doc updates!
2013-10-25 15:54:40 +00:00
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
Tilemap had the wrong @method signatures so most were missing from the docs.
2014-02-08 07:24:22 +00:00
on Sat Feb 08 2014 07:19:49 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
Input, Loader and Math docs tidied up.
2013-10-02 14:05:55 +00:00
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue Copy permalink