<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PolyK.InteractionManager - pixi.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="shortcut icon" type="image/png" href="../assets/favicon.png">
<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="http://www.goodboydigital.com/pixijs/logo_small.png" title="pixi.js"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 1.4.3</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/AbstractFilter.html">AbstractFilter</a></li>
<li><a href="../classes/AlphaMaskFilter.html">AlphaMaskFilter</a></li>
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
<li><a href="../classes/AtlasLoader.html">AtlasLoader</a></li>
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
<li><a href="../classes/BlurFilter.html">BlurFilter</a></li>
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
<li><a href="../classes/Circle.html">Circle</a></li>
<li><a href="../classes/ColorMatrixFilter.html">ColorMatrixFilter</a></li>
<li><a href="../classes/ColorStepFilter.html">ColorStepFilter</a></li>
<li><a href="../classes/DisplacementFilter.html">DisplacementFilter</a></li>
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
<li><a href="../classes/DotScreenFilter.html">DotScreenFilter</a></li>
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/Graphics.html">Graphics</a></li>
<li><a href="../classes/GrayFilter.html">GrayFilter</a></li>
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
<li><a href="../classes/InvertFilter.html">InvertFilter</a></li>
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
<li><a href="../classes/PixelateFilter.html">PixelateFilter</a></li>
<li><a href="../classes/PIXI.PixiFastShader.html">PIXI.PixiFastShader</a></li>
<li><a href="../classes/PIXI.PixiShader.html">PIXI.PixiShader</a></li>
<li><a href="../classes/Point.html">Point</a></li>
<li><a href="../classes/Polygon.html">Polygon</a></li>
<li><a href="../classes/PolyK._convex.html">PolyK._convex</a></li>
<li><a href="../classes/PolyK._PointInTriangle.html">PolyK._PointInTriangle</a></li>
<li><a href="../classes/PolyK.AjaxRequest.html">PolyK.AjaxRequest</a></li>
<li><a href="../classes/PolyK.InteractionData.html">PolyK.InteractionData</a></li>
<li><a href="../classes/PolyK.InteractionManager.html">PolyK.InteractionManager</a></li>
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
<li><a href="../classes/SepiaFilter.html">SepiaFilter</a></li>
<li><a href="../classes/Spine.html">Spine</a></li>
<li><a href="../classes/Sprite.html">Sprite</a></li>
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
<li><a href="../classes/Stage.html">Stage</a></li>
<li><a href="../classes/Text.html">Text</a></li>
<li><a href="../classes/Texture.html">Texture</a></li>
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
<li><a href="../classes/TwistFilter.html">TwistFilter</a></li>
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/PIXI.html">PIXI</a></li>
</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>PolyK.InteractionManager Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_pixi_InteractionManager.js.html#l5"><code>src/pixi/InteractionManager.js:5</code></a>
</div>
Module: <a href="../modules/PIXI.html">PIXI</a>
</div>
<div class="box intro">
<p>The interaction manager deals with mouse and touch events. Any DisplayObject can be interactive
This manager also supports multitouch.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_PolyK.InteractionManager" class="method item">
<h3 class="name"><code>PolyK.InteractionManager</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>stage</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l5"><code>src/pixi/InteractionManager.js:5</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">stage</code>
<span class="type"><a href="../classes/Stage.html" class="crosslink">Stage</a></span>
<div class="param-description">
<p>The stage to handle interactions</p>
</div>
</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 private">
<a href="#method_collectInteractiveSprite">collectInteractiveSprite</a>
</li>
<li class="index-item method private">
<a href="#method_hitTest">hitTest</a>
</li>
<li class="index-item method private">
<a href="#method_onMouseDown">onMouseDown</a>
</li>
<li class="index-item method private">
<a href="#method_onMouseMove">onMouseMove</a>
</li>
<li class="index-item method private">
<a href="#method_onMouseUp">onMouseUp</a>
</li>
<li class="index-item method private">
<a href="#method_onTouchEnd">onTouchEnd</a>
</li>
<li class="index-item method private">
<a href="#method_onTouchMove">onTouchMove</a>
</li>
<li class="index-item method private">
<a href="#method_onTouchStart">onTouchStart</a>
</li>
<li class="index-item method private">
<a href="#method_setTarget">setTarget</a>
</li>
<li class="index-item method private">
<a href="#method_setTargetDomElement">setTargetDomElement</a>
</li>
<li class="index-item method private">
<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_mouse">mouse</a>
</li>
<li class="index-item property">
<a href="#property_stage">stage</a>
</li>
<li class="index-item property">
<a href="#property_touchs">touchs</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_collectInteractiveSprite" class="method item private">
<h3 class="name"><code>collectInteractiveSprite</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>displayObject</code>
</li>
<li class="arg">
<code>iParent</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l66"><code>src/pixi/InteractionManager.js:66</code></a>
</p>
</div>
<div class="description">
<p>Collects an interactive sprite recursively to have their interactions managed</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">displayObject</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
<p>the displayObject to collect</p>
</div>
</li>
<li class="param">
<code class="param-name">iParent</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method_hitTest" class="method item private">
<h3 class="name"><code>hitTest</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>item</code>
</li>
<li class="arg">
<code>interactionData</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l420"><code>src/pixi/InteractionManager.js:420</code></a>
</p>
</div>
<div class="description">
<p>Tests if the current mouse coords hit a sprite</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">item</code>
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
<div class="param-description">
<p>The displayObject to test for a hit</p>
</div>
</li>
<li class="param">
<code class="param-name">interactionData</code>
<span class="type">InteractionData</span>
<div class="param-description">
<p>The interactionData object to update in the case of a hit</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_onMouseDown" class="method item private">
<h3 class="name"><code>onMouseDown</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="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l307"><code>src/pixi/InteractionManager.js:307</code></a>
</p>
</div>
<div class="description">
<p>Is called when the mouse button is pressed down on the renderer element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Event</span>
<div class="param-description">
<p>The DOM event of a mouse button being pressed down</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_onMouseMove" class="method item private">
<h3 class="name"><code>onMouseMove</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="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l277"><code>src/pixi/InteractionManager.js:277</code></a>
</p>
</div>
<div class="description">
<p>Is called when the mouse moves across the renderer element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Event</span>
<div class="param-description">
<p>The DOM event of the mouse moving</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_onMouseUp" class="method item private">
<h3 class="name"><code>onMouseUp</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="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l370"><code>src/pixi/InteractionManager.js:370</code></a>
</p>
</div>
<div class="description">
<p>Is called when the mouse button is released on the renderer element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Event</span>
<div class="param-description">
<p>The DOM event of a mouse button being released</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_onTouchEnd" class="method item private">
<h3 class="name"><code>onTouchEnd</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="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l588"><code>src/pixi/InteractionManager.js:588</code></a>
</p>
</div>
<div class="description">
<p>Is called when a touch is ended on the renderer element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Event</span>
<div class="param-description">
<p>The DOM event of a touch ending on the renderer view</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_onTouchMove" class="method item private">
<h3 class="name"><code>onTouchMove</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="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l495"><code>src/pixi/InteractionManager.js:495</code></a>
</p>
</div>
<div class="description">
<p>Is called when a touch is moved across the renderer element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Event</span>
<div class="param-description">
<p>The DOM event of a touch moving across the renderer view</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_onTouchStart" class="method item private">
<h3 class="name"><code>onTouchStart</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="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l533"><code>src/pixi/InteractionManager.js:533</code></a>
</p>
</div>
<div class="description">
<p>Is called when a touch is started on the renderer element</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">event</code>
<span class="type">Event</span>
<div class="param-description">
<p>The DOM event of a touch starting on the renderer view</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_setTarget" class="method item private">
<h3 class="name"><code>setTarget</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>target</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l110"><code>src/pixi/InteractionManager.js:110</code></a>
</p>
</div>
<div class="description">
<p>Sets the target for event delegation</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">target</code>
<span class="type"><a href="../classes/WebGLRenderer.html" class="crosslink">WebGLRenderer</a> | <a href="../classes/CanvasRenderer.html" class="crosslink">CanvasRenderer</a></span>
<div class="param-description">
<p>the renderer to bind events to</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_setTargetDomElement" class="method item private">
<h3 class="name"><code>setTargetDomElement</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>domElement</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l131"><code>src/pixi/InteractionManager.js:131</code></a>
</p>
</div>
<div class="description">
<p>Sets the dom element which will receive mouse/touch events. This is useful for when you have other DOM
elements ontop of the renderers Canvas element. With this you'll be able to delegate another dom element
to receive those events</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">domElement</code>
<span class="type">DOMElement</span>
<div class="param-description">
<p>the dom element which will receive mouse and touch events</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_update" class="method item private">
<h3 class="name"><code>update</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l180"><code>src/pixi/InteractionManager.js:180</code></a>
</p>
</div>
<div class="description">
<p>updates the state of interactive objects</p>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_mouse" class="property item">
<h3 class="name"><code>mouse</code></h3>
<span class="type">InteractionData</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l23"><code>src/pixi/InteractionManager.js:23</code></a>
</p>
</div>
<div class="description">
<p>the mouse data</p>
</div>
</div>
<div id="property_stage" class="property item">
<h3 class="name"><code>stage</code></h3>
<span class="type"><a href="../classes/Stage.html" class="crosslink">Stage</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l15"><code>src/pixi/InteractionManager.js:15</code></a>
</p>
</div>
<div class="description">
<p>a reference to the stage</p>
</div>
</div>
<div id="property_touchs" class="property item">
<h3 class="name"><code>touchs</code></h3>
<span class="type">Object</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_pixi_InteractionManager.js.html#l31"><code>src/pixi/InteractionManager.js:31</code></a>
</p>
</div>
<div class="description">
<p>an object that stores current touches (InteractionData) by id reference</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>
