Class reference
OpenXRIPBinding
Inherits Resource
Defines a binding between an OpenXRAction and an XR input or output.
Description
This binding resource binds an OpenXRAction to an input or output. As most controllers have left hand and right versions that are handled by the same interaction profile we can specify multiple bindings. For instance an action "Fire" could be bound to both "/user/hand/left/input/trigger" and "/user/hand/right/input/trigger". This would require two binding entries.
Properties
OpenXRAction action
OpenXRAction actionOpenXRAction that is bound to binding_path.
Array binding_modifiers = []
Array binding_modifiers = []Binding modifiers for this binding.
String binding_path = ""
String binding_path = ""Binding path that defines the input or output bound to action. Note: Binding paths are suggestions, an XR runtime may choose to bind the action to a different input or output emulating this input or output.
PackedStringArray paths
PackedStringArray pathsUse binding_path instead.
Paths that define the inputs or outputs bound on the device.
Methods
void add_path(String path)
String path)Binding is for a single path.
Add an input/output path to this binding.
OpenXRActionBindingModifier get_binding_modifier(int index) const
OpenXRActionBindingModifier get_binding_modifier(int index) constGet the OpenXRBindingModifier at this index.
int get_binding_modifier_count() const
int get_binding_modifier_count() constGet the number of binding modifiers for this binding.
int get_path_count() const
int get_path_count() constBinding is for a single path.
Get the number of input/output paths in this binding.
bool has_path(String path) const
bool has_path(String path) constBinding is for a single path.
Returns true if this input/output path is part of this binding.
void remove_path(String path)
String path)Binding is for a single path.
Removes this input/output path from this binding.