controls_ViewportControls.js.html 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: controls/ViewportControls.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: controls/ViewportControls.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>"use strict";
  20. import {Viewport} from "../Viewport.js";
  21. import {Pointer} from "../input/Pointer.js";
  22. import {Vector2} from "../math/Vector2.js";
  23. /**
  24. * Viewport controls are used to allow the user to control the viewport.
  25. *
  26. * @class
  27. * @param {Viewport} viewport
  28. */
  29. function ViewportControls(viewport)
  30. {
  31. /**
  32. * Viewport being controlled by this object.
  33. */
  34. this.viewport = viewport;
  35. /**
  36. * Button used to drag and viewport around.
  37. *
  38. * On touch enabled devices the touch event is represented as a LEFT button.
  39. */
  40. this.dragButton = Pointer.RIGHT;
  41. /**
  42. * Is set to true allow the viewport to be scalled.
  43. *
  44. * Scaling is performed using the pointer scroll.
  45. */
  46. this.allowScale = true;
  47. /**
  48. * Flag to indicate if the viewport should move when scalling.
  49. *
  50. * For some application its easier to focus the target if the viewport moves to the pointer location while scalling.
  51. */
  52. this.moveOnScale = false;
  53. /**
  54. * If true allows the viewport to be rotated.
  55. *
  56. * Rotation is performed by holding the RIGHT and LEFT pointer buttons and rotating around the initial point.
  57. */
  58. this.allowRotation = true;
  59. /**
  60. * Value of the initial point of rotation if the viewport is being rotated.
  61. *
  62. * Is set to null when the viewport is not being rotated.
  63. */
  64. this.rotationPoint = null;
  65. /**
  66. * Initial rotation of the viewport.
  67. */
  68. this.rotationInitial = 0;
  69. }
  70. /**
  71. * Update the viewport controls using the pointer object.
  72. *
  73. * Should be called every frame before rendering.
  74. *
  75. * @param {Pointer} pointer
  76. */
  77. ViewportControls.prototype.update = function(pointer)
  78. {
  79. // Scale
  80. if(this.allowScale &amp;&amp; pointer.wheel !== 0)
  81. {
  82. var scale = pointer.wheel * 1e-3 * this.viewport.scale;
  83. this.viewport.scale -= scale;
  84. this.viewport.matrixNeedsUpdate = true;
  85. // Move on scale
  86. if(this.moveOnScale &amp;&amp; pointer.canvas !== null)
  87. {
  88. this.viewport.updateMatrix();
  89. var pointerWorld = this.viewport.inverseMatrix.transformPoint(pointer.position);
  90. var centerWorld = new Vector2(pointer.canvas.width / 2.0, pointer.canvas.height / 2.0);
  91. centerWorld = this.viewport.inverseMatrix.transformPoint(centerWorld);
  92. var delta = pointerWorld.clone();
  93. delta.sub(centerWorld);
  94. delta.multiplyScalar(0.1);
  95. this.viewport.position.sub(delta);
  96. this.viewport.matrixNeedsUpdate = true;
  97. }
  98. }
  99. // Rotation
  100. if(this.allowRotation &amp;&amp; pointer.buttonPressed(Pointer.RIGHT) &amp;&amp; pointer.buttonPressed(Pointer.LEFT))
  101. {
  102. // Rotation pivot
  103. if(this.rotationPoint === null)
  104. {
  105. this.rotationPoint = pointer.position.clone();
  106. this.rotationInitial = this.viewport.rotation;
  107. }
  108. else
  109. {
  110. var pointer = pointer.position.clone();
  111. pointer.sub(this.rotationPoint);
  112. this.viewport.rotation = this.rotationInitial + pointer.angle();
  113. this.viewport.matrixNeedsUpdate = true;
  114. }
  115. }
  116. // Drag
  117. else
  118. {
  119. this.rotationPoint = null;
  120. if(pointer.buttonPressed(this.dragButton))
  121. {
  122. this.viewport.position.x += pointer.delta.x;
  123. this.viewport.position.y += pointer.delta.y;
  124. this.viewport.matrixNeedsUpdate = true;
  125. }
  126. }
  127. };
  128. export {ViewportControls};</code></pre>
  129. </article>
  130. </section>
  131. </div>
  132. <nav>
  133. <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>
  134. </nav>
  135. <br class="clear">
  136. <footer>
  137. 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)
  138. </footer>
  139. <script> prettyPrint(); </script>
  140. <script src="scripts/linenumber.js"> </script>
  141. </body>
  142. </html>