samien
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
							<!DOCTYPE html>
<html lang="zh">
	<head>
		<meta charset="utf-8" />
		<base href="../../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>

		<h1>[name]</h1>

		<p class="desc">
			此类表示WebXR设备API的抽象，并由[page:WebGLRenderer]在内部使用。
			[name]还提供了一个公共接口，允许用户启用/禁用XR并执行XR相关任务，例如检索控制器。
		</p>

		<h2>Properties</h2>

		<h3>[property:Boolean cameraAutoUpdate]</h3>
		<p>
			manager的XR摄像头是否应自动更新。默认为*true*。
		</p>

		<h3>[property:Boolean enabled]</h3>
		<p>
			此标志通知渲染器准备好进行XR渲染。默认为假。
			如果您要在应用中使用XR，请将其设置为*true*。
		</p>

		<h3>[property:Boolean isPresenting]</h3>
		<p>
			XR演示是否处于活动状态。默认为*false*。该标志是只读的，由[name]自动设置。
		</p>

		<h2>方法(Methods)</h2>

		<h3>[method:XRWebGLLayer getBaseLayer]()</h3>
		<p>
			返回当前基础层。如果目标 XR 设备支持 [link:https://www.w3.org/TR/webxrlayers-1/ WebXR Layers API]，则返回 [link:https://developer.mozilla.org/en-US/docs/Web/API/XRProjectionLayer XRProjectionLayer]；如果不支持，则返回 [link:https://developer.mozilla.org/en-US/docs/Web/API/XRWebGLLayer XRWebGLLayer]。
		</p>

		<h3>[method:XRWebGLBinding getBinding]()</h3>
		<p>
			返回当前的 [link:https://developer.mozilla.org/en-US/docs/Web/API/XRWebGLBinding XRWebGLBinding]。<br /><br />
			如果浏览器支持，且尚未创建 `XRWebGLBinding`，则此方法将创建一个新的 `XRWebGLBinding`。
		</p>

		<h3>[method:ArrayCamera getCamera]()</h3>
		<p>
			返回表示活动XR会话的XR相机的[page:ArrayCamera]实例。
			对于每个视图，它在其[page:ArrayCamera.cameras cameras]属性中包含一个单独的相机对象。
		</p>
		<p>
			当前未使用相机的*fov*，不反映 XR 相机的 fov。
			如果您需要应用级别的fov，则必须从XR相机的投影矩阵中手动计算。
		</p>

		<h3>[method:Texture getCameraTexture]( [param:XRCamera xrCamera] )</h3>
		<p>
			[page:XRCamera xrCamera] — 要查询的 [link:https://immersive-web.github.io/raw-camera-access/#xr-camera-section XRCamera]。<br /><br />

			从查询的 `XRCamera` 返回不透明纹理。仅在当前动画循环期间可用。<br /><br />

			查看 [example:webxr_ar_camera_access webxr / ar / camera_access] 示例。
		</p>

		<h3>[method:Group getController]( [param:Integer index] )</h3>
		<p>
		[page:Integer index] — 控制器的索引。<br /><br />
		
		返回表示XR控制器所谓的*目标光线*空间的[page:Group 组]。使用此空间可视化3D对象，支持用户完成UI交互等指向任务。
		</p>

		<h3>[method:Group getControllerGrip]( [param:Integer index] )</h3>
		<p>
		[page:Integer index] — 控制器的索引。<br /><br />

		返回一个[page:Group 组]，代表所谓的XR控制器的*抓地力*空间。如果用户要握住其他3D对象（如光剑），请使用此空间。

		</p>

		<p>
			注意：如果你想显示用户手中的东西并同时提供指向光线，
			你需要将手持对象附加到[page:.getControllerGrip]()返回的组，
			并将光线附加到[page:.getController]()返回的组. 
			这个想法是在同一个WebXR控制器的两个不同坐标空间中有两个不同的组。
		</p>

		<h3>[method:Mesh getDepthSensingMesh]()</h3>
		<p>
			如果可用，则返回表示用户环境计算深度的纹理，否则返回 `null`。
		</p>

		<h3>[method:ExternalTexture getDepthTexture]()</h3>
		<p>
			如果可用，则返回表示用户环境计算深度的纹理，否则返回 `null`。
		</p>

		<h3>[method:Float getFoveation]()</h3>
		<p>
			返回 XR 合成器用于投影层的注视点渲染强度。
		</p>

		<h3>[method:XRFrame getFrame]()</h3>
		<p>
			返回当前的 [link:https://developer.mozilla.org/en-US/docs/Web/API/XRFrame XRFrame]。如果在没有正在进行的 XR 会话的情况下，则返回 `null`。
		</p>

		<h3>[method:Group getHand]( [param:Integer index] )</h3>
		<p>
		[page:Integer index] — 控制器的索引。 <br /><br />

			返回代表XR控制器所谓的*手或关节*空间的[page:Group 组]。在不使用物理控制器时，使用此空间可视化用户的手。
		</p>

		<h3>[method:String getReferenceSpace]()</h3>
		<p>
		返回参考空间。
		</p>

		<h3>[method:XRSession getSession]()</h3>
		<p>
		返回*XRSession*对象，它允许在应用程序级别更细粒度地管理活动的WebXR会话。
		</p>

		<h3>[method:Boolean hasDepthSensing]()</h3>
		<p>
			如果 XR 设备提供了深度感知数据，则返回 `true`。
		</p>

		<h3>[method:undefined setFoveation]( [param:Float foveation] )</h3>
		<p>
			[page:Float foveation] — 要设置的注视点渲染强度。<br /><br />

			指定 XR 合成器为该图层使用的注视点渲染强度。必须为介于 `0` 和 `1` 之间的值。
		</p>

		<h3>[method:undefined setFramebufferScaleFactor]( [param:Float factor], [param:Boolean limited] )</h3>
		<p>
		[page:Float factor] — 要设置的帧缓冲区比例因子。<br />
		[page:Boolean limited] — 如果值最终高于设备的能力，是否应将帧缓冲区比例因子减小到本机限制。默认为`false`。<br /><br />

			指定在渲染到XR设备时确定帧缓冲区大小时要使用的比例因子。
			该值是相对于默认XR设备显示分辨率的。默认为*1*。值0.5将指定具有显示器原始分辨率50%的帧缓冲区。
			
		</p>

		<p>
		注意：在呈现XR内容时无法更改帧缓冲区比例因子。
		</p>

		<h3>[method:undefined setReferenceSpace]( [param:XRReferenceSpace referenceSpace] )</h3>
		<p>
		[page:XRReferenceSpace referenceSpace] — 自定义参考空间。<br /><br />

		可用于配置覆盖默认参考空间的自定义参考空间。
		</p>

		<h3>[method:undefined setReferenceSpaceType]( [param:String referenceSpaceType] )</h3>
		<p>
		[page:String referenceSpaceType] — 要设置的参考空间类型。<br /><br />

		可用于配置与用户物理环境的空间关系。
		根据用户在3D空间中的移动方式，设置适当的参考空间可以改进跟踪。
		默认为*本层空间*。
		请查看[link:https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType MDN]以了解可能的值及其用例。
		</p>

		<h3>[method:undefined updateCamera]( [param:PerspectiveCamera camera] )</h3>
		<p>
			更新 XR 相机的状态。
			如果您将[page:.cameraAutoUpdate]设置为*false*，请在应用级别使用此方法。
			该方法需要场景的非 XR 相机作为参数。
			调用此方法时，传入的相机变换会自动调整到 XR 相机的位置。
		</p>

		<p>
		注意：在呈现 XR 内容时无法更改参考空间类型。
		</p>

		<h2>源代码(Source)</h2>

		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>