Book a Demo!
CoCalc Logo Icon
StoreFeaturesDocsShareSupportNewsAboutPoliciesSign UpSign In
godotengine
GitHub Repository: godotengine/godot
 Path: blob/master/modules/openxr/extensions/openxr_htc_vive_tracker_extension.cpp
10278 views
1
/**************************************************************************/

2
/*  openxr_htc_vive_tracker_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_htc_vive_tracker_extension.h"

32


33
#include "../action_map/openxr_interaction_profile_metadata.h"

34


35
#include "core/string/print_string.h"

36


37
HashMap<String, bool *> OpenXRHTCViveTrackerExtension::get_requested_extensions() {

38
	HashMap<String, bool *> request_extensions;

39


40
	request_extensions[XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME] = &available;

41


42
	return request_extensions;

43
}

44


45
PackedStringArray OpenXRHTCViveTrackerExtension::get_suggested_tracker_names() {

46
	PackedStringArray arr = {

47
		"/user/vive_tracker_htcx/role/handheld_object",

48
		"/user/vive_tracker_htcx/role/left_foot",

49
		"/user/vive_tracker_htcx/role/right_foot",

50
		"/user/vive_tracker_htcx/role/left_shoulder",

51
		"/user/vive_tracker_htcx/role/right_shoulder",

52
		"/user/vive_tracker_htcx/role/left_elbow",

53
		"/user/vive_tracker_htcx/role/right_elbow",

54
		"/user/vive_tracker_htcx/role/left_knee",

55
		"/user/vive_tracker_htcx/role/right_knee",

56
		"/user/vive_tracker_htcx/role/waist",

57
		"/user/vive_tracker_htcx/role/chest",

58
		"/user/vive_tracker_htcx/role/camera",

59
		"/user/vive_tracker_htcx/role/keyboard",

60
		"/user/vive_tracker_htcx/role/left_wrist",

61
		"/user/vive_tracker_htcx/role/right_wrist",

62
		"/user/vive_tracker_htcx/role/left_ankle",

63
		"/user/vive_tracker_htcx/role/right_ankle",

64
	};

65
	return arr;

66
}

67


68
bool OpenXRHTCViveTrackerExtension::is_available() {

69
	return available;

70
}

71


72
void OpenXRHTCViveTrackerExtension::on_register_metadata() {

73
	OpenXRInteractionProfileMetadata *openxr_metadata = OpenXRInteractionProfileMetadata::get_singleton();

74
	ERR_FAIL_NULL(openxr_metadata);

75


76
	// register_top_level_path("Handheld object tracker", "/user/vive_tracker_htcx/role/handheld_object", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

77
	openxr_metadata->register_top_level_path("Left foot tracker", "/user/vive_tracker_htcx/role/left_foot", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

78
	openxr_metadata->register_top_level_path("Right foot tracker", "/user/vive_tracker_htcx/role/right_foot", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

79
	openxr_metadata->register_top_level_path("Left shoulder tracker", "/user/vive_tracker_htcx/role/left_shoulder", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

80
	openxr_metadata->register_top_level_path("Right shoulder tracker", "/user/vive_tracker_htcx/role/right_shoulder", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

81
	openxr_metadata->register_top_level_path("Left elbow tracker", "/user/vive_tracker_htcx/role/left_elbow", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

82
	openxr_metadata->register_top_level_path("Right elbow tracker", "/user/vive_tracker_htcx/role/right_elbow", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

83
	openxr_metadata->register_top_level_path("Left knee tracker", "/user/vive_tracker_htcx/role/left_knee", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

84
	openxr_metadata->register_top_level_path("Right knee tracker", "/user/vive_tracker_htcx/role/right_knee", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

85
	openxr_metadata->register_top_level_path("Waist tracker", "/user/vive_tracker_htcx/role/waist", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

86
	openxr_metadata->register_top_level_path("Chest tracker", "/user/vive_tracker_htcx/role/chest", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

87
	openxr_metadata->register_top_level_path("Camera tracker", "/user/vive_tracker_htcx/role/camera", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

88
	openxr_metadata->register_top_level_path("Keyboard tracker", "/user/vive_tracker_htcx/role/keyboard", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

89
	openxr_metadata->register_top_level_path("Left wrist tracker", "/user/vive_tracker_htcx/role/left_wrist", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

90
	openxr_metadata->register_top_level_path("Right wrist tracker", "/user/vive_tracker_htcx/role/right_wrist", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

91
	openxr_metadata->register_top_level_path("Left ankle tracker", "/user/vive_tracker_htcx/role/left_ankle", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

92
	openxr_metadata->register_top_level_path("Right ankle tracker", "/user/vive_tracker_htcx/role/right_ankle", XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

93


94
	{ // HTC Vive tracker

95
		// Interestingly enough trackers don't have buttons or inputs, yet these are defined in the spec.

96
		// I think this can be supported through attachments on the trackers.

97
		const String profile_path = "/interaction_profiles/htc/vive_tracker_htcx";

98
		openxr_metadata->register_interaction_profile("HTC Vive tracker", profile_path, XR_HTCX_VIVE_TRACKER_INTERACTION_EXTENSION_NAME);

99
		for (const String user_path : {

100
					 /* "/user/vive_tracker_htcx/role/handheld_object", */

101
					 "/user/vive_tracker_htcx/role/left_foot",

102
					 "/user/vive_tracker_htcx/role/right_foot",

103
					 "/user/vive_tracker_htcx/role/left_shoulder",

104
					 "/user/vive_tracker_htcx/role/right_shoulder",

105
					 "/user/vive_tracker_htcx/role/left_elbow",

106
					 "/user/vive_tracker_htcx/role/right_elbow",

107
					 "/user/vive_tracker_htcx/role/left_knee",

108
					 "/user/vive_tracker_htcx/role/right_knee",

109
					 "/user/vive_tracker_htcx/role/waist",

110
					 "/user/vive_tracker_htcx/role/chest",

111
					 "/user/vive_tracker_htcx/role/camera",

112
					 "/user/vive_tracker_htcx/role/keyboard",

113
					 "/user/vive_tracker_htcx/role/left_wrist",

114
					 "/user/vive_tracker_htcx/role/right_wrist",

115
					 "/user/vive_tracker_htcx/role/left_ankle",

116
					 "/user/vive_tracker_htcx/role/right_ankle",

117
			 }) {

118
			openxr_metadata->register_io_path(profile_path, "Grip pose", user_path, user_path + "/input/grip/pose", "", OpenXRAction::OPENXR_ACTION_POSE);

119


120
			openxr_metadata->register_io_path(profile_path, "Menu click", user_path, user_path + "/input/menu/click", "", OpenXRAction::OPENXR_ACTION_BOOL);

121
			openxr_metadata->register_io_path(profile_path, "Trigger", user_path, user_path + "/input/trigger/value", "", OpenXRAction::OPENXR_ACTION_FLOAT);

122
			openxr_metadata->register_io_path(profile_path, "Trigger click", user_path, user_path + "/input/trigger/click", "", OpenXRAction::OPENXR_ACTION_BOOL);

123
			openxr_metadata->register_io_path(profile_path, "Squeeze click", user_path, user_path + "/input/squeeze/click", "", OpenXRAction::OPENXR_ACTION_BOOL);

124


125
			openxr_metadata->register_io_path(profile_path, "Trackpad", user_path, user_path + "/input/trackpad", "", OpenXRAction::OPENXR_ACTION_VECTOR2);

126
			openxr_metadata->register_io_path(profile_path, "Trackpad click", user_path, user_path + "/input/trackpad/click", "", OpenXRAction::OPENXR_ACTION_BOOL);

127
			openxr_metadata->register_io_path(profile_path, "Trackpad touch", user_path, user_path + "/input/trackpad/touch", "", OpenXRAction::OPENXR_ACTION_BOOL);

128
			openxr_metadata->register_io_path(profile_path, "Trackpad Dpad Up", user_path, user_path + "/input/trackpad/dpad_up", "XR_EXT_dpad_binding", OpenXRAction::OPENXR_ACTION_BOOL);

129
			openxr_metadata->register_io_path(profile_path, "Trackpad Dpad Down", user_path, user_path + "/input/trackpad/dpad_down", "XR_EXT_dpad_binding", OpenXRAction::OPENXR_ACTION_BOOL);

130
			openxr_metadata->register_io_path(profile_path, "Trackpad Dpad Left", user_path, user_path + "/input/trackpad/dpad_left", "XR_EXT_dpad_binding", OpenXRAction::OPENXR_ACTION_BOOL);

131
			openxr_metadata->register_io_path(profile_path, "Trackpad Dpad Right", user_path, user_path + "/input/trackpad/dpad_right", "XR_EXT_dpad_binding", OpenXRAction::OPENXR_ACTION_BOOL);

132
			openxr_metadata->register_io_path(profile_path, "Trackpad Dpad Center", user_path, user_path + "/input/trackpad/dpad_center", "XR_EXT_dpad_binding", OpenXRAction::OPENXR_ACTION_BOOL);

133


134
			openxr_metadata->register_io_path(profile_path, "Haptic output", user_path, user_path + "/output/haptic", "", OpenXRAction::OPENXR_ACTION_HAPTIC);

135
		}

136
	}

137
}

138


139
bool OpenXRHTCViveTrackerExtension::on_event_polled(const XrEventDataBuffer &event) {

140
	switch (event.type) {

141
		case XR_TYPE_EVENT_DATA_VIVE_TRACKER_CONNECTED_HTCX: {

142
			// Investigate if we need to do more here

143
			print_verbose("OpenXR EVENT: VIVE tracker connected");

144


145
			return true;

146
		} break;

147
		default: {

148
			return false;

149
		} break;

150
	}

151
}

152


153