godot/modules/webxr/webxr_interface_js.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

884 lines
28 KiB
C++
Raw Normal View History

2020-09-26 22:15:21 +00:00
/**************************************************************************/
/* webxr_interface_js.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#include "webxr_interface_js.h"
#ifdef WEB_ENABLED
2020-09-26 22:15:21 +00:00
#include "godot_webxr.h"
2020-09-26 22:15:21 +00:00
#include "core/input/input.h"
#include "core/os/os.h"
#include "drivers/gles3/storage/texture_storage.h"
2022-11-19 02:43:11 +00:00
#include "scene/main/scene_tree.h"
#include "scene/main/window.h"
#include "scene/scene_string_names.h"
#include "servers/rendering/renderer_compositor.h"
#include "servers/rendering/rendering_server_globals.h"
2024-02-15 20:58:38 +00:00
#include "servers/xr/xr_hand_tracker.h"
#include <emscripten.h>
2020-09-26 22:15:21 +00:00
#include <stdlib.h>
void _emwebxr_on_session_supported(char *p_session_mode, int p_supported) {
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL(xr_server);
2024-02-15 20:58:38 +00:00
Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
2020-09-26 22:15:21 +00:00
ERR_FAIL_COND(interface.is_null());
String session_mode = String(p_session_mode);
interface->emit_signal(SNAME("session_supported"), session_mode, p_supported ? true : false);
2020-09-26 22:15:21 +00:00
}
void _emwebxr_on_session_started(char *p_reference_space_type, char *p_enabled_features, char *p_environment_blend_mode) {
2020-09-26 22:15:21 +00:00
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL(xr_server);
2024-02-15 20:58:38 +00:00
Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
2020-09-26 22:15:21 +00:00
ERR_FAIL_COND(interface.is_null());
String reference_space_type = String(p_reference_space_type);
2024-02-15 20:58:38 +00:00
interface->_set_reference_space_type(reference_space_type);
interface->_set_enabled_features(p_enabled_features);
interface->_set_environment_blend_mode(p_environment_blend_mode);
interface->emit_signal(SNAME("session_started"));
2020-09-26 22:15:21 +00:00
}
void _emwebxr_on_session_ended() {
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL(xr_server);
2024-02-15 20:58:38 +00:00
Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
2020-09-26 22:15:21 +00:00
ERR_FAIL_COND(interface.is_null());
interface->uninitialize();
interface->emit_signal(SNAME("session_ended"));
2020-09-26 22:15:21 +00:00
}
void _emwebxr_on_session_failed(char *p_message) {
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL(xr_server);
2024-02-15 20:58:38 +00:00
Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
2020-09-26 22:15:21 +00:00
ERR_FAIL_COND(interface.is_null());
interface->uninitialize();
2020-09-26 22:15:21 +00:00
String message = String(p_message);
interface->emit_signal(SNAME("session_failed"), message);
2020-09-26 22:15:21 +00:00
}
2022-11-19 02:43:11 +00:00
extern "C" EMSCRIPTEN_KEEPALIVE void _emwebxr_on_input_event(int p_event_type, int p_input_source_id) {
2020-09-26 22:15:21 +00:00
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL(xr_server);
2024-02-15 20:58:38 +00:00
Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
2020-09-26 22:15:21 +00:00
ERR_FAIL_COND(interface.is_null());
2024-02-15 20:58:38 +00:00
interface->_on_input_event(p_event_type, p_input_source_id);
2020-09-26 22:15:21 +00:00
}
extern "C" EMSCRIPTEN_KEEPALIVE void _emwebxr_on_simple_event(char *p_signal_name) {
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL(xr_server);
2024-02-15 20:58:38 +00:00
Ref<WebXRInterfaceJS> interface = xr_server->find_interface("WebXR");
2020-09-26 22:15:21 +00:00
ERR_FAIL_COND(interface.is_null());
StringName signal_name = StringName(p_signal_name);
interface->emit_signal(signal_name);
2020-09-26 22:15:21 +00:00
}
void WebXRInterfaceJS::is_session_supported(const String &p_session_mode) {
godot_webxr_is_session_supported(p_session_mode.utf8().get_data(), &_emwebxr_on_session_supported);
}
void WebXRInterfaceJS::set_session_mode(String p_session_mode) {
session_mode = p_session_mode;
}
String WebXRInterfaceJS::get_session_mode() const {
return session_mode;
}
void WebXRInterfaceJS::set_required_features(String p_required_features) {
required_features = p_required_features;
}
String WebXRInterfaceJS::get_required_features() const {
return required_features;
}
void WebXRInterfaceJS::set_optional_features(String p_optional_features) {
optional_features = p_optional_features;
}
String WebXRInterfaceJS::get_optional_features() const {
return optional_features;
}
void WebXRInterfaceJS::set_requested_reference_space_types(String p_requested_reference_space_types) {
requested_reference_space_types = p_requested_reference_space_types;
}
String WebXRInterfaceJS::get_requested_reference_space_types() const {
return requested_reference_space_types;
}
String WebXRInterfaceJS::get_reference_space_type() const {
return reference_space_type;
}
2024-02-15 20:58:38 +00:00
String WebXRInterfaceJS::get_enabled_features() const {
return enabled_features;
}
2022-11-19 02:43:11 +00:00
bool WebXRInterfaceJS::is_input_source_active(int p_input_source_id) const {
ERR_FAIL_INDEX_V(p_input_source_id, input_source_count, false);
return input_sources[p_input_source_id].active;
}
2020-09-26 22:15:21 +00:00
Ref<XRControllerTracker> WebXRInterfaceJS::get_input_source_tracker(int p_input_source_id) const {
ERR_FAIL_INDEX_V(p_input_source_id, input_source_count, Ref<XRControllerTracker>());
2022-11-19 02:43:11 +00:00
return input_sources[p_input_source_id].tracker;
}
2021-08-29 06:05:11 +00:00
2022-11-19 02:43:11 +00:00
WebXRInterface::TargetRayMode WebXRInterfaceJS::get_input_source_target_ray_mode(int p_input_source_id) const {
ERR_FAIL_INDEX_V(p_input_source_id, input_source_count, WebXRInterface::TARGET_RAY_MODE_UNKNOWN);
if (!input_sources[p_input_source_id].active) {
return WebXRInterface::TARGET_RAY_MODE_UNKNOWN;
}
return input_sources[p_input_source_id].target_ray_mode;
2020-09-26 22:15:21 +00:00
}
String WebXRInterfaceJS::get_visibility_state() const {
char *c_str = godot_webxr_get_visibility_state();
if (c_str) {
String visibility_state = String(c_str);
free(c_str);
return visibility_state;
}
return String();
}
2022-11-19 02:43:11 +00:00
PackedVector3Array WebXRInterfaceJS::get_play_area() const {
2020-09-26 22:15:21 +00:00
PackedVector3Array ret;
2022-11-19 02:43:11 +00:00
float *points;
int point_count = godot_webxr_get_bounds_geometry(&points);
if (point_count > 0) {
ret.resize(point_count);
for (int i = 0; i < point_count; i++) {
float *js_vector3 = points + (i * 3);
2020-09-26 22:15:21 +00:00
ret.set(i, Vector3(js_vector3[0], js_vector3[1], js_vector3[2]));
}
2022-11-19 02:43:11 +00:00
free(points);
2020-09-26 22:15:21 +00:00
}
return ret;
}
float WebXRInterfaceJS::get_display_refresh_rate() const {
return godot_webxr_get_frame_rate();
}
void WebXRInterfaceJS::set_display_refresh_rate(float p_refresh_rate) {
godot_webxr_update_target_frame_rate(p_refresh_rate);
}
Array WebXRInterfaceJS::get_available_display_refresh_rates() const {
Array ret;
float *rates;
int rate_count = godot_webxr_get_supported_frame_rates(&rates);
if (rate_count > 0) {
ret.resize(rate_count);
for (int i = 0; i < rate_count; i++) {
ret[i] = rates[i];
}
free(rates);
}
return ret;
}
Array WebXRInterfaceJS::get_supported_environment_blend_modes() {
Array blend_modes;
// The blend mode can't be changed, so return the current blend mode as the only supported one.
blend_modes.push_back(environment_blend_mode);
return blend_modes;
}
XRInterface::EnvironmentBlendMode WebXRInterfaceJS::get_environment_blend_mode() const {
return environment_blend_mode;
}
bool WebXRInterfaceJS::set_environment_blend_mode(EnvironmentBlendMode p_new_environment_blend_mode) {
if (environment_blend_mode == p_new_environment_blend_mode) {
// Environment blend mode can't be changed, but we'll consider it a success to set it
// to what it already is.
return true;
}
return false;
}
void WebXRInterfaceJS::_set_environment_blend_mode(String p_blend_mode_string) {
if (p_blend_mode_string == "opaque") {
environment_blend_mode = XRInterface::XR_ENV_BLEND_MODE_OPAQUE;
} else if (p_blend_mode_string == "additive") {
environment_blend_mode = XRInterface::XR_ENV_BLEND_MODE_ADDITIVE;
} else if (p_blend_mode_string == "alpha-blend") {
environment_blend_mode = XRInterface::XR_ENV_BLEND_MODE_ALPHA_BLEND;
} else {
// Not all browsers can give us this information, so as a fallback,
// we'll make some guesses about the blend mode.
if (session_mode == "immersive-ar") {
environment_blend_mode = XRInterface::XR_ENV_BLEND_MODE_ALPHA_BLEND;
} else {
environment_blend_mode = XRInterface::XR_ENV_BLEND_MODE_OPAQUE;
}
}
}
2020-09-26 22:15:21 +00:00
StringName WebXRInterfaceJS::get_name() const {
return "WebXR";
};
uint32_t WebXRInterfaceJS::get_capabilities() const {
2022-11-19 02:43:11 +00:00
return XRInterface::XR_STEREO | XRInterface::XR_MONO | XRInterface::XR_VR | XRInterface::XR_AR;
2020-09-26 22:15:21 +00:00
};
uint32_t WebXRInterfaceJS::get_view_count() {
return godot_webxr_get_view_count();
2020-09-26 22:15:21 +00:00
};
bool WebXRInterfaceJS::is_initialized() const {
return (initialized);
};
bool WebXRInterfaceJS::initialize() {
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL_V(xr_server, false);
if (!initialized) {
if (!godot_webxr_is_supported()) {
return false;
}
if (requested_reference_space_types.size() == 0) {
return false;
}
2024-02-15 20:58:38 +00:00
enabled_features.clear();
// We must create a tracker for our head.
head_transform.basis = Basis();
head_transform.origin = Vector3();
2021-08-29 06:05:11 +00:00
head_tracker.instantiate();
head_tracker->set_tracker_type(XRServer::TRACKER_HEAD);
head_tracker->set_tracker_name("head");
head_tracker->set_tracker_desc("Players head");
xr_server->add_tracker(head_tracker);
2024-02-15 20:58:38 +00:00
// Make this our primary interface.
2020-09-26 22:15:21 +00:00
xr_server->set_primary_interface(this);
// Clear render_targetsize to make sure it gets reset to the new size.
// Clearing in uninitialize() doesn't work because a frame can still be
// rendered after it's called, which will fill render_targetsize again.
render_targetsize.width = 0;
render_targetsize.height = 0;
2020-09-26 22:15:21 +00:00
initialized = true;
godot_webxr_initialize(
session_mode.utf8().get_data(),
required_features.utf8().get_data(),
optional_features.utf8().get_data(),
requested_reference_space_types.utf8().get_data(),
&_emwebxr_on_session_started,
&_emwebxr_on_session_ended,
&_emwebxr_on_session_failed,
&_emwebxr_on_input_event,
&_emwebxr_on_simple_event);
};
return true;
};
void WebXRInterfaceJS::uninitialize() {
if (initialized) {
XRServer *xr_server = XRServer::get_singleton();
2021-08-29 06:05:11 +00:00
if (xr_server != nullptr) {
if (head_tracker.is_valid()) {
xr_server->remove_tracker(head_tracker);
head_tracker.unref();
}
2024-02-15 20:58:38 +00:00
for (int i = 0; i < HAND_MAX; i++) {
if (hand_trackers[i].is_valid()) {
xr_server->remove_tracker(hand_trackers[i]);
2024-02-15 20:58:38 +00:00
hand_trackers[i].unref();
}
}
2021-08-29 06:05:11 +00:00
if (xr_server->get_primary_interface() == this) {
// no longer our primary interface
xr_server->set_primary_interface(nullptr);
}
2020-09-26 22:15:21 +00:00
}
godot_webxr_uninitialize();
2023-11-08 20:54:29 +00:00
GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
2022-11-19 02:43:11 +00:00
if (texture_storage != nullptr) {
for (KeyValue<unsigned int, RID> &E : texture_cache) {
// Forcibly mark as not part of a render target so we can free it.
GLES3::Texture *texture = texture_storage->get_texture(E.value);
texture->is_render_target = false;
texture_storage->texture_free(E.value);
}
}
texture_cache.clear();
2024-02-15 20:58:38 +00:00
reference_space_type.clear();
enabled_features.clear();
environment_blend_mode = XRInterface::XR_ENV_BLEND_MODE_OPAQUE;
2020-09-26 22:15:21 +00:00
initialized = false;
};
};
Dictionary WebXRInterfaceJS::get_system_info() {
Dictionary dict;
// TODO get actual information from WebXR to return here
dict[SNAME("XRRuntimeName")] = String("WebXR");
dict[SNAME("XRRuntimeVersion")] = String("");
return dict;
}
Transform3D WebXRInterfaceJS::_js_matrix_to_transform(float *p_js_matrix) {
Transform3D transform;
2020-09-26 22:15:21 +00:00
2022-04-24 22:07:35 +00:00
transform.basis.rows[0].x = p_js_matrix[0];
transform.basis.rows[1].x = p_js_matrix[1];
transform.basis.rows[2].x = p_js_matrix[2];
transform.basis.rows[0].y = p_js_matrix[4];
transform.basis.rows[1].y = p_js_matrix[5];
transform.basis.rows[2].y = p_js_matrix[6];
transform.basis.rows[0].z = p_js_matrix[8];
transform.basis.rows[1].z = p_js_matrix[9];
transform.basis.rows[2].z = p_js_matrix[10];
2020-09-26 22:15:21 +00:00
transform.origin.x = p_js_matrix[12];
transform.origin.y = p_js_matrix[13];
transform.origin.z = p_js_matrix[14];
return transform;
}
Size2 WebXRInterfaceJS::get_render_target_size() {
if (render_targetsize.width != 0 && render_targetsize.height != 0) {
return render_targetsize;
}
2020-09-26 22:15:21 +00:00
2022-11-19 02:43:11 +00:00
int js_size[2];
bool has_size = godot_webxr_get_render_target_size(js_size);
2020-09-26 22:15:21 +00:00
2022-11-19 02:43:11 +00:00
if (!initialized || !has_size) {
// As a temporary default (until WebXR is fully initialized), use the
// window size.
return DisplayServer::get_singleton()->window_get_size();
}
2020-09-26 22:15:21 +00:00
2022-11-19 02:43:11 +00:00
render_targetsize.width = (float)js_size[0];
render_targetsize.height = (float)js_size[1];
2020-09-26 22:15:21 +00:00
return render_targetsize;
2020-09-26 22:15:21 +00:00
};
Transform3D WebXRInterfaceJS::get_camera_transform() {
2022-11-19 02:43:11 +00:00
Transform3D camera_transform;
2020-09-26 22:15:21 +00:00
XRServer *xr_server = XRServer::get_singleton();
2022-11-19 02:43:11 +00:00
ERR_FAIL_NULL_V(xr_server, camera_transform);
2020-09-26 22:15:21 +00:00
if (initialized) {
2023-01-24 03:26:38 +00:00
double world_scale = xr_server->get_world_scale();
Transform3D _head_transform = head_transform;
_head_transform.origin *= world_scale;
2022-11-19 02:43:11 +00:00
camera_transform = (xr_server->get_reference_frame()) * _head_transform;
}
2022-11-19 02:43:11 +00:00
return camera_transform;
};
Transform3D WebXRInterfaceJS::get_transform_for_view(uint32_t p_view, const Transform3D &p_cam_transform) {
XRServer *xr_server = XRServer::get_singleton();
2022-11-19 02:43:11 +00:00
ERR_FAIL_NULL_V(xr_server, p_cam_transform);
ERR_FAIL_COND_V(!initialized, p_cam_transform);
2022-11-19 02:43:11 +00:00
float js_matrix[16];
bool has_transform = godot_webxr_get_transform_for_view(p_view, js_matrix);
if (!has_transform) {
return p_cam_transform;
2020-09-26 22:15:21 +00:00
}
2022-11-19 02:43:11 +00:00
Transform3D transform_for_view = _js_matrix_to_transform(js_matrix);
2020-09-26 22:15:21 +00:00
2023-01-24 03:26:38 +00:00
double world_scale = xr_server->get_world_scale();
transform_for_view.origin *= world_scale;
2022-11-19 02:43:11 +00:00
return p_cam_transform * xr_server->get_reference_frame() * transform_for_view;
2020-09-26 22:15:21 +00:00
};
Projection WebXRInterfaceJS::get_projection_for_view(uint32_t p_view, double p_aspect, double p_z_near, double p_z_far) {
2022-11-19 02:43:11 +00:00
Projection view;
ERR_FAIL_COND_V(!initialized, view);
2020-09-26 22:15:21 +00:00
2022-11-19 02:43:11 +00:00
float js_matrix[16];
bool has_projection = godot_webxr_get_projection_for_view(p_view, js_matrix);
if (!has_projection) {
return view;
2020-09-26 22:15:21 +00:00
}
int k = 0;
for (int i = 0; i < 4; i++) {
for (int j = 0; j < 4; j++) {
2022-11-19 02:43:11 +00:00
view.columns[i][j] = js_matrix[k++];
2020-09-26 22:15:21 +00:00
}
}
// Copied from godot_oculus_mobile's ovr_mobile_session.cpp
2022-11-19 02:43:11 +00:00
view.columns[2][2] = -(p_z_far + p_z_near) / (p_z_far - p_z_near);
view.columns[3][2] = -(2.0f * p_z_far * p_z_near) / (p_z_far - p_z_near);
2020-09-26 22:15:21 +00:00
2022-11-19 02:43:11 +00:00
return view;
}
bool WebXRInterfaceJS::pre_draw_viewport(RID p_render_target) {
2023-11-08 20:54:29 +00:00
GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
2022-11-19 02:43:11 +00:00
if (texture_storage == nullptr) {
return false;
}
// Cache the resources so we don't have to get them from JS twice.
color_texture = _get_color_texture();
depth_texture = _get_depth_texture();
// Per the WebXR spec, it returns "opaque textures" to us, which may be the
// same WebGLTexture object (which would be the same GLuint in C++) but
// represent a different underlying resource (probably the next texture in
// the XR device's swap chain). In order to render to this texture, we need
// to re-attach it to the FBO, otherwise we get an "incomplete FBO" error.
//
// See: https://immersive-web.github.io/layers/#xropaquetextures
//
2023-11-08 20:54:29 +00:00
// So, even if the color and depth textures have the same GLuint as the last
// frame, we need to re-attach them again.
texture_storage->render_target_set_reattach_textures(p_render_target, true);
2022-11-19 02:43:11 +00:00
return true;
2020-09-26 22:15:21 +00:00
}
Vector<BlitToScreen> WebXRInterfaceJS::post_draw_viewport(RID p_render_target, const Rect2 &p_screen_rect) {
Vector<BlitToScreen> blit_to_screen;
2023-11-08 20:54:29 +00:00
GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
if (texture_storage == nullptr) {
return blit_to_screen;
}
texture_storage->render_target_set_reattach_textures(p_render_target, false);
2022-11-19 02:43:11 +00:00
return blit_to_screen;
};
RID WebXRInterfaceJS::_get_color_texture() {
unsigned int texture_id = godot_webxr_get_color_texture();
if (texture_id == 0) {
return RID();
}
return _get_texture(texture_id);
}
RID WebXRInterfaceJS::_get_depth_texture() {
unsigned int texture_id = godot_webxr_get_depth_texture();
if (texture_id == 0) {
return RID();
}
return _get_texture(texture_id);
}
RID WebXRInterfaceJS::_get_texture(unsigned int p_texture_id) {
RBMap<unsigned int, RID>::Element *cache = texture_cache.find(p_texture_id);
if (cache != nullptr) {
return cache->get();
}
2023-11-08 20:54:29 +00:00
GLES3::TextureStorage *texture_storage = GLES3::TextureStorage::get_singleton();
2022-11-19 02:43:11 +00:00
if (texture_storage == nullptr) {
return RID();
}
2022-11-19 02:43:11 +00:00
uint32_t view_count = godot_webxr_get_view_count();
Size2 texture_size = get_render_target_size();
2022-11-19 02:43:11 +00:00
RID texture = texture_storage->texture_create_external(
view_count == 1 ? GLES3::Texture::TYPE_2D : GLES3::Texture::TYPE_LAYERED,
Image::FORMAT_RGBA8,
p_texture_id,
(int)texture_size.width,
(int)texture_size.height,
1,
view_count);
2022-11-19 02:43:11 +00:00
texture_cache.insert(p_texture_id, texture);
return texture;
}
RID WebXRInterfaceJS::get_color_texture() {
return color_texture;
}
RID WebXRInterfaceJS::get_depth_texture() {
return depth_texture;
}
RID WebXRInterfaceJS::get_velocity_texture() {
unsigned int texture_id = godot_webxr_get_velocity_texture();
if (texture_id == 0) {
return RID();
}
return _get_texture(texture_id);
}
2020-09-26 22:15:21 +00:00
void WebXRInterfaceJS::process() {
if (initialized) {
// Get the "head" position.
2022-11-19 02:43:11 +00:00
float js_matrix[16];
if (godot_webxr_get_transform_for_view(-1, js_matrix)) {
head_transform = _js_matrix_to_transform(js_matrix);
}
2021-08-29 06:05:11 +00:00
if (head_tracker.is_valid()) {
head_tracker->set_pose("default", head_transform, Vector3(), Vector3());
2021-08-29 06:05:11 +00:00
}
2022-11-19 02:43:11 +00:00
// Update all input sources.
for (int i = 0; i < input_source_count; i++) {
_update_input_source(i);
2020-09-26 22:15:21 +00:00
}
};
};
2022-11-19 02:43:11 +00:00
void WebXRInterfaceJS::_update_input_source(int p_input_source_id) {
2020-09-26 22:15:21 +00:00
XRServer *xr_server = XRServer::get_singleton();
ERR_FAIL_NULL(xr_server);
2022-11-19 02:43:11 +00:00
InputSource &input_source = input_sources[p_input_source_id];
float target_pose[16];
int tmp_target_ray_mode;
int touch_index;
int has_grip_pose;
float grip_pose[16];
int has_standard_mapping;
int button_count;
float buttons[10];
int axes_count;
float axes[10];
2024-02-15 20:58:38 +00:00
int has_hand_data;
float hand_joints[WEBXR_HAND_JOINT_MAX * 16];
float hand_radii[WEBXR_HAND_JOINT_MAX];
2022-11-19 02:43:11 +00:00
input_source.active = godot_webxr_update_input_source(
p_input_source_id,
target_pose,
&tmp_target_ray_mode,
&touch_index,
&has_grip_pose,
grip_pose,
&has_standard_mapping,
&button_count,
buttons,
&axes_count,
2024-02-15 20:58:38 +00:00
axes,
&has_hand_data,
hand_joints,
hand_radii);
2022-11-19 02:43:11 +00:00
if (!input_source.active) {
if (input_source.tracker.is_valid()) {
xr_server->remove_tracker(input_source.tracker);
input_source.tracker.unref();
}
2021-08-29 06:05:11 +00:00
return;
}
2022-11-19 02:43:11 +00:00
input_source.target_ray_mode = (WebXRInterface::TargetRayMode)tmp_target_ray_mode;
input_source.touch_index = touch_index;
Ref<XRControllerTracker> &tracker = input_source.tracker;
2022-11-19 02:43:11 +00:00
if (tracker.is_null()) {
tracker.instantiate();
StringName tracker_name;
if (input_source.target_ray_mode == WebXRInterface::TargetRayMode::TARGET_RAY_MODE_SCREEN) {
tracker_name = touch_names[touch_index];
} else {
tracker_name = tracker_names[p_input_source_id];
2020-09-26 22:15:21 +00:00
}
2022-11-19 02:43:11 +00:00
// Input source id's 0 and 1 are always the left and right hands.
if (p_input_source_id < 2) {
tracker->set_tracker_name(tracker_name);
tracker->set_tracker_desc(p_input_source_id == 0 ? "Left hand controller" : "Right hand controller");
tracker->set_tracker_hand(p_input_source_id == 0 ? XRPositionalTracker::TRACKER_HAND_LEFT : XRPositionalTracker::TRACKER_HAND_RIGHT);
} else {
tracker->set_tracker_name(tracker_name);
tracker->set_tracker_desc(tracker_name);
2020-09-26 22:15:21 +00:00
}
2022-11-19 02:43:11 +00:00
xr_server->add_tracker(tracker);
}
2020-09-26 22:15:21 +00:00
2022-11-19 02:43:11 +00:00
Transform3D aim_transform = _js_matrix_to_transform(target_pose);
tracker->set_pose(SceneStringName(default_), aim_transform, Vector3(), Vector3());
2022-11-19 02:43:11 +00:00
tracker->set_pose(SNAME("aim"), aim_transform, Vector3(), Vector3());
if (has_grip_pose) {
tracker->set_pose(SNAME("grip"), _js_matrix_to_transform(grip_pose), Vector3(), Vector3());
}
2021-08-29 06:05:11 +00:00
2022-11-19 02:43:11 +00:00
for (int i = 0; i < button_count; i++) {
StringName button_name = has_standard_mapping ? standard_button_names[i] : unknown_button_names[i];
StringName button_pressure_name = has_standard_mapping ? standard_button_pressure_names[i] : unknown_button_pressure_names[i];
float value = buttons[i];
bool state = value > 0.0;
tracker->set_input(button_name, state);
tracker->set_input(button_pressure_name, value);
}
2021-08-29 06:05:11 +00:00
2022-11-19 02:43:11 +00:00
for (int i = 0; i < axes_count; i++) {
StringName axis_name = has_standard_mapping ? standard_axis_names[i] : unknown_axis_names[i];
float value = axes[i];
if (has_standard_mapping && (i == 1 || i == 3)) {
// Invert the Y-axis on thumbsticks and trackpads, in order to
// match OpenXR and other XR platform SDKs.
value = -value;
2020-09-26 22:15:21 +00:00
}
2022-11-19 02:43:11 +00:00
tracker->set_input(axis_name, value);
}
2020-09-26 22:15:21 +00:00
2022-11-19 02:43:11 +00:00
// Also create Vector2's for the thumbstick and trackpad when we have the
// standard mapping.
if (has_standard_mapping) {
if (axes_count >= 2) {
tracker->set_input(standard_vector_names[0], Vector2(axes[0], -axes[1]));
}
if (axes_count >= 4) {
tracker->set_input(standard_vector_names[1], Vector2(axes[2], -axes[3]));
}
}
2021-08-29 06:05:11 +00:00
2022-11-19 02:43:11 +00:00
if (input_source.target_ray_mode == WebXRInterface::TARGET_RAY_MODE_SCREEN) {
if (touch_index < 5 && axes_count >= 2) {
Vector2 joy_vector = Vector2(axes[0], axes[1]);
Vector2 position = _get_screen_position_from_joy_vector(joy_vector);
if (touches[touch_index].is_touching) {
Vector2 delta = position - touches[touch_index].position;
// If position has changed by at least 1 pixel, generate a drag event.
if (abs(delta.x) >= 1.0 || abs(delta.y) >= 1.0) {
Ref<InputEventScreenDrag> event;
event.instantiate();
event->set_index(touch_index);
event->set_position(position);
event->set_relative(delta);
event->set_relative_screen_position(delta);
2022-11-19 02:43:11 +00:00
Input::get_singleton()->parse_input_event(event);
}
2020-09-26 22:15:21 +00:00
}
2022-11-19 02:43:11 +00:00
touches[touch_index].position = position;
2020-09-26 22:15:21 +00:00
}
}
2024-02-15 20:58:38 +00:00
if (p_input_source_id < 2) {
Ref<XRHandTracker> hand_tracker = hand_trackers[p_input_source_id];
if (has_hand_data) {
// Transform orientations to match Godot Humanoid skeleton.
const Basis bone_adjustment(
Vector3(-1.0, 0.0, 0.0),
Vector3(0.0, 0.0, -1.0),
Vector3(0.0, -1.0, 0.0));
if (unlikely(hand_tracker.is_null())) {
hand_tracker.instantiate();
hand_tracker->set_tracker_hand(p_input_source_id == 0 ? XRPositionalTracker::TRACKER_HAND_LEFT : XRPositionalTracker::TRACKER_HAND_RIGHT);
hand_tracker->set_tracker_name(p_input_source_id == 0 ? "/user/hand_tracker/left" : "/user/hand_tracker/right");
2024-02-15 20:58:38 +00:00
// These flags always apply, since WebXR doesn't give us enough insight to be more fine grained.
BitField<XRHandTracker::HandJointFlags> joint_flags(XRHandTracker::HAND_JOINT_FLAG_POSITION_VALID | XRHandTracker::HAND_JOINT_FLAG_ORIENTATION_VALID | XRHandTracker::HAND_JOINT_FLAG_POSITION_TRACKED | XRHandTracker::HAND_JOINT_FLAG_ORIENTATION_TRACKED);
for (int godot_joint = 0; godot_joint < XRHandTracker::HAND_JOINT_MAX; godot_joint++) {
hand_tracker->set_hand_joint_flags((XRHandTracker::HandJoint)godot_joint, joint_flags);
}
hand_trackers[p_input_source_id] = hand_tracker;
xr_server->add_tracker(hand_tracker);
2024-02-15 20:58:38 +00:00
}
hand_tracker->set_has_tracking_data(true);
for (int webxr_joint = 0; webxr_joint < WEBXR_HAND_JOINT_MAX; webxr_joint++) {
XRHandTracker::HandJoint godot_joint = (XRHandTracker::HandJoint)(webxr_joint + 1);
Transform3D joint_transform = _js_matrix_to_transform(hand_joints + (16 * webxr_joint));
joint_transform.basis *= bone_adjustment;
hand_tracker->set_hand_joint_transform(godot_joint, joint_transform);
hand_tracker->set_hand_joint_radius(godot_joint, hand_radii[webxr_joint]);
}
// WebXR doesn't have a palm joint, so we calculate it by finding the middle of the middle finger metacarpal bone.
{
// Start by getting the middle finger metacarpal joint.
// Note: 10 is the WebXR middle finger metacarpal joint.
Transform3D palm_transform = _js_matrix_to_transform(hand_joints + (10 * 16));
palm_transform.basis *= bone_adjustment;
// Get the middle finger phalanx position.
// Note: 11 is the WebXR middle finger phalanx proximal joint and 12 is the origin offset.
const float *phalanx_pos = hand_joints + (11 * 16) + 12;
Vector3 phalanx(phalanx_pos[0], phalanx_pos[1], phalanx_pos[2]);
// Offset the palm half-way towards the phalanx joint.
palm_transform.origin = (palm_transform.origin + phalanx) / 2.0;
// Set the palm joint and the pose.
2024-02-15 20:58:38 +00:00
hand_tracker->set_hand_joint_transform(XRHandTracker::HAND_JOINT_PALM, palm_transform);
hand_tracker->set_pose("default", palm_transform, Vector3(), Vector3());
2024-02-15 20:58:38 +00:00
}
} else if (hand_tracker.is_valid()) {
hand_tracker->set_has_tracking_data(false);
hand_tracker->invalidate_pose("default");
2024-02-15 20:58:38 +00:00
}
}
2020-09-26 22:15:21 +00:00
}
2022-11-19 02:43:11 +00:00
void WebXRInterfaceJS::_on_input_event(int p_event_type, int p_input_source_id) {
// Get the latest data for this input source. For transient input sources,
// we may not have any data at all yet!
_update_input_source(p_input_source_id);
if (p_event_type == WEBXR_INPUT_EVENT_SELECTSTART || p_event_type == WEBXR_INPUT_EVENT_SELECTEND) {
const InputSource &input_source = input_sources[p_input_source_id];
if (input_source.target_ray_mode == WebXRInterface::TARGET_RAY_MODE_SCREEN) {
int touch_index = input_source.touch_index;
if (touch_index >= 0 && touch_index < 5) {
touches[touch_index].is_touching = (p_event_type == WEBXR_INPUT_EVENT_SELECTSTART);
Ref<InputEventScreenTouch> event;
event.instantiate();
event->set_index(touch_index);
event->set_position(touches[touch_index].position);
event->set_pressed(p_event_type == WEBXR_INPUT_EVENT_SELECTSTART);
Input::get_singleton()->parse_input_event(event);
}
2020-09-26 22:15:21 +00:00
}
}
2022-11-19 02:43:11 +00:00
switch (p_event_type) {
case WEBXR_INPUT_EVENT_SELECTSTART:
emit_signal("selectstart", p_input_source_id);
break;
case WEBXR_INPUT_EVENT_SELECTEND:
emit_signal("selectend", p_input_source_id);
// Emit the 'select' event on our own (rather than intercepting the
// one from JavaScript) so that we don't have to needlessly call
// _update_input_source() a second time.
emit_signal("select", p_input_source_id);
break;
case WEBXR_INPUT_EVENT_SQUEEZESTART:
emit_signal("squeezestart", p_input_source_id);
break;
case WEBXR_INPUT_EVENT_SQUEEZEEND:
emit_signal("squeezeend", p_input_source_id);
// Again, we emit the 'squeeze' event on our own to avoid extra work.
emit_signal("squeeze", p_input_source_id);
break;
}
}
Vector2 WebXRInterfaceJS::_get_screen_position_from_joy_vector(const Vector2 &p_joy_vector) {
SceneTree *scene_tree = Object::cast_to<SceneTree>(OS::get_singleton()->get_main_loop());
if (!scene_tree) {
return Vector2();
}
Window *viewport = scene_tree->get_root();
Vector2 position_percentage((p_joy_vector.x + 1.0f) / 2.0f, ((p_joy_vector.y) + 1.0f) / 2.0f);
Vector2 position = (Size2)viewport->get_size() * position_percentage;
return position;
2020-09-26 22:15:21 +00:00
}
WebXRInterfaceJS::WebXRInterfaceJS() {
initialized = false;
session_mode = "inline";
requested_reference_space_types = "local";
};
WebXRInterfaceJS::~WebXRInterfaceJS() {
// and make sure we cleanup if we haven't already
if (initialized) {
uninitialize();
};
};
#endif // WEB_ENABLED