PointerLockControls.html 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  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. [page:EventDispatcher] &rarr;
  12. <h1>指针锁定控制器([name])</h1>
  13. <p class="desc">
  14. 该类的实现是基于[link:https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API Pointer Lock API]的。
  15. 对于第一人称3D游戏来说, [name] 是一个非常完美的选择。
  16. </p>
  17. <h2>示例</h2>
  18. <p>[example:misc_controls_pointerlock misc / controls / pointerlock ]</p>
  19. <code>
  20. var controls = new PointerLockControls( camera, document.body );
  21. // add event listener to show/hide a UI (e.g. the game's menu)
  22. controls.addEventListener( 'lock', function () {
  23. menu.style.display = 'none';
  24. } );
  25. controls.addEventListener( 'unlock', function () {
  26. menu.style.display = 'block';
  27. } );
  28. </code>
  29. <h2>构造函数</h2>
  30. <h3>[name]( [param:Camera camera], [param:HTMLDOMElement domElement] )</h3>
  31. <p>
  32. <p>
  33. [page:Camera camera]: 渲染场景的摄像机。
  34. </p>
  35. <p>
  36. [page:HTMLDOMElement domElement]: 用于事件监听的HTML元素。
  37. </p>
  38. <p>
  39. 创建一个新的 [name] 实例。
  40. </p>
  41. </p>
  42. <h2>事件</h2>
  43. <h3>change</h3>
  44. <p>
  45. 当用户移动鼠标时触发。
  46. </p>
  47. <h3>lock</h3>
  48. <p>
  49. 当指针状态为 “locked” (即鼠标被捕获)时触发。
  50. </p>
  51. <h3>unlock</h3>
  52. <p>
  53. 当指针状态为 “unlocked” (即鼠标不再被捕获)时触发。
  54. </p>
  55. <h2>属性</h2>
  56. <h3>[property:HTMLDOMElement domElement]</h3>
  57. <p>
  58. 该 HTMLDOMElement 用于监听鼠标/触摸事件,该属性必须在构造函数中传入。在此处改变它将不会设置新的事件监听。
  59. </p>
  60. <h3>[property:Boolean isLocked]</h3>
  61. <p>
  62. 控制器是否被锁定。
  63. </p>
  64. <h2>方法</h2>
  65. <p>共有方法请参见其基类[page:EventDispatcher]。</p>
  66. <h3>[method:null connect] ()</h3>
  67. <p>
  68. 添加控制器的事件监听。
  69. </p>
  70. <h3>[method:null disconnect] ()</h3>
  71. <p>
  72. 移除控制器的事件监听。
  73. </p>
  74. <h3>[method:Vector3 getDirection] ( [param:Vector3 target] )</h3>
  75. <p>
  76. <p>
  77. [page:Vector3 target]: 目标向量。
  78. </p>
  79. <p>
  80. 返回摄像机的观看方向。
  81. </p>
  82. </p>
  83. <h3>[method:null lock] ()</h3>
  84. <p>
  85. 激活指针锁定。
  86. </p>
  87. <h3>[method:null moveForward] ( [param:Number distance] )</h3>
  88. <p>
  89. <p>
  90. [page:Number distance]: 距离(区分正负)。
  91. </p>
  92. <p>
  93. 平行于xz平面,向前移动摄像机。假定camera.up是y朝上。
  94. </p>
  95. </p>
  96. <h3>[method:null moveRight] ( [param:Number distance] )</h3>
  97. <p>
  98. <p>
  99. [page:Number distance]: 距离(区分正负)。
  100. </p>
  101. <p>
  102. 平行于xz平面,向侧面移动摄像机。
  103. </p>
  104. </p>
  105. <h3>[method:null unlock] ()</h3>
  106. <p>
  107. 退出指针锁定。
  108. </p>
  109. <h2>源代码</h2>
  110. <p>
  111. [link:https://github.com/mrdoob/three.js/blob/master/examples/js/controls/PointerLockControls.js examples/js/controls/PointerLockControls.js]
  112. </p>
  113. </body>
  114. </html>