Browse Source

VRButton: Remove "options" parameter.

Mugen87 5 years ago
parent
commit
26f6733d82

+ 13 - 0
docs/api/en/renderers/webxr/WebXRManager.html

@@ -68,6 +68,19 @@
 		Note: It is not possible to change the framebuffer scale factor while presenting XR content.
 		</p>
 
+		<h3>[method:void setReferenceSpaceType]( [param:String referenceSpaceType] )</h3>
+		<p>
+		[page:String referenceSpaceType] — The reference space type to set.<br /><br />
+
+		Can be used to configure a spatial relationship with the user's physical environment. Depending on how the user moves in 3D space, setting an
+		appropriate reference space can improve tracking. Default is *local-floor*.
+		Please check out the [link:https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType MDN] for possible values and their use cases.
+		</p>
+
+		<p>
+		Note: It is not possible to change the reference space type while presenting XR content.
+		</p>
+
 		<h2>Source</h2>
 
 		<p>

+ 13 - 0
docs/api/zh/renderers/webxr/WebXRManager.html

@@ -68,6 +68,19 @@
 		Note: It is not possible to change the framebuffer scale factor while presenting XR content.
 		</p>
 
+		<h3>[method:void setReferenceSpaceType]( [param:String referenceSpaceType] )</h3>
+		<p>
+		[page:String referenceSpaceType] — The reference space type to set.<br /><br />
+
+		Can be used to configure a spatial relationship with the user's physical environment. Depending on how the user moves in 3D space, setting an
+		appropriate reference space can improve tracking. Default is *local-floor*.
+		Please check out the [link:https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType MDN] for possible values and their use cases.
+		</p>
+
+		<p>
+		Note: It is not possible to change the reference space type while presenting XR content.
+		</p>
+
 		<h2>Source</h2>
 
 		<p>

+ 1 - 5
examples/jsm/webxr/VRButton.d.ts

@@ -2,10 +2,6 @@ import {
 	WebGLRenderer
 } from '../../../src/Three';
 
-export interface WebXROptions {
-	referenceSpaceType: string;
-}
-
 export namespace VRButton {
-	export function createButton( renderer: WebGLRenderer, options?: WebXROptions ): HTMLElement;
+	export function createButton( renderer: WebGLRenderer ): HTMLElement;
 }

+ 2 - 2
examples/jsm/webxr/VRButton.js

@@ -7,9 +7,9 @@ var VRButton = {
 
 	createButton: function ( renderer, options ) {
 
-		if ( options && options.referenceSpaceType ) {
+		if ( options ) {
 
-			renderer.xr.setReferenceSpaceType( options.referenceSpaceType );
+			console.error( 'THREE.VRButton: The "options" parameter has been removed. Please set the reference space type via renderer.xr.setReferenceSpaceType() instead.' );
 
 		}
 

+ 2 - 1
examples/webxr_vr_panorama.html

@@ -27,9 +27,10 @@
 				renderer.setPixelRatio( window.devicePixelRatio );
 				renderer.setSize( window.innerWidth, window.innerHeight );
 				renderer.xr.enabled = true;
+				renderer.xr.setReferenceSpaceType( 'local' );
 				document.body.appendChild( renderer.domElement );
 
-				document.body.appendChild( VRButton.createButton( renderer, { referenceSpaceType: 'local' } ) );
+				document.body.appendChild( VRButton.createButton( renderer ) );
 
 				//
 

+ 2 - 1
examples/webxr_vr_panorama_depth.html

@@ -84,9 +84,10 @@
 				renderer.setPixelRatio( window.devicePixelRatio );
 				renderer.setSize( window.innerWidth, window.innerHeight );
 				renderer.xr.enabled = true;
+				renderer.xr.setReferenceSpaceType( 'local' );
 				container.appendChild( renderer.domElement );
 
-				document.body.appendChild( VRButton.createButton( renderer, { referenceSpaceType: 'local' } ) );
+				document.body.appendChild( VRButton.createButton( renderer ) );
 
 				//
 

+ 2 - 1
examples/webxr_vr_rollercoaster.html

@@ -27,9 +27,10 @@
 			renderer.setPixelRatio( window.devicePixelRatio );
 			renderer.setSize( window.innerWidth, window.innerHeight );
 			renderer.xr.enabled = true;
+			renderer.xr.setReferenceSpaceType( 'local' );
 			document.body.appendChild( renderer.domElement );
 
-			document.body.appendChild( VRButton.createButton( renderer, { referenceSpaceType: 'local' } ) );
+			document.body.appendChild( VRButton.createButton( renderer ) );
 
 			//
 

+ 2 - 1
examples/webxr_vr_video.html

@@ -115,9 +115,10 @@
 				renderer.setPixelRatio( window.devicePixelRatio );
 				renderer.setSize( window.innerWidth, window.innerHeight );
 				renderer.xr.enabled = true;
+				renderer.xr.setReferenceSpaceType( 'local' );
 				container.appendChild( renderer.domElement );
 
-				document.body.appendChild( VRButton.createButton( renderer, { referenceSpaceType: 'local' } ) );
+				document.body.appendChild( VRButton.createButton( renderer ) );
 
 				//