FirstPersonControls.html 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. This class is an alternative implementation of [page:FlyControls].
  14. </p>
  15. <h2>Example</h2>
  16. <p>[example:webgl_geometry_terrain webgl / geometry / terrain ]</p>
  17. <h2>Constructor</h2>
  18. <h3>[name]( [param:Camera object], [param:HTMLDOMElement domElement] )</h3>
  19. <p>
  20. <p>
  21. [page:Camera object]: The camera to be controlled.
  22. </p>
  23. <p>
  24. [page:HTMLDOMElement domElement]: (optional) The HTML element used for event listeners. By default this is the whole document,
  25. however if you only want the controls to work over a specific element (e.g. the canvas) you can specify that here.
  26. </p>
  27. <p>
  28. Creates a new instance of [name].
  29. </p>
  30. </p>
  31. <h2>Properties</h2>
  32. <h3>[property:Boolean activeLook]</h3>
  33. <p>
  34. Whether or not it's possible to look around. Default is *true*.
  35. </p>
  36. <h3>[property:Boolean autoForward]</h3>
  37. <p>
  38. Whether or not the camera is automatically moved forward. Default is *false*.
  39. </p>
  40. <h3>[property:Boolean constrainVertical]</h3>
  41. <p>
  42. Whether or not looking around is vertically constrained by [[page:.verticalMin], [page:.verticalMax]]. Default is *false*.
  43. </p>
  44. <h3>[property:HTMLDOMElement domElement]</h3>
  45. <p>
  46. The HTMLDOMElement used to listen for mouse / touch events. This must be passed in the constructor; changing it here will
  47. not set up new event listeners. Default is the whole document.
  48. </p>
  49. <h3>[property:Boolean enabled]</h3>
  50. <p>
  51. Whether or not the controls are enabled. Default is *true*.
  52. </p>
  53. <h3>[property:Number heightCoef]</h3>
  54. <p>
  55. Determines how much faster the camera moves when it's y-component is near [page:.heightMax]. Default is *1*.
  56. </p>
  57. <h3>[property:Number heightMax]</h3>
  58. <p>
  59. Upper camera height limit used for movement speed adjusment. Default is *1*.
  60. </p>
  61. <h3>[property:Number heightMin]</h3>
  62. <p>
  63. Lower camera height limit used for movement speed adjusment. Default is *0*.
  64. </p>
  65. <h3>[property:Boolean heightSpeed]</h3>
  66. <p>
  67. Whether or not the camera's height influences the forward movement speed. Default is *false*.
  68. Use the properties [page:.heightCoef], [page:.heightMin] and [page:.heightMax] for configuration.
  69. </p>
  70. <h3>[property:Boolean lookVertical]</h3>
  71. <p>
  72. Whether or not it's possible to vertically look around. Default is *true*.
  73. </p>
  74. <h3>[property:Number lookSpeed]</h3>
  75. <p>
  76. The look around speed. Default is *0.005*.
  77. </p>
  78. <h3>[property:Boolean mouseDragOn]</h3>
  79. <p>
  80. Whether or not the mouse is pressed down. Read-only property.
  81. </p>
  82. <h3>[property:Number movementSpeed]</h3>
  83. <p>
  84. The movement speed. Default is *1*.
  85. </p>
  86. <h3>[property:Camera object]</h3>
  87. <p>
  88. The camera to be controlled.
  89. </p>
  90. <h3>[property:Number verticalMax]</h3>
  91. <p>
  92. How far you can vertically look around, upper limit. Range is 0 to Math.PI radians. Default is *Math.PI*.
  93. </p>
  94. <h3>[property:Number verticalMin]</h3>
  95. <p>
  96. How far you can vertically look around, lower limit. Range is 0 to Math.PI radians. Default is *0*.
  97. </p>
  98. <h2>Methods</h2>
  99. <h3>[method:null dispose] ()</h3>
  100. <p>
  101. Should be called if the controls is no longer required.
  102. </p>
  103. <h3>[method:null handleResize] ()</h3>
  104. <p>
  105. Should be called if the application window is resized.
  106. </p>
  107. <h3>[method:FirstPersonControls lookAt]( [param:Vector3 vector] )<br />
  108. [method:FirstPersonControls lookAt]( [param:Float x], [param:Float y], [param:Float z] )</h3>
  109. <p>
  110. <p>
  111. <p>
  112. vector - A vector representing the target position.
  113. </p>
  114. <p>
  115. Optionally, the x, y, z components of the world space position.
  116. </p>
  117. </p>
  118. <p>
  119. Ensures the controls orient the camera towards the defined target position.
  120. </p>
  121. </p>
  122. <h3>[method:null update] ( [param:Number delta] )</h3>
  123. <p>
  124. <p>
  125. [page:Number delta]: Time delta value.
  126. </p>
  127. <p>
  128. Updates the controls. Usually called in the animation loop.
  129. </p>
  130. </p>
  131. <h2>Source</h2>
  132. <p>
  133. [link:https://github.com/mrdoob/three.js/blob/master/examples/js/controls/FirstPersonControls.js examples/js/controls/FirstPersonControls.js]
  134. </p>
  135. </body>
  136. </html>