2023-01-05 12:25:55 +00:00
|
|
|
/**************************************************************************/
|
|
|
|
/* webxr_interface_js.h */
|
|
|
|
/**************************************************************************/
|
|
|
|
/* 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. */
|
|
|
|
/**************************************************************************/
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
#ifndef WEBXR_INTERFACE_JS_H
|
|
|
|
#define WEBXR_INTERFACE_JS_H
|
|
|
|
|
2022-08-28 18:27:45 +00:00
|
|
|
#ifdef WEB_ENABLED
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
#include "webxr_interface.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
The WebXR interface is a VR/AR interface that can be used on the web.
|
|
|
|
*/
|
|
|
|
|
2022-11-19 02:43:11 +00:00
|
|
|
namespace GLES3 {
|
|
|
|
class TextureStorage;
|
|
|
|
}
|
|
|
|
|
2020-09-26 22:15:21 +00:00
|
|
|
class WebXRInterfaceJS : public WebXRInterface {
|
|
|
|
GDCLASS(WebXRInterfaceJS, WebXRInterface);
|
|
|
|
|
|
|
|
private:
|
|
|
|
bool initialized;
|
2021-08-29 06:05:11 +00:00
|
|
|
Ref<XRPositionalTracker> head_tracker;
|
2022-08-16 22:33:26 +00:00
|
|
|
Transform3D head_transform;
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
String session_mode;
|
|
|
|
String required_features;
|
|
|
|
String optional_features;
|
|
|
|
String requested_reference_space_types;
|
|
|
|
String reference_space_type;
|
|
|
|
|
2021-01-27 20:16:00 +00:00
|
|
|
Size2 render_targetsize;
|
2022-11-19 02:43:11 +00:00
|
|
|
RBMap<unsigned int, RID> texture_cache;
|
|
|
|
struct Touch {
|
|
|
|
bool is_touching = false;
|
|
|
|
Vector2 position;
|
|
|
|
} touches[5];
|
|
|
|
|
|
|
|
static constexpr uint8_t input_source_count = 16;
|
|
|
|
|
|
|
|
struct InputSource {
|
|
|
|
Ref<XRPositionalTracker> tracker;
|
|
|
|
bool active = false;
|
|
|
|
TargetRayMode target_ray_mode;
|
|
|
|
int touch_index = -1;
|
|
|
|
} input_sources[input_source_count];
|
|
|
|
|
|
|
|
RID color_texture;
|
|
|
|
RID depth_texture;
|
|
|
|
|
|
|
|
RID _get_color_texture();
|
|
|
|
RID _get_depth_texture();
|
|
|
|
RID _get_texture(unsigned int p_texture_id);
|
2020-10-17 05:08:21 +00:00
|
|
|
Transform3D _js_matrix_to_transform(float *p_js_matrix);
|
2022-11-19 02:43:11 +00:00
|
|
|
void _update_input_source(int p_input_source_id);
|
|
|
|
|
|
|
|
Vector2 _get_screen_position_from_joy_vector(const Vector2 &p_joy_vector);
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
virtual void is_session_supported(const String &p_session_mode) override;
|
|
|
|
virtual void set_session_mode(String p_session_mode) override;
|
|
|
|
virtual String get_session_mode() const override;
|
|
|
|
virtual void set_required_features(String p_required_features) override;
|
|
|
|
virtual String get_required_features() const override;
|
|
|
|
virtual void set_optional_features(String p_optional_features) override;
|
|
|
|
virtual String get_optional_features() const override;
|
|
|
|
virtual void set_requested_reference_space_types(String p_requested_reference_space_types) override;
|
|
|
|
virtual String get_requested_reference_space_types() const override;
|
|
|
|
void _set_reference_space_type(String p_reference_space_type);
|
|
|
|
virtual String get_reference_space_type() const override;
|
2022-11-19 02:43:11 +00:00
|
|
|
virtual bool is_input_source_active(int p_input_source_id) const override;
|
|
|
|
virtual Ref<XRPositionalTracker> get_input_source_tracker(int p_input_source_id) const override;
|
|
|
|
virtual TargetRayMode get_input_source_target_ray_mode(int p_input_source_id) const override;
|
2020-09-26 22:15:21 +00:00
|
|
|
virtual String get_visibility_state() const override;
|
2022-11-19 02:43:11 +00:00
|
|
|
virtual PackedVector3Array get_play_area() const override;
|
2020-09-26 22:15:21 +00:00
|
|
|
|
2023-02-09 03:02:13 +00:00
|
|
|
virtual float get_display_refresh_rate() const override;
|
|
|
|
virtual void set_display_refresh_rate(float p_refresh_rate) override;
|
|
|
|
virtual Array get_available_display_refresh_rates() const override;
|
|
|
|
|
2020-09-26 22:15:21 +00:00
|
|
|
virtual StringName get_name() const override;
|
2021-08-23 05:23:16 +00:00
|
|
|
virtual uint32_t get_capabilities() const override;
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
virtual bool is_initialized() const override;
|
|
|
|
virtual bool initialize() override;
|
|
|
|
virtual void uninitialize() override;
|
2023-03-13 01:26:10 +00:00
|
|
|
virtual Dictionary get_system_info() override;
|
2020-09-26 22:15:21 +00:00
|
|
|
|
2021-08-23 05:23:16 +00:00
|
|
|
virtual Size2 get_render_target_size() override;
|
2021-07-07 14:31:06 +00:00
|
|
|
virtual uint32_t get_view_count() override;
|
2021-05-07 13:19:04 +00:00
|
|
|
virtual Transform3D get_camera_transform() override;
|
|
|
|
virtual Transform3D get_transform_for_view(uint32_t p_view, const Transform3D &p_cam_transform) override;
|
Implement Vector4, Vector4i, Projection
Implement built-in classes Vector4, Vector4i and Projection.
* Two versions of Vector4 (float and integer).
* A Projection class, which is a 4x4 matrix specialized in projection types.
These types have been requested for a long time, but given they were very corner case they were not added before.
Because in Godot 4, reimplementing parts of the rendering engine is now possible, access to these types (heavily used by the rendering code) becomes a necessity.
**Q**: Why Projection and not Matrix4?
**A**: Godot does not use Matrix2, Matrix3, Matrix4x3, etc. naming convention because, within the engine, these types always have a *purpose*. As such, Godot names them: Transform2D, Transform3D or Basis. In this case, this 4x4 matrix is _always_ used as a _Projection_, hence the naming.
2022-07-19 23:11:13 +00:00
|
|
|
virtual Projection get_projection_for_view(uint32_t p_view, double p_aspect, double p_z_near, double p_z_far) override;
|
2022-11-19 02:43:11 +00:00
|
|
|
virtual bool pre_draw_viewport(RID p_render_target) override;
|
2022-01-26 01:25:20 +00:00
|
|
|
virtual Vector<BlitToScreen> post_draw_viewport(RID p_render_target, const Rect2 &p_screen_rect) override;
|
2022-11-19 02:43:11 +00:00
|
|
|
virtual RID get_color_texture() override;
|
|
|
|
virtual RID get_depth_texture() override;
|
|
|
|
virtual RID get_velocity_texture() override;
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
virtual void process() override;
|
|
|
|
|
2022-11-19 02:43:11 +00:00
|
|
|
void _on_input_event(int p_event_type, int p_input_source_id);
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
WebXRInterfaceJS();
|
|
|
|
~WebXRInterfaceJS();
|
2022-11-19 02:43:11 +00:00
|
|
|
|
|
|
|
private:
|
|
|
|
StringName tracker_names[16] = {
|
|
|
|
StringName("left_hand"),
|
|
|
|
StringName("right_hand"),
|
|
|
|
StringName("tracker_2"),
|
|
|
|
StringName("tracker_3"),
|
|
|
|
StringName("tracker_4"),
|
|
|
|
StringName("tracker_5"),
|
|
|
|
StringName("tracker_6"),
|
|
|
|
StringName("tracker_7"),
|
|
|
|
StringName("tracker_8"),
|
|
|
|
StringName("tracker_9"),
|
|
|
|
StringName("tracker_10"),
|
|
|
|
StringName("tracker_11"),
|
|
|
|
StringName("tracker_12"),
|
|
|
|
StringName("tracker_13"),
|
|
|
|
StringName("tracker_14"),
|
|
|
|
StringName("tracker_15"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName touch_names[5] = {
|
|
|
|
StringName("touch_0"),
|
|
|
|
StringName("touch_1"),
|
|
|
|
StringName("touch_2"),
|
|
|
|
StringName("touch_3"),
|
|
|
|
StringName("touch_4"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName standard_axis_names[10] = {
|
|
|
|
StringName("touchpad_x"),
|
|
|
|
StringName("touchpad_y"),
|
|
|
|
StringName("thumbstick_x"),
|
|
|
|
StringName("thumbstick_y"),
|
|
|
|
StringName("axis_4"),
|
|
|
|
StringName("axis_5"),
|
|
|
|
StringName("axis_6"),
|
|
|
|
StringName("axis_7"),
|
|
|
|
StringName("axis_8"),
|
|
|
|
StringName("axis_9"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName standard_vector_names[2] = {
|
|
|
|
StringName("touchpad"),
|
|
|
|
StringName("thumbstick"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName standard_button_names[10] = {
|
|
|
|
StringName("trigger_click"),
|
|
|
|
StringName("grip_click"),
|
|
|
|
StringName("touchpad_click"),
|
|
|
|
StringName("thumbstick_click"),
|
|
|
|
StringName("ax_button"),
|
|
|
|
StringName("by_button"),
|
|
|
|
StringName("button_6"),
|
|
|
|
StringName("button_7"),
|
|
|
|
StringName("button_8"),
|
|
|
|
StringName("button_9"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName standard_button_pressure_names[10] = {
|
|
|
|
StringName("trigger"),
|
|
|
|
StringName("grip"),
|
|
|
|
StringName("touchpad_click_pressure"),
|
|
|
|
StringName("thumbstick_click_pressure"),
|
|
|
|
StringName("ax_button_pressure"),
|
|
|
|
StringName("by_button_pressure"),
|
|
|
|
StringName("button_pressure_6"),
|
|
|
|
StringName("button_pressure_7"),
|
|
|
|
StringName("button_pressure_8"),
|
|
|
|
StringName("button_pressure_9"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName unknown_button_names[10] = {
|
|
|
|
StringName("button_0"),
|
|
|
|
StringName("button_1"),
|
|
|
|
StringName("button_2"),
|
|
|
|
StringName("button_3"),
|
|
|
|
StringName("button_4"),
|
|
|
|
StringName("button_5"),
|
|
|
|
StringName("button_6"),
|
|
|
|
StringName("button_7"),
|
|
|
|
StringName("button_8"),
|
|
|
|
StringName("button_9"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName unknown_axis_names[10] = {
|
|
|
|
StringName("axis_0"),
|
|
|
|
StringName("axis_1"),
|
|
|
|
StringName("axis_2"),
|
|
|
|
StringName("axis_3"),
|
|
|
|
StringName("axis_4"),
|
|
|
|
StringName("axis_5"),
|
|
|
|
StringName("axis_6"),
|
|
|
|
StringName("axis_7"),
|
|
|
|
StringName("axis_8"),
|
|
|
|
StringName("axis_9"),
|
|
|
|
};
|
|
|
|
|
|
|
|
StringName unknown_button_pressure_names[10] = {
|
|
|
|
StringName("button_pressure_0"),
|
|
|
|
StringName("button_pressure_1"),
|
|
|
|
StringName("button_pressure_2"),
|
|
|
|
StringName("button_pressure_3"),
|
|
|
|
StringName("button_pressure_4"),
|
|
|
|
StringName("button_pressure_5"),
|
|
|
|
StringName("button_pressure_6"),
|
|
|
|
StringName("button_pressure_7"),
|
|
|
|
StringName("button_pressure_8"),
|
|
|
|
StringName("button_pressure_9"),
|
|
|
|
};
|
2020-09-26 22:15:21 +00:00
|
|
|
};
|
|
|
|
|
2022-08-28 18:27:45 +00:00
|
|
|
#endif // WEB_ENABLED
|
2020-09-26 22:15:21 +00:00
|
|
|
|
|
|
|
#endif // WEBXR_INTERFACE_JS_H
|