Pointer.html 26 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Pointer</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: Pointer</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>Pointer<span class="signature">(domElement, canvas)</span><span class="type-signature"></span></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="Pointer"><span class="type-signature"></span>new Pointer<span class="signature">(domElement, canvas)</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. Pointer object is used to colled input from the user, works for booth mouse or touch screens. It is responsible for syncronizing user input with the render of the graphics.
  26. </div>
  27. <h5>Parameters:</h5>
  28. <table class="params">
  29. <thead>
  30. <tr>
  31. <th>Name</th>
  32. <th>Type</th>
  33. <th class="last">Description</th>
  34. </tr>
  35. </thead>
  36. <tbody>
  37. <tr>
  38. <td class="name"><code>domElement</code></td>
  39. <td class="type">
  40. <span class="param-type"><a href="DOM.html">DOM</a></span>
  41. </td>
  42. <td class="description last">DOM element to craete the pointer events.</td>
  43. </tr>
  44. <tr>
  45. <td class="name"><code>canvas</code></td>
  46. <td class="type">
  47. <span class="param-type"><a href="DOM.html">DOM</a></span>
  48. </td>
  49. <td class="description last">Canvas DOM element where the content is being drawn.</td>
  50. </tr>
  51. </tbody>
  52. </table>
  53. <dl class="details">
  54. <dt class="tag-source">Source:</dt>
  55. <dd class="tag-source"><ul class="dummy"><li>
  56. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line16">line 16</a>
  57. </li></ul></dd>
  58. </dl>
  59. </div>
  60. <h3 class="subsection-title">Members</h3>
  61. <h4 class="name" id=".BACK"><span class="type-signature">(static) </span>BACK<span class="type-signature"></span></h4>
  62. <div class="description">
  63. Back pointer navigation button.
  64. </div>
  65. <dl class="details">
  66. <dt class="tag-source">Source:</dt>
  67. <dd class="tag-source"><ul class="dummy"><li>
  68. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line207">line 207</a>
  69. </li></ul></dd>
  70. </dl>
  71. <h4 class="name" id=".FORWARD"><span class="type-signature">(static) </span>FORWARD<span class="type-signature"></span></h4>
  72. <div class="description">
  73. Forward pointer navigation button.
  74. </div>
  75. <dl class="details">
  76. <dt class="tag-source">Source:</dt>
  77. <dd class="tag-source"><ul class="dummy"><li>
  78. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line212">line 212</a>
  79. </li></ul></dd>
  80. </dl>
  81. <h4 class="name" id=".LEFT"><span class="type-signature">(static) </span>LEFT<span class="type-signature"></span></h4>
  82. <div class="description">
  83. Left pointer button.
  84. </div>
  85. <dl class="details">
  86. <dt class="tag-source">Source:</dt>
  87. <dd class="tag-source"><ul class="dummy"><li>
  88. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line192">line 192</a>
  89. </li></ul></dd>
  90. </dl>
  91. <h4 class="name" id=".MIDDLE"><span class="type-signature">(static) </span>MIDDLE<span class="type-signature"></span></h4>
  92. <div class="description">
  93. Middle pointer button.
  94. </div>
  95. <dl class="details">
  96. <dt class="tag-source">Source:</dt>
  97. <dd class="tag-source"><ul class="dummy"><li>
  98. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line197">line 197</a>
  99. </li></ul></dd>
  100. </dl>
  101. <h4 class="name" id=".RIGHT"><span class="type-signature">(static) </span>RIGHT<span class="type-signature"></span></h4>
  102. <div class="description">
  103. Right pointer button.
  104. </div>
  105. <dl class="details">
  106. <dt class="tag-source">Source:</dt>
  107. <dd class="tag-source"><ul class="dummy"><li>
  108. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line202">line 202</a>
  109. </li></ul></dd>
  110. </dl>
  111. <h4 class="name" id="canvas"><span class="type-signature"></span>canvas<span class="type-signature"></span></h4>
  112. <div class="description">
  113. Canvas attached to this pointer instance used to calculate position and delta in element space coordinates.
  114. </div>
  115. <dl class="details">
  116. <dt class="tag-source">Source:</dt>
  117. <dd class="tag-source"><ul class="dummy"><li>
  118. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line60">line 60</a>
  119. </li></ul></dd>
  120. </dl>
  121. <h4 class="name" id="delta"><span class="type-signature"></span>delta<span class="type-signature"></span></h4>
  122. <div class="description">
  123. Pointer movement (coordinates in window space).
  124. </div>
  125. <dl class="details">
  126. <dt class="tag-source">Source:</dt>
  127. <dd class="tag-source"><ul class="dummy"><li>
  128. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line40">line 40</a>
  129. </li></ul></dd>
  130. </dl>
  131. <h4 class="name" id="domElement"><span class="type-signature"></span>domElement<span class="type-signature"></span></h4>
  132. <div class="description">
  133. DOM element where to attach the pointer events.
  134. </div>
  135. <dl class="details">
  136. <dt class="tag-source">Source:</dt>
  137. <dd class="tag-source"><ul class="dummy"><li>
  138. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line55">line 55</a>
  139. </li></ul></dd>
  140. </dl>
  141. <h4 class="name" id="doubleClicked"><span class="type-signature"></span>doubleClicked<span class="type-signature"></span></h4>
  142. <div class="description">
  143. Indicates a button of the pointer was double clicked.
  144. </div>
  145. <dl class="details">
  146. <dt class="tag-source">Source:</dt>
  147. <dd class="tag-source"><ul class="dummy"><li>
  148. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line50">line 50</a>
  149. </li></ul></dd>
  150. </dl>
  151. <h4 class="name" id="events"><span class="type-signature"></span>events<span class="type-signature"></span></h4>
  152. <div class="description">
  153. Event manager responsible for updating the raw data variables. Diferent events are used depending on the host platform. When the update method is called the raw data is reset.
  154. </div>
  155. <dl class="details">
  156. <dt class="tag-source">Source:</dt>
  157. <dd class="tag-source"><ul class="dummy"><li>
  158. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line73">line 73</a>
  159. </li></ul></dd>
  160. </dl>
  161. <h4 class="name" id="keys"><span class="type-signature"></span>keys<span class="type-signature"></span></h4>
  162. <div class="description">
  163. Array with pointer buttons status.
  164. </div>
  165. <dl class="details">
  166. <dt class="tag-source">Source:</dt>
  167. <dd class="tag-source"><ul class="dummy"><li>
  168. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line30">line 30</a>
  169. </li></ul></dd>
  170. </dl>
  171. <h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"></span></h4>
  172. <div class="description">
  173. Pointer position inside of the window (coordinates in window space).
  174. </div>
  175. <dl class="details">
  176. <dt class="tag-source">Source:</dt>
  177. <dd class="tag-source"><ul class="dummy"><li>
  178. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line35">line 35</a>
  179. </li></ul></dd>
  180. </dl>
  181. <h4 class="name" id="wheel"><span class="type-signature"></span>wheel<span class="type-signature"></span></h4>
  182. <div class="description">
  183. Pointer scroll wheel movement.
  184. </div>
  185. <dl class="details">
  186. <dt class="tag-source">Source:</dt>
  187. <dd class="tag-source"><ul class="dummy"><li>
  188. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line45">line 45</a>
  189. </li></ul></dd>
  190. </dl>
  191. <h3 class="subsection-title">Methods</h3>
  192. <h4 class="name" id=".buttonDoubleClicked"><span class="type-signature">(static) </span>buttonDoubleClicked<span class="signature">(button)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  193. <div class="description">
  194. Check if pointer button was double clicked.
  195. </div>
  196. <h5>Parameters:</h5>
  197. <table class="params">
  198. <thead>
  199. <tr>
  200. <th>Name</th>
  201. <th>Type</th>
  202. <th class="last">Description</th>
  203. </tr>
  204. </thead>
  205. <tbody>
  206. <tr>
  207. <td class="name"><code>button</code></td>
  208. <td class="type">
  209. <span class="param-type">Number</span>
  210. </td>
  211. <td class="description last">Button to check status of</td>
  212. </tr>
  213. </tbody>
  214. </table>
  215. <dl class="details">
  216. <dt class="tag-source">Source:</dt>
  217. <dd class="tag-source"><ul class="dummy"><li>
  218. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line263">line 263</a>
  219. </li></ul></dd>
  220. </dl>
  221. <h5>Returns:</h5>
  222. <div class="param-desc">
  223. True if some pointer button was just double clicked
  224. </div>
  225. <dl>
  226. <dt>
  227. Type
  228. </dt>
  229. <dd>
  230. <span class="param-type">boolean</span>
  231. </dd>
  232. </dl>
  233. <h4 class="name" id=".buttonJustPressed"><span class="type-signature">(static) </span>buttonJustPressed<span class="signature">(button)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  234. <div class="description">
  235. Check if a pointer button was just pressed.
  236. </div>
  237. <h5>Parameters:</h5>
  238. <table class="params">
  239. <thead>
  240. <tr>
  241. <th>Name</th>
  242. <th>Type</th>
  243. <th class="last">Description</th>
  244. </tr>
  245. </thead>
  246. <tbody>
  247. <tr>
  248. <td class="name"><code>button</code></td>
  249. <td class="type">
  250. <span class="param-type">Number</span>
  251. </td>
  252. <td class="description last">Button to check status of</td>
  253. </tr>
  254. </tbody>
  255. </table>
  256. <dl class="details">
  257. <dt class="tag-source">Source:</dt>
  258. <dd class="tag-source"><ul class="dummy"><li>
  259. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line274">line 274</a>
  260. </li></ul></dd>
  261. </dl>
  262. <h5>Returns:</h5>
  263. <div class="param-desc">
  264. True if button was just pressed
  265. </div>
  266. <dl>
  267. <dt>
  268. Type
  269. </dt>
  270. <dd>
  271. <span class="param-type">boolean</span>
  272. </dd>
  273. </dl>
  274. <h4 class="name" id=".buttonJustReleased"><span class="type-signature">(static) </span>buttonJustReleased<span class="signature">(button)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  275. <div class="description">
  276. Check if a pointer button was just released.
  277. </div>
  278. <h5>Parameters:</h5>
  279. <table class="params">
  280. <thead>
  281. <tr>
  282. <th>Name</th>
  283. <th>Type</th>
  284. <th class="last">Description</th>
  285. </tr>
  286. </thead>
  287. <tbody>
  288. <tr>
  289. <td class="name"><code>button</code></td>
  290. <td class="type">
  291. <span class="param-type">Number</span>
  292. </td>
  293. <td class="description last">Button to check status of</td>
  294. </tr>
  295. </tbody>
  296. </table>
  297. <dl class="details">
  298. <dt class="tag-source">Source:</dt>
  299. <dd class="tag-source"><ul class="dummy"><li>
  300. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line285">line 285</a>
  301. </li></ul></dd>
  302. </dl>
  303. <h5>Returns:</h5>
  304. <div class="param-desc">
  305. True if button was just released
  306. </div>
  307. <dl>
  308. <dt>
  309. Type
  310. </dt>
  311. <dd>
  312. <span class="param-type">boolean</span>
  313. </dd>
  314. </dl>
  315. <h4 class="name" id=".buttonPressed"><span class="type-signature">(static) </span>buttonPressed<span class="signature">(button)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  316. <div class="description">
  317. Check if pointer button is currently pressed.
  318. </div>
  319. <h5>Parameters:</h5>
  320. <table class="params">
  321. <thead>
  322. <tr>
  323. <th>Name</th>
  324. <th>Type</th>
  325. <th class="last">Description</th>
  326. </tr>
  327. </thead>
  328. <tbody>
  329. <tr>
  330. <td class="name"><code>button</code></td>
  331. <td class="type">
  332. <span class="param-type">Number</span>
  333. </td>
  334. <td class="description last">Button to check status of</td>
  335. </tr>
  336. </tbody>
  337. </table>
  338. <dl class="details">
  339. <dt class="tag-source">Source:</dt>
  340. <dd class="tag-source"><ul class="dummy"><li>
  341. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line252">line 252</a>
  342. </li></ul></dd>
  343. </dl>
  344. <h5>Returns:</h5>
  345. <div class="param-desc">
  346. True if button is currently pressed
  347. </div>
  348. <dl>
  349. <dt>
  350. Type
  351. </dt>
  352. <dd>
  353. <span class="param-type">boolean</span>
  354. </dd>
  355. </dl>
  356. <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">()</span><span class="type-signature"></span></h4>
  357. <div class="description">
  358. Create pointer events.
  359. </div>
  360. <dl class="details">
  361. <dt class="tag-source">Source:</dt>
  362. <dd class="tag-source"><ul class="dummy"><li>
  363. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line392">line 392</a>
  364. </li></ul></dd>
  365. </dl>
  366. <h4 class="name" id=".dispose"><span class="type-signature">(static) </span>dispose<span class="signature">()</span><span class="type-signature"></span></h4>
  367. <div class="description">
  368. Dispose pointer events.
  369. </div>
  370. <dl class="details">
  371. <dt class="tag-source">Source:</dt>
  372. <dd class="tag-source"><ul class="dummy"><li>
  373. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line400">line 400</a>
  374. </li></ul></dd>
  375. </dl>
  376. <h4 class="name" id=".insideCanvas"><span class="type-signature">(static) </span>insideCanvas<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  377. <div class="description">
  378. Check if pointer is inside attached canvas (updated async).
  379. </div>
  380. <dl class="details">
  381. <dt class="tag-source">Source:</dt>
  382. <dd class="tag-source"><ul class="dummy"><li>
  383. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line241">line 241</a>
  384. </li></ul></dd>
  385. </dl>
  386. <h5>Returns:</h5>
  387. <div class="param-desc">
  388. True if pointer is currently inside the canvas
  389. </div>
  390. <dl>
  391. <dt>
  392. Type
  393. </dt>
  394. <dd>
  395. <span class="param-type">boolean</span>
  396. </dd>
  397. </dl>
  398. <h4 class="name" id=".setCanvas"><span class="type-signature">(static) </span>setCanvas<span class="signature">(canvas)</span><span class="type-signature"></span></h4>
  399. <div class="description">
  400. Element to be used for coordinates calculation relative to that canvas.
  401. </div>
  402. <h5>Parameters:</h5>
  403. <table class="params">
  404. <thead>
  405. <tr>
  406. <th>Name</th>
  407. <th>Type</th>
  408. <th class="last">Description</th>
  409. </tr>
  410. </thead>
  411. <tbody>
  412. <tr>
  413. <td class="name"><code>canvas</code></td>
  414. <td class="type">
  415. <span class="param-type"><a href="DOM.html">DOM</a></span>
  416. </td>
  417. <td class="description last">Canvas to be attached to the Pointer instance</td>
  418. </tr>
  419. </tbody>
  420. </table>
  421. <dl class="details">
  422. <dt class="tag-source">Source:</dt>
  423. <dd class="tag-source"><ul class="dummy"><li>
  424. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line219">line 219</a>
  425. </li></ul></dd>
  426. </dl>
  427. <h4 class="name" id=".update"><span class="type-signature">(static) </span>update<span class="signature">()</span><span class="type-signature"></span></h4>
  428. <div class="description">
  429. Update pointer buttons state, position, wheel and delta synchronously.
  430. </div>
  431. <dl class="details">
  432. <dt class="tag-source">Source:</dt>
  433. <dd class="tag-source"><ul class="dummy"><li>
  434. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line334">line 334</a>
  435. </li></ul></dd>
  436. </dl>
  437. <h4 class="name" id=".updateKey"><span class="type-signature">(static) </span>updateKey<span class="signature">(button, action)</span><span class="type-signature"></span></h4>
  438. <div class="description">
  439. Update a pointer button. Automatically called by the runtime.
  440. </div>
  441. <h5>Parameters:</h5>
  442. <table class="params">
  443. <thead>
  444. <tr>
  445. <th>Name</th>
  446. <th>Type</th>
  447. <th class="last">Description</th>
  448. </tr>
  449. </thead>
  450. <tbody>
  451. <tr>
  452. <td class="name"><code>button</code></td>
  453. <td class="type">
  454. <span class="param-type">Number</span>
  455. </td>
  456. <td class="description last"></td>
  457. </tr>
  458. <tr>
  459. <td class="name"><code>action</code></td>
  460. <td class="type">
  461. <span class="param-type">Number</span>
  462. </td>
  463. <td class="description last"></td>
  464. </tr>
  465. </tbody>
  466. </table>
  467. <dl class="details">
  468. <dt class="tag-source">Source:</dt>
  469. <dd class="tag-source"><ul class="dummy"><li>
  470. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line323">line 323</a>
  471. </li></ul></dd>
  472. </dl>
  473. <h4 class="name" id=".updatePosition"><span class="type-signature">(static) </span>updatePosition<span class="signature">(x, y, xDiff, yDiff)</span><span class="type-signature"></span></h4>
  474. <div class="description">
  475. Update pointer position. Automatically called by the runtime.
  476. </div>
  477. <h5>Parameters:</h5>
  478. <table class="params">
  479. <thead>
  480. <tr>
  481. <th>Name</th>
  482. <th>Type</th>
  483. <th class="last">Description</th>
  484. </tr>
  485. </thead>
  486. <tbody>
  487. <tr>
  488. <td class="name"><code>x</code></td>
  489. <td class="type">
  490. <span class="param-type">Number</span>
  491. </td>
  492. <td class="description last"></td>
  493. </tr>
  494. <tr>
  495. <td class="name"><code>y</code></td>
  496. <td class="type">
  497. <span class="param-type">Number</span>
  498. </td>
  499. <td class="description last"></td>
  500. </tr>
  501. <tr>
  502. <td class="name"><code>xDiff</code></td>
  503. <td class="type">
  504. <span class="param-type">Number</span>
  505. </td>
  506. <td class="description last"></td>
  507. </tr>
  508. <tr>
  509. <td class="name"><code>yDiff</code></td>
  510. <td class="type">
  511. <span class="param-type">Number</span>
  512. </td>
  513. <td class="description last"></td>
  514. </tr>
  515. </tbody>
  516. </table>
  517. <dl class="details">
  518. <dt class="tag-source">Source:</dt>
  519. <dd class="tag-source"><ul class="dummy"><li>
  520. <a href="input_Pointer.js.html">input/Pointer.js</a>, <a href="input_Pointer.js.html#line300">line 300</a>
  521. </li></ul></dd>
  522. </dl>
  523. </article>
  524. </section>
  525. </div>
  526. <nav>
  527. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul>
  528. </nav>
  529. <br class="clear">
  530. <footer>
  531. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Tue Jun 25 2019 14:27:21 GMT+0100 (Western European Summer Time)
  532. </footer>
  533. <script> prettyPrint(); </script>
  534. <script src="scripts/linenumber.js"> </script>
  535. </body>
  536. </html>