OrbitControls.html 8.6 KB

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