Class reference
OpenXRActionMap
Inherits Resource
Collection of OpenXRActionSet and OpenXRInteractionProfile resources for the OpenXR module.
Description
OpenXR uses an action system similar to Redots Input map system to bind inputs and outputs on various types of XR controllers to named actions. OpenXR specifies more detail on these inputs and outputs than Redot supports. Another important distinction is that OpenXR offers no control over these bindings. The bindings we register are suggestions, it is up to the XR runtime to offer users the ability to change these bindings. This allows the XR runtime to fill in the gaps if new hardware becomes available. The action map therefore needs to be loaded at startup and can't be changed afterwards. This resource is a container for the entire action map.
Properties
Array action_sets = []
Array action_sets = []Collection of OpenXRActionSets that are part of this action map.
Array interaction_profiles = []
Array interaction_profiles = []Collection of OpenXRInteractionProfiles that are part of this action map.
Methods
void add_action_set(OpenXRActionSet action_set)
OpenXRActionSet action_set)Add an action set.
void add_interaction_profile(OpenXRInteractionProfile interaction_profile)
OpenXRInteractionProfile interaction_profile)Add an interaction profile.
void create_default_action_sets()
Setup this action set with our default actions.
OpenXRActionSet find_action_set(String name) const
OpenXRActionSet find_action_set(String name) constRetrieve an action set by name.
OpenXRInteractionProfile find_interaction_profile(String name) const
OpenXRInteractionProfile find_interaction_profile(String name) constFind an interaction profile by its name (path).
OpenXRActionSet get_action_set(int idx) const
OpenXRActionSet get_action_set(int idx) constRetrieve the action set at this index.
int get_action_set_count() const
int get_action_set_count() constRetrieve the number of actions sets in our action map.
OpenXRInteractionProfile get_interaction_profile(int idx) const
OpenXRInteractionProfile get_interaction_profile(int idx) constGet the interaction profile at this index.
int get_interaction_profile_count() const
int get_interaction_profile_count() constRetrieve the number of interaction profiles in our action map.
void remove_action_set(OpenXRActionSet action_set)
OpenXRActionSet action_set)Remove an action set.
void remove_interaction_profile(OpenXRInteractionProfile interaction_profile)
OpenXRInteractionProfile interaction_profile)Remove an interaction profile.