input_Key.js.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: input/Key.js</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">Source: input/Key.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>/**
  20. * Key is used by Keyboard, Pointer, etc, to represent a key state.
  21. *
  22. * @class
  23. */
  24. function Key()
  25. {
  26. /**
  27. * Indicates if this key is currently pressed.
  28. */
  29. this.pressed = false;
  30. /**
  31. * Indicates if this key was just pressed.
  32. */
  33. this.justPressed = false;
  34. /**
  35. * Indicates if this key was just released.
  36. */
  37. this.justReleased = false;
  38. }
  39. Key.DOWN = -1;
  40. Key.UP = 1;
  41. Key.RESET = 0;
  42. Key.prototype.constructor = Key;
  43. /**
  44. * Update Key status based on new key state.
  45. */
  46. Key.prototype.update = function(action)
  47. {
  48. this.justPressed = false;
  49. this.justReleased = false;
  50. if(action === Key.DOWN)
  51. {
  52. if(this.pressed === false)
  53. {
  54. this.justPressed = true;
  55. }
  56. this.pressed = true;
  57. }
  58. else if(action === Key.UP)
  59. {
  60. if(this.pressed)
  61. {
  62. this.justReleased = true;
  63. }
  64. this.pressed = false;
  65. }
  66. else if(action === Key.RESET)
  67. {
  68. this.justReleased = false;
  69. this.justPressed = false;
  70. }
  71. };
  72. /**
  73. * Set this key attributes manually.
  74. */
  75. Key.prototype.set = function(justPressed, pressed, justReleased)
  76. {
  77. this.justPressed = justPressed;
  78. this.pressed = pressed;
  79. this.justReleased = justReleased;
  80. };
  81. /**
  82. * Reset key to default values.
  83. */
  84. Key.prototype.reset = function()
  85. {
  86. this.justPressed = false;
  87. this.pressed = false;
  88. this.justReleased = false;
  89. };
  90. export {Key};
  91. </code></pre>
  92. </article>
  93. </section>
  94. </div>
  95. <nav>
  96. <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="FileUtils.html">FileUtils</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="MultiLineText.html">MultiLineText</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeConnector.html">NodeConnector</a></li><li><a href="NodeGraph.html">NodeGraph</a></li><li><a href="NodeSocket.html">NodeSocket</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="QuadraticCurve.html">QuadraticCurve</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="RoundedBox.html">RoundedBox</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><h3>Global</h3><ul><li><a href="global.html#writeFile">writeFile</a></li></ul>
  97. </nav>
  98. <br class="clear">
  99. <footer>
  100. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Mon May 18 2020 18:40:48 GMT+0100 (Western European Summer Time)
  101. </footer>
  102. <script> prettyPrint(); </script>
  103. <script src="scripts/linenumber.js"> </script>
  104. </body>
  105. </html>