FirstPersonControls.html 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  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]: The HTML element used for event listeners.
  25. </p>
  26. <p>
  27. Creates a new instance of [name].
  28. </p>
  29. </p>
  30. <h2>Properties</h2>
  31. <h3>[property:Boolean activeLook]</h3>
  32. <p>
  33. Whether or not it's possible to look around. Default is *true*.
  34. </p>
  35. <h3>[property:Boolean autoForward]</h3>
  36. <p>
  37. Whether or not the camera is automatically moved forward. Default is *false*.
  38. </p>
  39. <h3>[property:Boolean constrainVertical]</h3>
  40. <p>
  41. Whether or not looking around is vertically constrained by [[page:.verticalMin], [page:.verticalMax]]. Default is *false*.
  42. </p>
  43. <h3>[property:HTMLDOMElement domElement]</h3>
  44. <p>
  45. The HTMLDOMElement used to listen for mouse / touch events. This must be passed in the constructor; changing it here will
  46. not set up new event listeners.
  47. </p>
  48. <h3>[property:Boolean enabled]</h3>
  49. <p>
  50. Whether or not the controls are enabled. Default is *true*.
  51. </p>
  52. <h3>[property:Number heightCoef]</h3>
  53. <p>
  54. Determines how much faster the camera moves when it's y-component is near [page:.heightMax]. Default is *1*.
  55. </p>
  56. <h3>[property:Number heightMax]</h3>
  57. <p>
  58. Upper camera height limit used for movement speed adjusment. Default is *1*.
  59. </p>
  60. <h3>[property:Number heightMin]</h3>
  61. <p>
  62. Lower camera height limit used for movement speed adjusment. Default is *0*.
  63. </p>
  64. <h3>[property:Boolean heightSpeed]</h3>
  65. <p>
  66. Whether or not the camera's height influences the forward movement speed. Default is *false*.
  67. Use the properties [page:.heightCoef], [page:.heightMin] and [page:.heightMax] for configuration.
  68. </p>
  69. <h3>[property:Boolean lookVertical]</h3>
  70. <p>
  71. Whether or not it's possible to vertically look around. Default is *true*.
  72. </p>
  73. <h3>[property:Number lookSpeed]</h3>
  74. <p>
  75. The look around speed. Default is *0.005*.
  76. </p>
  77. <h3>[property:Boolean mouseDragOn]</h3>
  78. <p>
  79. Whether or not the mouse is pressed down. Read-only property.
  80. </p>
  81. <h3>[property:Number movementSpeed]</h3>
  82. <p>
  83. The movement speed. Default is *1*.
  84. </p>
  85. <h3>[property:Camera object]</h3>
  86. <p>
  87. The camera to be controlled.
  88. </p>
  89. <h3>[property:Number verticalMax]</h3>
  90. <p>
  91. How far you can vertically look around, upper limit. Range is 0 to Math.PI radians. Default is *Math.PI*.
  92. </p>
  93. <h3>[property:Number verticalMin]</h3>
  94. <p>
  95. How far you can vertically look around, lower limit. Range is 0 to Math.PI radians. Default is *0*.
  96. </p>
  97. <h2>Methods</h2>
  98. <h3>[method:null dispose] ()</h3>
  99. <p>
  100. Should be called if the controls is no longer required.
  101. </p>
  102. <h3>[method:null handleResize] ()</h3>
  103. <p>
  104. Should be called if the application window is resized.
  105. </p>
  106. <h3>[method:FirstPersonControls lookAt]( [param:Vector3 vector] )<br />
  107. [method:FirstPersonControls lookAt]( [param:Float x], [param:Float y], [param:Float z] )</h3>
  108. <p>
  109. <p>
  110. <p>
  111. vector - A vector representing the target position.
  112. </p>
  113. <p>
  114. Optionally, the x, y, z components of the world space position.
  115. </p>
  116. </p>
  117. <p>
  118. Ensures the controls orient the camera towards the defined target position.
  119. </p>
  120. </p>
  121. <h3>[method:null update] ( [param:Number delta] )</h3>
  122. <p>
  123. <p>
  124. [page:Number delta]: Time delta value.
  125. </p>
  126. <p>
  127. Updates the controls. Usually called in the animation loop.
  128. </p>
  129. </p>
  130. <h2>Source</h2>
  131. <p>
  132. [link:https://github.com/mrdoob/three.js/blob/master/examples/js/controls/FirstPersonControls.js examples/js/controls/FirstPersonControls.js]
  133. </p>
  134. </body>
  135. </html>