Viewport.html 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Viewport</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: Viewport</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>Viewport<span class="signature">()</span><span class="type-signature"></span></h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <h4 class="name" id="Viewport"><span class="type-signature"></span>new Viewport<span class="signature">()</span><span class="type-signature"></span></h4>
  24. <div class="description">
  25. Used to indicate how the user views the content inside of the canvas.
  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="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line13">line 13</a>
  31. </li></ul></dd>
  32. </dl>
  33. </div>
  34. <h3 class="subsection-title">Members</h3>
  35. <h4 class="name" id="inverseMatrix"><span class="type-signature"></span>inverseMatrix<span class="type-signature"></span></h4>
  36. <div class="description">
  37. Inverse of the local transformation matrix.
  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="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line43">line 43</a>
  43. </li></ul></dd>
  44. </dl>
  45. <h4 class="name" id="matrix"><span class="type-signature"></span>matrix<span class="type-signature"></span></h4>
  46. <div class="description">
  47. Local transformation matrix applied to the object.
  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="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line38">line 38</a>
  53. </li></ul></dd>
  54. </dl>
  55. <h4 class="name" id="matrixNeedsUpdate"><span class="type-signature"></span>matrixNeedsUpdate<span class="type-signature"></span></h4>
  56. <div class="description">
  57. If true the matrix is updated before rendering the object.
  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="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line48">line 48</a>
  63. </li></ul></dd>
  64. </dl>
  65. <h4 class="name" id="moveOnScale"><span class="type-signature"></span>moveOnScale<span class="type-signature"></span></h4>
  66. <div class="description">
  67. Flag to indicate if the viewport should move when scalling. For some application its easier to focus the target if the viewport moves to the pointer location while scalling.
  68. </div>
  69. <dl class="details">
  70. <dt class="tag-source">Source:</dt>
  71. <dd class="tag-source"><ul class="dummy"><li>
  72. <a href="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line55">line 55</a>
  73. </li></ul></dd>
  74. </dl>
  75. <h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"></span></h4>
  76. <div class="description">
  77. Position of the object.
  78. </div>
  79. <dl class="details">
  80. <dt class="tag-source">Source:</dt>
  81. <dd class="tag-source"><ul class="dummy"><li>
  82. <a href="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line23">line 23</a>
  83. </li></ul></dd>
  84. </dl>
  85. <h4 class="name" id="rotation"><span class="type-signature"></span>rotation<span class="type-signature"></span></h4>
  86. <div class="description">
  87. Rotation of the object relative to its center.
  88. </div>
  89. <dl class="details">
  90. <dt class="tag-source">Source:</dt>
  91. <dd class="tag-source"><ul class="dummy"><li>
  92. <a href="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line33">line 33</a>
  93. </li></ul></dd>
  94. </dl>
  95. <h4 class="name" id="scale"><span class="type-signature"></span>scale<span class="type-signature"></span></h4>
  96. <div class="description">
  97. Scale of the object.
  98. </div>
  99. <dl class="details">
  100. <dt class="tag-source">Source:</dt>
  101. <dd class="tag-source"><ul class="dummy"><li>
  102. <a href="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line28">line 28</a>
  103. </li></ul></dd>
  104. </dl>
  105. <h4 class="name" id="uuid"><span class="type-signature"></span>uuid<span class="type-signature"></span></h4>
  106. <div class="description">
  107. UUID of the object.
  108. </div>
  109. <dl class="details">
  110. <dt class="tag-source">Source:</dt>
  111. <dd class="tag-source"><ul class="dummy"><li>
  112. <a href="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line18">line 18</a>
  113. </li></ul></dd>
  114. </dl>
  115. <h3 class="subsection-title">Methods</h3>
  116. <h4 class="name" id="updateControls"><span class="type-signature"></span>updateControls<span class="signature">()</span><span class="type-signature"></span></h4>
  117. <div class="description">
  118. Update the viewport controls using the pointer object.
  119. </div>
  120. <dl class="details">
  121. <dt class="tag-source">Source:</dt>
  122. <dd class="tag-source"><ul class="dummy"><li>
  123. <a href="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line61">line 61</a>
  124. </li></ul></dd>
  125. </dl>
  126. <h4 class="name" id="updateMatrix"><span class="type-signature"></span>updateMatrix<span class="signature">()</span><span class="type-signature"></span></h4>
  127. <div class="description">
  128. Calculate and update the viewport transformation matrix.
  129. </div>
  130. <dl class="details">
  131. <dt class="tag-source">Source:</dt>
  132. <dd class="tag-source"><ul class="dummy"><li>
  133. <a href="Viewport.js.html">Viewport.js</a>, <a href="Viewport.js.html#line88">line 88</a>
  134. </li></ul></dd>
  135. </dl>
  136. </article>
  137. </section>
  138. </div>
  139. <nav>
  140. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="EventManager.html">EventManager</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="Viewport.html">Viewport</a></li></ul>
  141. </nav>
  142. <br class="clear">
  143. <footer>
  144. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.2</a> on Mon Jun 03 2019 12:31:58 GMT+0100 (Western European Summer Time)
  145. </footer>
  146. <script> prettyPrint(); </script>
  147. <script src="scripts/linenumber.js"> </script>
  148. </body>
  149. </html>