From 9b7b9de0e5e8bfe49ad9e02474eb9ddd5d7dacd5 Mon Sep 17 00:00:00 2001 From: Bastiaan Olij Date: Thu, 17 Mar 2022 10:24:47 +1100 Subject: Add action map editor for OpenXR --- modules/openxr/doc_classes/OpenXRActionMap.xml | 42 ++++++++++++++++++++++ modules/openxr/doc_classes/OpenXRActionSet.xml | 9 +++-- modules/openxr/doc_classes/OpenXRIPBinding.xml | 33 +++++++++++++++-- .../doc_classes/OpenXRInteractionProfile.xml | 15 ++++++++ 4 files changed, 95 insertions(+), 4 deletions(-) (limited to 'modules/openxr/doc_classes') diff --git a/modules/openxr/doc_classes/OpenXRActionMap.xml b/modules/openxr/doc_classes/OpenXRActionMap.xml index 4dd2b83ca7..a29d10be41 100644 --- a/modules/openxr/doc_classes/OpenXRActionMap.xml +++ b/modules/openxr/doc_classes/OpenXRActionMap.xml @@ -31,6 +31,46 @@ 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. + + + + + + Retrieve the number of actions sets in our action map. + + + + + + + Get the interaction profile at this index. + + + + + + Retrieve the number of interaction profiles in our action map. + + @@ -48,8 +88,10 @@ + Collection of [OpenXRActionSet]s that are part of this action map. + Collection of [OpenXRInteractionProfile]s that are part of this action map. diff --git a/modules/openxr/doc_classes/OpenXRActionSet.xml b/modules/openxr/doc_classes/OpenXRActionSet.xml index 5a87de463e..55cc0aaad4 100644 --- a/modules/openxr/doc_classes/OpenXRActionSet.xml +++ b/modules/openxr/doc_classes/OpenXRActionSet.xml @@ -5,8 +5,7 @@ Action sets in OpenXR define a collection of actions that can be activated in unison. This allows games to easily change between different states that require different inputs or need to reinterpret inputs. For instance we could have an action set that is active when a menu is open, an action set that is active when the player is freely walking around and an action set that is active when the player is controlling a vehicle. - Action sets can contain the same actions, or actions with the same name, if such action sets are active at the same time the action set with the highest priority defines which binding is active. - Note that the name of the resource is used to identify the action set within OpenXR. + Action sets can contain the same action with the same name, if such action sets are active at the same time the action set with the highest priority defines which binding is active. @@ -18,6 +17,12 @@ Add an action to this action set. + + + + Retrieve the number of actions in our action set. + + diff --git a/modules/openxr/doc_classes/OpenXRIPBinding.xml b/modules/openxr/doc_classes/OpenXRIPBinding.xml index 3fdcde5eb5..9e1176874a 100644 --- a/modules/openxr/doc_classes/OpenXRIPBinding.xml +++ b/modules/openxr/doc_classes/OpenXRIPBinding.xml @@ -4,13 +4,42 @@ Defines a binding between an [OpenXRAction] and an XR input or output. - This binding resource binds an OpenXR action to inputs or outputs. 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 binding resource binds an [OpenXRAction] to inputs or outputs. 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". + + + + + + Add an input/output path to this binding. + + + + + + Get the number of input/output paths in this binding. + + + + + + + Returns [code]true[/code] if this input/output path is part of this binding. + + + + + + + Removes this input/output path from this binding. + + + - Action that is bound to these paths. + [OpenXRAction] that is bound to these paths. Paths that define the inputs or outputs bound on the device. diff --git a/modules/openxr/doc_classes/OpenXRInteractionProfile.xml b/modules/openxr/doc_classes/OpenXRInteractionProfile.xml index a8629caae4..71c0db44ed 100644 --- a/modules/openxr/doc_classes/OpenXRInteractionProfile.xml +++ b/modules/openxr/doc_classes/OpenXRInteractionProfile.xml @@ -9,6 +9,21 @@ + + + + + + Retrieve the binding at this index. + + + + + + Get the number of bindings in this interaction profile. + + + Action bindings for this interaction profile. -- cgit v1.2.3