CoCalc -- openxr_dpad_binding

GitHub Repository: godotengine/godot
Path: blob/master/modules/openxr/extensions/openxr_dpad_binding_extension.cpp
¹⁰²⁷⁸ views
1
/**************************************************************************/
2
/*  openxr_dpad_binding_extension.cpp                                     */
3
/**************************************************************************/
4
/*                         This file is part of:                          */
5
/*                             GODOT ENGINE                               */
6
/*                        https://godotengine.org                         */
7
/**************************************************************************/
8
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
10
/*                                                                        */
11
/* Permission is hereby granted, free of charge, to any person obtaining  */
12
/* a copy of this software and associated documentation files (the        */
13
/* "Software"), to deal in the Software without restriction, including    */
14
/* without limitation the rights to use, copy, modify, merge, publish,    */
15
/* distribute, sublicense, and/or sell copies of the Software, and to     */
16
/* permit persons to whom the Software is furnished to do so, subject to  */
17
/* the following conditions:                                              */
18
/*                                                                        */
19
/* The above copyright notice and this permission notice shall be         */
20
/* included in all copies or substantial portions of the Software.        */
21
/*                                                                        */
22
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,        */
23
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF     */
24
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY   */
26
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,   */
27
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE      */
28
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                 */
29
/**************************************************************************/
30

31
#include "openxr_dpad_binding_extension.h"
32
#include "../openxr_api.h"
33
#include "core/math/math_funcs.h"
34

35
// Implementation for:
36
// https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_EXT_dpad_binding
37

38
///////////////////////////////////////////////////////////////////////////////////////////////////
39
// OpenXRDPadBindingExtension
40

41
OpenXRDPadBindingExtension *OpenXRDPadBindingExtension::singleton = nullptr;
42

43
OpenXRDPadBindingExtension *OpenXRDPadBindingExtension::get_singleton() {
44
	return singleton;
45
}
46

47
OpenXRDPadBindingExtension::OpenXRDPadBindingExtension() {
48
	singleton = this;
49
}
50

51
OpenXRDPadBindingExtension::~OpenXRDPadBindingExtension() {
52
	singleton = nullptr;
53
}
54

55
HashMap<String, bool *> OpenXRDPadBindingExtension::get_requested_extensions() {
56
	HashMap<String, bool *> request_extensions;
57

58
	// Note, we're dependent on the binding modifier extension, this may be requested by multiple extension wrappers.
59
	request_extensions[XR_KHR_BINDING_MODIFICATION_EXTENSION_NAME] = &binding_modifier_ext;
60
	request_extensions[XR_EXT_DPAD_BINDING_EXTENSION_NAME] = &dpad_binding_ext;
61

62
	return request_extensions;
63
}
64

65
bool OpenXRDPadBindingExtension::is_available() {
66
	return binding_modifier_ext && dpad_binding_ext;
67
}
68

69
///////////////////////////////////////////////////////////////////////////////////////////////////
70
// OpenXRDpadBindingModifier
71

72
void OpenXRDpadBindingModifier::_bind_methods() {
73
	ClassDB::bind_method(D_METHOD("set_action_set", "action_set"), &OpenXRDpadBindingModifier::set_action_set);
74
	ClassDB::bind_method(D_METHOD("get_action_set"), &OpenXRDpadBindingModifier::get_action_set);
75
	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "action_set", PROPERTY_HINT_RESOURCE_TYPE, "OpenXRActionSet"), "set_action_set", "get_action_set");
76

77
	ClassDB::bind_method(D_METHOD("set_input_path", "input_path"), &OpenXRDpadBindingModifier::set_input_path);
78
	ClassDB::bind_method(D_METHOD("get_input_path"), &OpenXRDpadBindingModifier::get_input_path);
79
	ADD_PROPERTY(PropertyInfo(Variant::STRING, "input_path", PROPERTY_HINT_TYPE_STRING, "binding_path"), "set_input_path", "get_input_path");
80

81
	ClassDB::bind_method(D_METHOD("set_threshold", "threshold"), &OpenXRDpadBindingModifier::set_threshold);
82
	ClassDB::bind_method(D_METHOD("get_threshold"), &OpenXRDpadBindingModifier::get_threshold);
83
	ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "threshold", PROPERTY_HINT_RANGE, "0.0,1.0,0.01"), "set_threshold", "get_threshold");
84

85
	ClassDB::bind_method(D_METHOD("set_threshold_released", "threshold_released"), &OpenXRDpadBindingModifier::set_threshold_released);
86
	ClassDB::bind_method(D_METHOD("get_threshold_released"), &OpenXRDpadBindingModifier::get_threshold_released);
87
	ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "threshold_released", PROPERTY_HINT_RANGE, "0.0,1.0,0.01"), "set_threshold_released", "get_threshold_released");
88

89
	ClassDB::bind_method(D_METHOD("set_center_region", "center_region"), &OpenXRDpadBindingModifier::set_center_region);
90
	ClassDB::bind_method(D_METHOD("get_center_region"), &OpenXRDpadBindingModifier::get_center_region);
91
	ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "center_region", PROPERTY_HINT_RANGE, "0.0,1.0,0.01"), "set_center_region", "get_center_region");
92

93
	ClassDB::bind_method(D_METHOD("set_wedge_angle", "wedge_angle"), &OpenXRDpadBindingModifier::set_wedge_angle);
94
	ClassDB::bind_method(D_METHOD("get_wedge_angle"), &OpenXRDpadBindingModifier::get_wedge_angle);
95
	ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "wedge_angle", PROPERTY_HINT_RANGE, "1.0,180.0,0.1,radians_as_degrees"), "set_wedge_angle", "get_wedge_angle");
96

97
	ClassDB::bind_method(D_METHOD("set_is_sticky", "is_sticky"), &OpenXRDpadBindingModifier::set_is_sticky);
98
	ClassDB::bind_method(D_METHOD("get_is_sticky"), &OpenXRDpadBindingModifier::get_is_sticky);
99
	ADD_PROPERTY(PropertyInfo(Variant::BOOL, "is_sticky"), "set_is_sticky", "get_is_sticky");
100

101
	ClassDB::bind_method(D_METHOD("set_on_haptic", "haptic"), &OpenXRDpadBindingModifier::set_on_haptic);
102
	ClassDB::bind_method(D_METHOD("get_on_haptic"), &OpenXRDpadBindingModifier::get_on_haptic);
103
	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "on_haptic", PROPERTY_HINT_RESOURCE_TYPE, "OpenXRHapticBase"), "set_on_haptic", "get_on_haptic");
104

105
	ClassDB::bind_method(D_METHOD("set_off_haptic", "haptic"), &OpenXRDpadBindingModifier::set_off_haptic);
106
	ClassDB::bind_method(D_METHOD("get_off_haptic"), &OpenXRDpadBindingModifier::get_off_haptic);
107
	ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "off_haptic", PROPERTY_HINT_RESOURCE_TYPE, "OpenXRHapticBase"), "set_off_haptic", "get_off_haptic");
108
}
109

110
OpenXRDpadBindingModifier::OpenXRDpadBindingModifier() {
111
	ERR_FAIL_COND(dpad_bindings_data.resize_initialized(sizeof(XrInteractionProfileDpadBindingEXT)) != OK);
112
	dpad_bindings = (XrInteractionProfileDpadBindingEXT *)dpad_bindings_data.ptrw();
113

114
	dpad_bindings->type = XR_TYPE_INTERACTION_PROFILE_DPAD_BINDING_EXT;
115
	dpad_bindings->next = nullptr;
116

117
	dpad_bindings->forceThreshold = 0.6;
118
	dpad_bindings->forceThresholdReleased = 0.4;
119
	dpad_bindings->centerRegion = 0.1;
120
	dpad_bindings->wedgeAngle = Math::deg_to_rad(90.0);
121
	dpad_bindings->isSticky = false;
122
}
123

124
void OpenXRDpadBindingModifier::set_action_set(const Ref<OpenXRActionSet> p_action_set) {
125
	action_set = p_action_set;
126
}
127

128
Ref<OpenXRActionSet> OpenXRDpadBindingModifier::get_action_set() const {
129
	return action_set;
130
}
131

132
void OpenXRDpadBindingModifier::set_input_path(const String &p_input_path) {
133
	input_path = p_input_path;
134
	emit_changed();
135
}
136

137
String OpenXRDpadBindingModifier::get_input_path() const {
138
	return input_path;
139
}
140

141
void OpenXRDpadBindingModifier::set_threshold(float p_threshold) {
142
	ERR_FAIL_NULL(dpad_bindings);
143
	ERR_FAIL_COND(p_threshold < 0.0 || p_threshold > 1.0);
144

145
	dpad_bindings->forceThreshold = p_threshold;
146
	emit_changed();
147
}
148

149
float OpenXRDpadBindingModifier::get_threshold() const {
150
	ERR_FAIL_NULL_V(dpad_bindings, 0.0);
151
	return dpad_bindings->forceThreshold;
152
}
153

154
void OpenXRDpadBindingModifier::set_threshold_released(float p_threshold) {
155
	ERR_FAIL_NULL(dpad_bindings);
156
	ERR_FAIL_COND(p_threshold < 0.0 || p_threshold > 1.0);
157

158
	dpad_bindings->forceThresholdReleased = p_threshold;
159
	emit_changed();
160
}
161

162
float OpenXRDpadBindingModifier::get_threshold_released() const {
163
	ERR_FAIL_NULL_V(dpad_bindings, 0.0);
164
	return dpad_bindings->forceThresholdReleased;
165
}
166

167
void OpenXRDpadBindingModifier::set_center_region(float p_center_region) {
168
	ERR_FAIL_NULL(dpad_bindings);
169
	ERR_FAIL_COND(p_center_region < 0.0 || p_center_region > 1.0);
170

171
	dpad_bindings->centerRegion = p_center_region;
172
	emit_changed();
173
}
174

175
float OpenXRDpadBindingModifier::get_center_region() const {
176
	ERR_FAIL_NULL_V(dpad_bindings, 0.0);
177
	return dpad_bindings->centerRegion;
178
}
179

180
void OpenXRDpadBindingModifier::set_wedge_angle(float p_wedge_angle) {
181
	ERR_FAIL_NULL(dpad_bindings);
182
	dpad_bindings->wedgeAngle = p_wedge_angle;
183
	emit_changed();
184
}
185

186
float OpenXRDpadBindingModifier::get_wedge_angle() const {
187
	ERR_FAIL_NULL_V(dpad_bindings, 0.0);
188
	return dpad_bindings->wedgeAngle;
189
}
190

191
void OpenXRDpadBindingModifier::set_wedge_angle_deg(float p_wedge_angle) {
192
	ERR_FAIL_NULL(dpad_bindings);
193
	dpad_bindings->wedgeAngle = Math::deg_to_rad(p_wedge_angle);
194
	emit_changed();
195
}
196

197
float OpenXRDpadBindingModifier::get_wedge_angle_deg() const {
198
	ERR_FAIL_NULL_V(dpad_bindings, 0.0);
199
	return Math::rad_to_deg(dpad_bindings->wedgeAngle);
200
}
201

202
void OpenXRDpadBindingModifier::set_is_sticky(bool p_sticky) {
203
	ERR_FAIL_NULL(dpad_bindings);
204
	dpad_bindings->isSticky = p_sticky;
205
	emit_changed();
206
}
207

208
bool OpenXRDpadBindingModifier::get_is_sticky() const {
209
	ERR_FAIL_NULL_V(dpad_bindings, false);
210
	return dpad_bindings->isSticky;
211
}
212

213
void OpenXRDpadBindingModifier::set_on_haptic(const Ref<OpenXRHapticBase> &p_haptic) {
214
	on_haptic = p_haptic;
215
	emit_changed();
216
}
217

218
Ref<OpenXRHapticBase> OpenXRDpadBindingModifier::get_on_haptic() const {
219
	return on_haptic;
220
}
221

222
void OpenXRDpadBindingModifier::set_off_haptic(const Ref<OpenXRHapticBase> &p_haptic) {
223
	off_haptic = p_haptic;
224
	emit_changed();
225
}
226

227
Ref<OpenXRHapticBase> OpenXRDpadBindingModifier::get_off_haptic() const {
228
	return off_haptic;
229
}
230

231
PackedByteArray OpenXRDpadBindingModifier::get_ip_modification() {
232
	ERR_FAIL_NULL_V(dpad_bindings, PackedByteArray());
233

234
	OpenXRAPI *openxr_api = OpenXRAPI::get_singleton();
235
	ERR_FAIL_NULL_V(openxr_api, PackedByteArray());
236

237
	OpenXRDPadBindingExtension *dpad_binding_ext = OpenXRDPadBindingExtension::get_singleton();
238
	if (!dpad_binding_ext || !dpad_binding_ext->is_available()) {
239
		// Extension not enabled!
240
		WARN_PRINT("DPad binding extension is not enabled or available.");
241
		return PackedByteArray();
242
	}
243

244
	dpad_bindings->binding = openxr_api->get_xr_path(input_path);
245
	ERR_FAIL_COND_V(dpad_bindings->binding == XR_NULL_PATH, PackedByteArray());
246

247
	// Get our action set
248
	ERR_FAIL_COND_V(action_set.is_null(), PackedByteArray());
249
	RID action_set_rid = openxr_api->find_action_set(action_set->get_name());
250
	ERR_FAIL_COND_V(!action_set_rid.is_valid(), PackedByteArray());
251
	dpad_bindings->actionSet = openxr_api->action_set_get_handle(action_set_rid);
252

253
	// These are set already:
254
	// - forceThreshold
255
	// - forceThresholdReleased
256
	// - centerRegion
257
	// - wedgeAngle
258
	// - isSticky
259

260
	if (on_haptic.is_valid()) {
261
		dpad_bindings->onHaptic = on_haptic->get_xr_structure();
262
	} else {
263
		dpad_bindings->onHaptic = nullptr;
264
	}
265

266
	if (off_haptic.is_valid()) {
267
		dpad_bindings->offHaptic = off_haptic->get_xr_structure();
268
	} else {
269
		dpad_bindings->offHaptic = nullptr;
270
	}
271

272
	return dpad_bindings_data;
273
}
274

275
Product

Resources

Company
