FirstPersonControls.html 4.1 KB

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