OrbitControls.html 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
  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. Orbit controls(轨道控制器)可以使得相机围绕目标进行轨道运动。<br>
  14. 要使用这一功能,就像在/examples(示例)目录中的所有文件一样,
  15. 您必须在HTML中包含这个文件。
  16. </p>
  17. <h2>示例</h2>
  18. <p>[example:misc_controls_orbit misc / controls / orbit ]</p>
  19. <code>
  20. var renderer = new THREE.WebGLRenderer();
  21. renderer.setSize( window.innerWidth, window.innerHeight );
  22. document.body.appendChild( renderer.domElement );
  23. var scene = new THREE.Scene();
  24. var camera = new THREE.PerspectiveCamera( 45, window.innerWidth / window.innerHeight, 1, 10000 );
  25. var controls = new THREE.OrbitControls( camera, renderer.domElement );
  26. //controls.update() must be called after any manual changes to the camera's transform
  27. camera.position.set( 0, 20, 100 );
  28. controls.update();
  29. function animate() {
  30. requestAnimationFrame( animate );
  31. // required if controls.enableDamping or controls.autoRotate are set to true
  32. controls.update();
  33. renderer.render( scene, camera );
  34. }
  35. </code>
  36. <h2>构造函数</h2>
  37. <h3>[name]( [param:Camera object], [param:HTMLDOMElement domElement] )</h3>
  38. <p>
  39. [page:Camera object]: (必须)将要被控制的相机。该相机不允许是其他任何对象的子级,除非该对象是场景自身。<br><br>
  40. [page:HTMLDOMElement domElement]: 用于事件监听的HTML元素。
  41. </p>
  42. <h2>属性</h2>
  43. <h3>[property:Boolean autoRotate]</h3>
  44. <p>
  45. 将其设为true,以自动围绕目标旋转。<br>
  46. 请注意,如果它被启用,你必须在你的动画循环里调用[page:.update]()。
  47. </p>
  48. <h3>[property:Float autoRotateSpeed]</h3>
  49. <p>
  50. 当[property:Boolean autoRotate]为true时,围绕目标旋转的速度将有多快,默认值为2.0,相当于在60fps时每旋转一次需要30秒。<br>
  51. 请注意,如果[property:Boolean autoRotate]被启用,你必须在你的动画循环里调用[page:.update]()。
  52. </p>
  53. <h3>
  54. [property:Float dampingFactor]</h3>
  55. <p>
  56. 当[property:Boolean enableDamping]设置为true的时候,阻尼惯性有多大。<br>
  57. 请注意,要使得这一值生效,你必须在你的动画循环里调用[page:.update]()。
  58. </p>
  59. <h3>[property:HTMLDOMElement domElement]</h3>
  60. <p>
  61. 该 HTMLDOMElement 用于监听鼠标/触摸事件,该属性必须在构造函数中传入。在此处改变它将不会设置新的事件监听。
  62. </p>
  63. <h3>[property:Boolean enabled]</h3>
  64. <p>
  65. 控制器是否被启用。
  66. </p>
  67. <h3>[property:Boolean enableDamping]</h3>
  68. <p>
  69. 将其设置为true以启用阻尼(惯性),这将给控制器带来重量感。默认值为false。<br>
  70. 请注意,如果该值被启用,你将必须在你的动画循环里调用[page:.update]()。
  71. </p>
  72. <h3>[property:Boolean enableKeys]</h3>
  73. <p>
  74. 启用或禁用键盘控制。
  75. </p>
  76. <h3>[property:Boolean enablePan]</h3>
  77. <p>
  78. 启用或禁用摄像机平移,默认为true。
  79. </p>
  80. <h3>[property:Boolean enableRotate]</h3>
  81. <p>
  82. 启用或禁用摄像机水平或垂直旋转。默认值为true。<br>
  83. 请注意,可以通过将[page:.minPolarAngle polar angle]或者[page:.minAzimuthAngle azimuth angle]
  84. 的min和max设置为相同的值来禁用单个轴,
  85. 这将使得水平旋转或垂直旋转固定为所设置的值。
  86. </p>
  87. <h3>[property:Boolean enableZoom]</h3>
  88. <p>
  89. 启用或禁用摄像机的缩放。
  90. </p>
  91. <h3>[property:Float keyPanSpeed]</h3>
  92. <p>
  93. 当使用键盘按键的时候,相机平移的速度有多快。默认值为每次按下按键时平移7像素。
  94. </p>
  95. <h3>[property:Object keys]</h3>
  96. <p>
  97. 这一对象包含了用于控制相机平移的按键代码的引用。默认值为4个箭头(方向)键。
  98. <code>
  99. controls.keys = {
  100. LEFT: 37, //left arrow
  101. UP: 38, // up arrow
  102. RIGHT: 39, // right arrow
  103. BOTTOM: 40 // down arrow
  104. }
  105. </code>请参阅[link:https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode this page]来查看所有按键的代码列表。
  106. </p>
  107. <h3>[property:Float maxAzimuthAngle]</h3>
  108. <p>
  109. 你能够水平旋转的角度的上限,范围是-Math.PI到Math.PI(或Infinity无限制),
  110. 其默认值为Infinity。
  111. </p>
  112. <h3>[property:Float maxDistance]</h3>
  113. <p>
  114. 你能够将相机向外移动多少(仅适用于[page:PerspectiveCamera]),其默认值为Infinity。
  115. </p>
  116. <h3>[property:Float maxPolarAngle]</h3>
  117. <p>
  118. 你能够垂直旋转的角度的上限,范围是0到Math.PI,其默认值为Math.PI。
  119. </p>
  120. <h3>[property:Float maxZoom]</h3>
  121. <p>
  122. 你能够将相机缩小多少(仅适用于[page:OrthographicCamera]),其默认值为Infinity。
  123. </p>
  124. <h3>[property:Float minAzimuthAngle]</h3>
  125. <p>
  126. 你能够水平旋转的角度的下限,范围是-Math.PI到Math.PI(或-Infinity无限制),
  127. 其默认值为-Infinity。
  128. </p>
  129. <h3>[property:Float minDistance]</h3>
  130. <p>
  131. 你能够将相机向内移动多少(仅适用于[page:PerspectiveCamera]),其默认值为0。
  132. </p>
  133. <h3>[property:Float minPolarAngle]</h3>
  134. <p>
  135. 你能够垂直旋转的角度的下限,范围是0到Math.PI,其默认值为0。
  136. </p>
  137. <h3>[property:Float minZoom]</h3>
  138. <p>
  139. 你能够将相机放大多少(仅适用于[page:OrthographicCamera]),其默认值为0。
  140. </p>
  141. <h3>
  142. [property:Object mouseButtons]</h3>
  143. <p>
  144. 该对象包含由控件所使用的鼠标操作的引用。
  145. <code>
  146. controls.mouseButtons = {
  147. LEFT: THREE.MOUSE.ROTATE,
  148. MIDDLE: THREE.MOUSE.DOLLY,
  149. RIGHT: THREE.MOUSE.PAN
  150. }
  151. </code>
  152. </p>
  153. <h3>[property:Camera object]</h3>
  154. <p>
  155. 正被控制的摄像机。
  156. </p>
  157. <h3>[property:Float panSpeed]</h3>
  158. <p>
  159. 位移的速度,其默认值为1。
  160. </p>
  161. <h3>[property:Vector3 position0]</h3>
  162. <p>
  163. 由[method:saveState]和[method:reset]方法在内部使用。
  164. </p>
  165. <h3>[property:Float rotateSpeed]</h3>
  166. <p>
  167. 旋转的速度,其默认值为1。
  168. </p>
  169. <h3>[property:Boolean screenSpacePanning]</h3>
  170. <p>
  171. 定义当平移的时候摄像机的位置将如何移动。如果为true,摄像机将在屏幕空间内平移。
  172. 否则,摄像机将在与摄像机向上方向垂直的平面中平移。其默认值为false。
  173. </p>
  174. <h3>[property:Vector3 target0]</h3>
  175. <p>
  176. 由[method:saveState]和[method:reset]方法在内部使用。
  177. </p>
  178. <h3>[property:Vector3 target]</h3>
  179. <p>
  180. 控制器的焦点,[page:.object]的轨道围绕它运行。
  181. 它可以在任何时候被手动更新,以更改控制器的焦点。
  182. </p>
  183. <h3>[property:Object touches]</h3>
  184. <p>
  185. This object contains references to the touch actions used by the controls.
  186. <code>
  187. controls.touches = {
  188. ONE: THREE.TOUCH.ROTATE,
  189. TWO: THREE.TOUCH.DOLLY_PAN
  190. }
  191. </code>
  192. </p>
  193. <h3>[property:Float zoom0]</h3>
  194. <p>
  195. 由[method:saveState]和[method:reset]方法在内部使用。
  196. </p>
  197. <h3>[property:Float zoomSpeed]</h3>
  198. <p>
  199. 摄像机缩放的速度,其默认值为1。
  200. Speed of zooming / dollying. Default is 1.
  201. </p>
  202. <h2>Methods</h2>
  203. <h3>[method:null dispose] ()</h3>
  204. <p>
  205. 移除所有的事件监听。
  206. </p>
  207. <h3>[method:radians getAzimuthalAngle] ()</h3>
  208. <p>
  209. 获得当前的水平旋转,单位为弧度。
  210. </p>
  211. <h3>[method:radians getPolarAngle] ()</h3>
  212. <p>
  213. 获得当前的垂直旋转,单位为弧度。
  214. </p>
  215. <h3>[method:null reset] ()</h3>
  216. <p>
  217. 将控制器重置为上次调用[page:.saveState]时的状态,或者初始状态。
  218. </p>
  219. <h3>[method:null saveState] ()</h3>
  220. <p>
  221. 保存当前控制器的状态。这一状态可在之后由[page:.reset]所恢复。
  222. </p>
  223. <h3>[method:Boolean update] ()</h3>
  224. <p>
  225. 更新控制器。必须在摄像机的变换发生任何手动改变后调用,
  226. 或如果[page:.autoRotate]或[page:.enableDamping]被设置时,在update循环里调用。
  227. </p>
  228. <h2>源代码</h2>
  229. <p>
  230. [link:https://github.com/mrdoob/three.js/blob/master/examples/js/controls/OrbitControls.js examples/js/controls/OrbitControls.js]
  231. </p>
  232. </body>
  233. </html>