1/**************************************************************************/
2/* openxr_action_map.h */
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#ifndef OPENXR_ACTION_MAP_H
32#define OPENXR_ACTION_MAP_H
33
34#include "openxr_action.h"
35#include "openxr_action_set.h"
36#include "openxr_interaction_profile.h"
37
38#include "core/io/resource.h"
39
40class OpenXRActionMap : public Resource {
41 GDCLASS(OpenXRActionMap, Resource);
42
43private:
44 Array action_sets;
45 Array interaction_profiles;
46
47protected:
48 static void _bind_methods();
49
50public:
51 void set_action_sets(Array p_action_sets); // Set our actions sets by providing an array with action sets (for loading from resource)
52 Array get_action_sets() const; // Get our action sets as an array (for saving to resource)
53
54 int get_action_set_count() const; // Retrieve the number of action sets we have
55 Ref<OpenXRActionSet> find_action_set(String p_name) const; // Find an action set by name
56 Ref<OpenXRActionSet> get_action_set(int p_idx) const; // Retrieve an action set by index
57 void add_action_set(Ref<OpenXRActionSet> p_action_set); // Add an action set to our action map
58 void remove_action_set(Ref<OpenXRActionSet> p_action_set); // Remove an action set from our action map
59
60 void set_interaction_profiles(Array p_interaction_profiles); // Set our interaction profiles by providing an array (for loading from resource)
61 Array get_interaction_profiles() const; // Get our interaction profiles as an array (for saving to resource)
62
63 int get_interaction_profile_count() const; // Retrieve the number of interaction profiles we have
64 Ref<OpenXRInteractionProfile> find_interaction_profile(String p_path) const; // Find an interaction profile by path
65 Ref<OpenXRInteractionProfile> get_interaction_profile(int p_idx) const; // Retrieve an interaction profile by index
66 void add_interaction_profile(Ref<OpenXRInteractionProfile> p_interaction_profile); // Add an interaction profile to our action map
67 void remove_interaction_profile(Ref<OpenXRInteractionProfile> p_interaction_profile); // remove an interaction profile from our action map
68
69 void create_default_action_sets(); // Create our default action set for runtime
70 void create_editor_action_sets(); // Create our action set for the editor
71
72 // Helper functions for editor
73 Ref<OpenXRAction> get_action(const String p_path) const; // Retrieve an action using <action name>/<action> as our parameter
74 void remove_action(const String p_path, bool p_remove_interaction_profiles = false); // Remove action from action set, also removes it from interaction profiles
75 PackedStringArray get_top_level_paths(const Ref<OpenXRAction> p_action); // Determines the top level paths based on where an action is bound in interaction profiles
76
77 // TODO add validation to display in the interface that checks if we have action sets with the same name or if we have interaction profiles for the same path
78
79 ~OpenXRActionMap();
80};
81
82#endif // OPENXR_ACTION_MAP_H
83