Key.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Key</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: Key</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>Key<span class="signature">()</span><span class="type-signature"></span></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="Key"><span class="type-signature"></span>new Key<span class="signature">()</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. Key is used by Keyboard, Pointer, etc, to represent a key state.
  26. </div>
  27. <dl class="details">
  28. <dt class="tag-source">Source:</dt>
  29. <dd class="tag-source"><ul class="dummy"><li>
  30. <a href="input_Key.js.html">input/Key.js</a>, <a href="input_Key.js.html#line8">line 8</a>
  31. </li></ul></dd>
  32. </dl>
  33. </div>
  34. <h3 class="subsection-title">Members</h3>
  35. <h4 class="name" id="justPressed"><span class="type-signature"></span>justPressed<span class="type-signature"></span></h4>
  36. <div class="description">
  37. Indicates if this key was just pressed.
  38. </div>
  39. <dl class="details">
  40. <dt class="tag-source">Source:</dt>
  41. <dd class="tag-source"><ul class="dummy"><li>
  42. <a href="input_Key.js.html">input/Key.js</a>, <a href="input_Key.js.html#line18">line 18</a>
  43. </li></ul></dd>
  44. </dl>
  45. <h4 class="name" id="justReleased"><span class="type-signature"></span>justReleased<span class="type-signature"></span></h4>
  46. <div class="description">
  47. Indicates if this key was just released.
  48. </div>
  49. <dl class="details">
  50. <dt class="tag-source">Source:</dt>
  51. <dd class="tag-source"><ul class="dummy"><li>
  52. <a href="input_Key.js.html">input/Key.js</a>, <a href="input_Key.js.html#line23">line 23</a>
  53. </li></ul></dd>
  54. </dl>
  55. <h4 class="name" id="pressed"><span class="type-signature"></span>pressed<span class="type-signature"></span></h4>
  56. <div class="description">
  57. Indicates if this key is currently pressed.
  58. </div>
  59. <dl class="details">
  60. <dt class="tag-source">Source:</dt>
  61. <dd class="tag-source"><ul class="dummy"><li>
  62. <a href="input_Key.js.html">input/Key.js</a>, <a href="input_Key.js.html#line13">line 13</a>
  63. </li></ul></dd>
  64. </dl>
  65. <h3 class="subsection-title">Methods</h3>
  66. <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class="signature">()</span><span class="type-signature"></span></h4>
  67. <div class="description">
  68. Reset key to default values.
  69. </div>
  70. <dl class="details">
  71. <dt class="tag-source">Source:</dt>
  72. <dd class="tag-source"><ul class="dummy"><li>
  73. <a href="input_Key.js.html">input/Key.js</a>, <a href="input_Key.js.html#line77">line 77</a>
  74. </li></ul></dd>
  75. </dl>
  76. <h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">()</span><span class="type-signature"></span></h4>
  77. <div class="description">
  78. Set this key attributes manually.
  79. </div>
  80. <dl class="details">
  81. <dt class="tag-source">Source:</dt>
  82. <dd class="tag-source"><ul class="dummy"><li>
  83. <a href="input_Key.js.html">input/Key.js</a>, <a href="input_Key.js.html#line67">line 67</a>
  84. </li></ul></dd>
  85. </dl>
  86. <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
  87. <div class="description">
  88. Update Key status based on new key state.
  89. </div>
  90. <dl class="details">
  91. <dt class="tag-source">Source:</dt>
  92. <dd class="tag-source"><ul class="dummy"><li>
  93. <a href="input_Key.js.html">input/Key.js</a>, <a href="input_Key.js.html#line36">line 36</a>
  94. </li></ul></dd>
  95. </dl>
  96. </article>
  97. </section>
  98. </div>
  99. <nav>
  100. <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>
  101. </nav>
  102. <br class="clear">
  103. <footer>
  104. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Thu Jun 13 2019 09:46:06 GMT+0100 (Western European Summer Time)
  105. </footer>
  106. <script> prettyPrint(); </script>
  107. <script src="scripts/linenumber.js"> </script>
  108. </body>
  109. </html>