WebXRManager.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  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. <h1>[name]</h1>
  11. <p class="desc">
  12. 此类表示WebXR设备API的抽象,并由[page:WebGLRenderer]在内部使用。
  13. [name]还提供了一个公共接口,允许用户启用/禁用XR并执行XR相关任务,例如检索控制器。
  14. </p>
  15. <h2>Properties</h2>
  16. <h3>[property:Boolean cameraAutoUpdate]</h3>
  17. <p>
  18. manager的XR摄像头是否应自动更新。默认为*true*。
  19. </p>
  20. <h3>[property:Boolean enabled]</h3>
  21. <p>
  22. 此标志通知渲染器准备好进行XR渲染。默认为假。
  23. 如果您要在应用中使用XR,请将其设置为*true*。
  24. </p>
  25. <h3>[property:Boolean isPresenting]</h3>
  26. <p>
  27. XR演示是否处于活动状态。默认为*false*。该标志是只读的,由[name]自动设置。
  28. </p>
  29. <h2>方法(Methods)</h2>
  30. <h3>[method:ArrayCamera getCamera]()</h3>
  31. <p>
  32. 返回表示活动XR会话的XR相机的[page:ArrayCamera]实例。
  33. 对于每个视图,它在其[page:ArrayCamera.cameras cameras]属性中包含一个单独的相机对象。
  34. </p>
  35. <p>
  36. 当前未使用相机的*fov*,不反映 XR 相机的 fov。
  37. 如果您需要应用级别的fov,则必须从XR相机的投影矩阵中手动计算。
  38. </p>
  39. <h3>[method:Group getController]( [param:Integer index] )</h3>
  40. <p>
  41. [page:Integer index] — 控制器的索引。<br /><br />
  42. 返回表示XR控制器所谓的*目标光线*空间的[page:Group 组]。使用此空间可视化3D对象,支持用户完成UI交互等指向任务。
  43. </p>
  44. <h3>[method:Group getControllerGrip]( [param:Integer index] )</h3>
  45. <p>
  46. [page:Integer index] — 控制器的索引。<br /><br />
  47. 返回一个[page:Group 组],代表所谓的XR控制器的*抓地力*空间。如果用户要握住其他3D对象(如光剑),请使用此空间。
  48. </p>
  49. <p>
  50. 注意:如果你想显示用户手中的东西并同时提供指向光线,
  51. 你需要将手持对象附加到[page:.getControllerGrip]()返回的组,
  52. 并将光线附加到[page:.getController]()返回的组.
  53. 这个想法是在同一个WebXR控制器的两个不同坐标空间中有两个不同的组。
  54. </p>
  55. <h3>[method:Group getHand]( [param:Integer index] )</h3>
  56. <p>
  57. [page:Integer index] — 控制器的索引。 <br /><br />
  58. 返回代表XR控制器所谓的*手或关节*空间的[page:Group 组]。在不使用物理控制器时,使用此空间可视化用户的手。
  59. </p>
  60. <h3>[method:String getReferenceSpace]()</h3>
  61. <p>
  62. 返回参考空间。
  63. </p>
  64. <h3>[method:XRSession getSession]()</h3>
  65. <p>
  66. 返回*XRSession*对象,它允许在应用程序级别更细粒度地管理活动的WebXR会话。
  67. </p>
  68. <h3>[method:undefined setFramebufferScaleFactor]( [param:Float factor], [param:Boolean limited] )</h3>
  69. <p>
  70. [page:Float factor] — 要设置的帧缓冲区比例因子。<br />
  71. [page:Boolean limited] — 如果值最终高于设备的能力,是否应将帧缓冲区比例因子减小到本机限制。默认为`false`。<br /><br />
  72. 指定在渲染到XR设备时确定帧缓冲区大小时要使用的比例因子。
  73. 该值是相对于默认XR设备显示分辨率的。默认为*1*。值0.5将指定具有显示器原始分辨率50%的帧缓冲区。
  74. </p>
  75. <p>
  76. 注意:在呈现XR内容时无法更改帧缓冲区比例因子。
  77. </p>
  78. <h3>[method:undefined setReferenceSpace]( [param:XRReferenceSpace referenceSpace] )</h3>
  79. <p>
  80. [page:XRReferenceSpace referenceSpace] — 自定义参考空间。<br /><br />
  81. 可用于配置覆盖默认参考空间的自定义参考空间。
  82. </p>
  83. <h3>[method:undefined setReferenceSpaceType]( [param:String referenceSpaceType] )</h3>
  84. <p>
  85. [page:String referenceSpaceType] — 要设置的参考空间类型。<br /><br />
  86. 可用于配置与用户物理环境的空间关系。
  87. 根据用户在3D空间中的移动方式,设置适当的参考空间可以改进跟踪。
  88. 默认为*本层空间*。
  89. 请查看[link:https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType MDN]以了解可能的值及其用例。
  90. </p>
  91. <h3>[method:undefined updateCamera]( [param:PerspectiveCamera camera] )</h3>
  92. <p>
  93. 更新 XR 相机的状态。
  94. 如果您将[page:.cameraAutoUpdate]设置为*false*,请在应用级别使用此方法。
  95. 该方法需要场景的非 XR 相机作为参数。
  96. 调用此方法时,传入的相机变换会自动调整到 XR 相机的位置。
  97. </p>
  98. <p>
  99. 注意:在呈现 XR 内容时无法更改参考空间类型。
  100. </p>
  101. <h2>源代码(Source)</h2>
  102. <p>
  103. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  104. </p>
  105. </body>
  106. </html>