Merge pull request #45582 from Calinou/doc-webxrinterface-fix-code-sample-3.2
Fix WebXRInterface code sample in the class reference (3.2)
This commit is contained in:
Rémi Verschelde
GitHub
commit
a18a7fbf2d
1 changed files with 61 additions and 59 deletions
|
|
@ -10,75 +10,77 @@
|
|||
Since WebXR is based on Javascript, it makes extensive use of callbacks, which means that [WebXRInterface] is forced to use signals, where other AR/VR interfaces would instead use functions that return a result immediately. This makes [WebXRInterface] quite a bit more complicated to intialize than other AR/VR interfaces.
|
||||
Here's the minimum code required to start an immersive VR session:
|
||||
[codeblock]
|
||||
var webxr_interface
|
||||
var vr_supported = false
|
||||
extends Spatial
|
||||
|
||||
func _ready():
|
||||
# We assume this node has a canvas layer with a button on it as a child.
|
||||
# This button is for the user to consent to entering immersive VR mode.
|
||||
$CanvasLayer/Button.connect("pressed", self, "_on_Button_pressed")
|
||||
var webxr_interface
|
||||
var vr_supported = false
|
||||
|
||||
webxr_interface = ARVRServer.find_interface("WebXR")
|
||||
if webxr_interface:
|
||||
# WebXR uses a lot of asynchronous callbacks, so we connect to various
|
||||
# signals in order to receive them.
|
||||
webxr_interface.connect("session_supported", self, "_webxr_session_supported")
|
||||
webxr_interface.connect("session_started", self, "_webxr_session_started")
|
||||
webxr_interface.connect("session_ended", self, "_webxr_session_ended")
|
||||
webxr_interface.connect("session_failed", self, "_webxr_session_failed")
|
||||
func _ready():
|
||||
# We assume this node has a canvas layer with a button on it as a child.
|
||||
# This button is for the user to consent to entering immersive VR mode.
|
||||
$CanvasLayer/Button.connect("pressed", self, "_on_Button_pressed")
|
||||
|
||||
# This returns immediately - our _webxr_session_supported() method
|
||||
# (which we connected to the "session_supported" signal above) will
|
||||
# be called sometime later to let us know if it's supported or not.
|
||||
webxr_interface.is_session_supported("immersive-vr")
|
||||
webxr_interface = ARVRServer.find_interface("WebXR")
|
||||
if webxr_interface:
|
||||
# WebXR uses a lot of asynchronous callbacks, so we connect to various
|
||||
# signals in order to receive them.
|
||||
webxr_interface.connect("session_supported", self, "_webxr_session_supported")
|
||||
webxr_interface.connect("session_started", self, "_webxr_session_started")
|
||||
webxr_interface.connect("session_ended", self, "_webxr_session_ended")
|
||||
webxr_interface.connect("session_failed", self, "_webxr_session_failed")
|
||||
|
||||
func _webxr_session_supported(session_mode, supported):
|
||||
if session_mode == 'immersive-vr':
|
||||
vr_supported = supported
|
||||
# This returns immediately - our _webxr_session_supported() method
|
||||
# (which we connected to the "session_supported" signal above) will
|
||||
# be called sometime later to let us know if it's supported or not.
|
||||
webxr_interface.is_session_supported("immersive-vr")
|
||||
|
||||
func _on_Button_pressed():
|
||||
if not vr_supported:
|
||||
OS.alert("Your browser doesn't support VR")
|
||||
return
|
||||
func _webxr_session_supported(session_mode, supported):
|
||||
if session_mode == 'immersive-vr':
|
||||
vr_supported = supported
|
||||
|
||||
# We want an immersive VR session, as opposed to AR ('immersive-ar') or a
|
||||
# simple 3DoF viewer ('viewer').
|
||||
webxr_interface.session_mode = 'immersive-vr'
|
||||
# 'bounded-floor' is room scale, 'local-floor' is a standing or sitting
|
||||
# experience (it puts you 1.6m above the ground if you have 3DoF headset),
|
||||
# whereas as 'local' puts you down at the ARVROrigin.
|
||||
# This list means it'll first try to request 'bounded-floor', then
|
||||
# fallback on 'local-floor' and ultimately 'local', if nothing else is
|
||||
# supported.
|
||||
webxr_interface.requested_reference_space_types = 'bounded-floor, local-floor, local'
|
||||
# In order to use 'local-floor' or 'bounded-floor' we must also
|
||||
# mark the features as required or optional.
|
||||
webxr_interface.required_features = 'local-floor'
|
||||
webxr_interface.optional_features = 'bounded-floor'
|
||||
func _on_Button_pressed():
|
||||
if not vr_supported:
|
||||
OS.alert("Your browser doesn't support VR")
|
||||
return
|
||||
|
||||
# This will return false if we're unable to even request the session,
|
||||
# however, it can still fail asynchronously later in the process, so we
|
||||
# only know if it's really succeeded or failed when our
|
||||
# _webxr_session_started() or _webxr_session_failed() methods are called.
|
||||
if not webxr_interface.initialize():
|
||||
OS.alert("Failed to initialize")
|
||||
return
|
||||
# We want an immersive VR session, as opposed to AR ('immersive-ar') or a
|
||||
# simple 3DoF viewer ('viewer').
|
||||
webxr_interface.session_mode = 'immersive-vr'
|
||||
# 'bounded-floor' is room scale, 'local-floor' is a standing or sitting
|
||||
# experience (it puts you 1.6m above the ground if you have 3DoF headset),
|
||||
# whereas as 'local' puts you down at the ARVROrigin.
|
||||
# This list means it'll first try to request 'bounded-floor', then
|
||||
# fallback on 'local-floor' and ultimately 'local', if nothing else is
|
||||
# supported.
|
||||
webxr_interface.requested_reference_space_types = 'bounded-floor, local-floor, local'
|
||||
# In order to use 'local-floor' or 'bounded-floor' we must also
|
||||
# mark the features as required or optional.
|
||||
webxr_interface.required_features = 'local-floor'
|
||||
webxr_interface.optional_features = 'bounded-floor'
|
||||
|
||||
func _webxr_session_started():
|
||||
# This tells Godot to start rendering to the headset.
|
||||
get_viewport().arvr = true
|
||||
# This will be the reference space type you ultimately got, out of the
|
||||
# types that you requested above. This is useful if you want the game to
|
||||
# work a little differently in 'bounded-floor' versus 'local-floor'.
|
||||
print ("Reference space type: " + webxr_interface.reference_space_type)
|
||||
# This will return false if we're unable to even request the session,
|
||||
# however, it can still fail asynchronously later in the process, so we
|
||||
# only know if it's really succeeded or failed when our
|
||||
# _webxr_session_started() or _webxr_session_failed() methods are called.
|
||||
if not webxr_interface.initialize():
|
||||
OS.alert("Failed to initialize")
|
||||
return
|
||||
|
||||
func _webxr_session_ended():
|
||||
# If the user exits immersive mode, then we tell Godot to render to the web
|
||||
# page again.
|
||||
get_viewport().arvr = false
|
||||
func _webxr_session_started():
|
||||
# This tells Godot to start rendering to the headset.
|
||||
get_viewport().arvr = true
|
||||
# This will be the reference space type you ultimately got, out of the
|
||||
# types that you requested above. This is useful if you want the game to
|
||||
# work a little differently in 'bounded-floor' versus 'local-floor'.
|
||||
print ("Reference space type: " + webxr_interface.reference_space_type)
|
||||
|
||||
func _webxr_session_failed(message):
|
||||
OS.alert("Failed to initialize: " + message)
|
||||
func _webxr_session_ended():
|
||||
# If the user exits immersive mode, then we tell Godot to render to the web
|
||||
# page again.
|
||||
get_viewport().arvr = false
|
||||
|
||||
func _webxr_session_failed(message):
|
||||
OS.alert("Failed to initialize: " + message)
|
||||
[/codeblock]
|
||||
There are several ways to handle "controller" input:
|
||||
- Using [ARVRController] nodes and their [signal ARVRController.button_pressed] and [signal ARVRController.button_release] signals. This is how controllers are typically handled in AR/VR apps in Godot, however, this will only work with advanced VR controllers like the Oculus Touch or Index controllers, for example. The buttons codes are defined by [url=https://immersive-web.github.io/webxr-gamepads-module/#xr-standard-gamepad-mapping]Section 3.3 of the WebXR Gamepads Module[/url].
|
||||
|
|
|
|||
Loading…
Reference in a new issue