PointerLockControls.html 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. <!DOCTYPE html>
  2. <html lang="zh">
  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. [page:Controls] &rarr;
  11. <h1>指针锁定控制器([name])</h1>
  12. <p class="desc">
  13. 该类的实现是基于[link:https://developer.mozilla.org/en-US/docs/Web/API/Pointer_Lock_API Pointer Lock API]的。
  14. 对于第一人称3D游戏来说, [name] 是一个非常完美的选择。
  15. </p>
  16. <h2>导入</h2>
  17. <p>
  18. [name] 是一个附加组件,必须显式导入。
  19. 请参阅 [link:#manual/introduction/Installation Installation / Addons].
  20. </p>
  21. <code>
  22. import { PointerLockControls } from 'three/addons/controls/PointerLockControls.js';
  23. </code>
  24. <h2>代码示例</h2>
  25. <code>
  26. const controls = new PointerLockControls( camera, document.body );
  27. // add event listener to show/hide a UI (e.g. the game's menu)
  28. controls.addEventListener( 'lock', function () {
  29. menu.style.display = 'none';
  30. } );
  31. controls.addEventListener( 'unlock', function () {
  32. menu.style.display = 'block';
  33. } );
  34. </code>
  35. <h2>例子</h2>
  36. <p>[example:misc_controls_pointerlock misc / controls / pointerlock ]</p>
  37. <h2>构造函数</h2>
  38. <h3>[name]( [param:Camera camera], [param:HTMLDOMElement domElement] )</h3>
  39. <p>
  40. <p>
  41. [page:Camera camera]: 渲染场景的摄像机。
  42. </p>
  43. <p>
  44. [page:HTMLDOMElement domElement]: 用于事件监听的HTML元素。
  45. </p>
  46. <p>
  47. 创建一个新的 [name] 实例。
  48. </p>
  49. </p>
  50. <h2>事件</h2>
  51. <h3>change</h3>
  52. <p>
  53. 当用户移动鼠标时触发。
  54. </p>
  55. <h3>lock</h3>
  56. <p>
  57. 当指针状态为 “locked” (即鼠标被捕获)时触发。
  58. </p>
  59. <h3>unlock</h3>
  60. <p>
  61. 当指针状态为 “unlocked” (即鼠标不再被捕获)时触发。
  62. </p>
  63. <h2>属性</h2>
  64. <p>共有属性请参见其基类[page:Controls]。</p>
  65. <h3>[property:Boolean isLocked]</h3>
  66. <p>
  67. 控制器是否被锁定。
  68. </p>
  69. <h3>[property:Float maxPolarAngle]</h3>
  70. <p>
  71. 摄像机的俯仰角上限限制。范围为0到Math.PI弧度之间。默认值为Math.PI。
  72. </p>
  73. <h3>[property:Float minPolarAngle]</h3>
  74. <p>
  75. 摄像机的俯仰角下限限制。范围为0到Math.PI弧度之间。默认值为0。
  76. </p>
  77. <h3>[property:Float pointerSpeed]</h3>
  78. <p>
  79. 指针移动对相机旋转的影响程度的乘数。默认值为1。
  80. </p>
  81. <h2>方法</h2>
  82. <p>共有方法请参见其基类[page:Controls]。</p>
  83. <h3>[method:Vector3 getDirection] ( [param:Vector3 target] )</h3>
  84. <p>
  85. <p>
  86. [page:Vector3 target]: 目标向量。
  87. </p>
  88. <p>
  89. 返回摄像机的观看方向。
  90. </p>
  91. </p>
  92. <h3>[method:undefined lock] ()</h3>
  93. <p>
  94. 激活指针锁定。
  95. </p>
  96. <h3>[method:undefined moveForward] ( [param:Number distance] )</h3>
  97. <p>
  98. <p>
  99. [page:Number distance]: 距离(区分正负)。
  100. </p>
  101. <p>
  102. 平行于xz平面,向前移动摄像机。假定camera.up是y朝上。
  103. </p>
  104. </p>
  105. <h3>[method:undefined moveRight] ( [param:Number distance] )</h3>
  106. <p>
  107. <p>
  108. [page:Number distance]: 距离(区分正负)。
  109. </p>
  110. <p>
  111. 平行于xz平面,向侧面移动摄像机。
  112. </p>
  113. </p>
  114. <h3>[method:undefined unlock] ()</h3>
  115. <p>
  116. 退出指针锁定。
  117. </p>
  118. <h2>源代码</h2>
  119. <p>
  120. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/controls/PointerLockControls.js examples/jsm/controls/PointerLockControls.js]
  121. </p>
  122. </body>
  123. </html>