2
0

input_Key.js.html 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  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. * @type {boolean}
  30. */
  31. this.pressed = false;
  32. /**
  33. * Indicates if this key was just pressed.
  34. *
  35. * @type {boolean}
  36. */
  37. this.justPressed = false;
  38. /**
  39. * Indicates if this key was just released.
  40. *
  41. * @type {boolean}
  42. */
  43. this.justReleased = false;
  44. }
  45. /**
  46. * Key down event.
  47. *
  48. * @type {number}
  49. */
  50. Key.DOWN = -1;
  51. /**
  52. * Key up event.
  53. *
  54. * @type {number}
  55. */
  56. Key.UP = 1;
  57. /**
  58. * Key reset event.
  59. *
  60. * @type {number}
  61. */
  62. Key.RESET = 0;
  63. Key.prototype.constructor = Key;
  64. /**
  65. * Update Key status based on new key state.
  66. *
  67. * @param {number} action Key action that was performed.
  68. */
  69. Key.prototype.update = function(action)
  70. {
  71. this.justPressed = false;
  72. this.justReleased = false;
  73. if(action === Key.DOWN)
  74. {
  75. if(this.pressed === false)
  76. {
  77. this.justPressed = true;
  78. }
  79. this.pressed = true;
  80. }
  81. else if(action === Key.UP)
  82. {
  83. if(this.pressed)
  84. {
  85. this.justReleased = true;
  86. }
  87. this.pressed = false;
  88. }
  89. else if(action === Key.RESET)
  90. {
  91. this.justReleased = false;
  92. this.justPressed = false;
  93. }
  94. };
  95. /**
  96. * Set this key attributes manually.
  97. *
  98. * @param {boolean} justPressed Indicates if the button was just pressed.
  99. * @param {boolean} pressed Indicates if the button is currently being pressed.
  100. * @param {boolean} justReleased Indicates if the button was just released.
  101. */
  102. Key.prototype.set = function(justPressed, pressed, justReleased)
  103. {
  104. this.justPressed = justPressed;
  105. this.pressed = pressed;
  106. this.justReleased = justReleased;
  107. };
  108. /**
  109. * Reset key to default values.
  110. */
  111. Key.prototype.reset = function()
  112. {
  113. this.justPressed = false;
  114. this.pressed = false;
  115. this.justReleased = false;
  116. };
  117. export {Key};
  118. </code></pre>
  119. </article>
  120. </section>
  121. </div>
  122. <nav>
  123. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnimationTimer.html">AnimationTimer</a></li><li><a href="BarGraph.html">BarGraph</a></li><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="ColorStyle.html">ColorStyle</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="Gauge.html">Gauge</a></li><li><a href="GradientColorStop.html">GradientColorStop</a></li><li><a href="GradientStyle.html">GradientStyle</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="LinearGradientStyle.html">LinearGradientStyle</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="Path.html">Path</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="PatternStyle.html">PatternStyle</a></li><li><a href="PieChart.html">PieChart</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="QuadraticCurve.html">QuadraticCurve</a></li><li><a href="RadialGradientStyle.html">RadialGradientStyle</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="RoundedBox.html">RoundedBox</a></li><li><a href="ScatterGraph.html">ScatterGraph</a></li><li><a href="Style.html">Style</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>
  124. </nav>
  125. <br class="clear">
  126. <footer>
  127. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sat Sep 17 2022 14:24:36 GMT+0100 (Hora de verão da Europa Ocidental)
  128. </footer>
  129. <script> prettyPrint(); </script>
  130. <script src="scripts/linenumber.js"> </script>
  131. </body>
  132. </html>