OpenXRActionMap

Inherits: Resource < RefCounted < Object

Collection of OpenXRActionSet and OpenXRInteractionProfile resources for the OpenXR module.

Description

OpenXR uses an action system similar to Godots 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 Godot 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

interaction_profiles

[]

Methods

void

add_action_set ( OpenXRActionSet action_set )

void

add_interaction_profile ( OpenXRInteractionProfile interaction_profile )

void

create_default_action_sets ( )

OpenXRActionSet

find_action_set ( String name ) const

OpenXRInteractionProfile

find_interaction_profile ( String name ) const

OpenXRActionSet

get_action_set ( int idx ) const

int

get_action_set_count ( ) const

OpenXRInteractionProfile

get_interaction_profile ( int idx ) const

int

get_interaction_profile_count ( ) const

void

remove_action_set ( OpenXRActionSet action_set )

void

remove_interaction_profile ( OpenXRInteractionProfile interaction_profile )

Property Descriptions

Default

[]

Setter

set_action_sets(value)

Getter

get_action_sets()

Collection of OpenXRActionSets that are part of this action map.


  • Array interaction_profiles

Default

[]

Setter

set_interaction_profiles(value)

Getter

get_interaction_profiles()

Collection of OpenXRInteractionProfiles that are part of this action map.

Method Descriptions

Add an action set.


Add an interaction profile.


  • void create_default_action_sets ( )

Setup this action set with our default actions.


Retrieve an action set by name.


Find an interaction profile by its name (path).


Retrieve the action set at this index.


  • int get_action_set_count ( ) const

Retrieve the number of actions sets in our action map.


Get the interaction profile at this index.


  • int get_interaction_profile_count ( ) const

Retrieve the number of interaction profiles in our action map.


Remove an action set.


Remove an interaction profile.