Class HandCommonPosesInteraction

This OpenXRInteractionFeature enables the use of hand common poses profiles in OpenXR.

Inheritance
object
Object
ScriptableObject
OpenXRFeature
OpenXRInteractionFeature
HandCommonPosesInteraction
Inherited Members
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.XR.OpenXR.Features.Interactions
Assembly: Unity.XR.OpenXR.dll
Syntax
public class HandCommonPosesInteraction : OpenXRInteractionFeature

Fields

aim

Constant for a pose interaction binding '.../input/aim/pose' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs.

Declaration
public const string aim = "/input/aim/pose"
Field Value
Type Description
string

extensionString

The OpenXR Extension string. This is used by OpenXR to check if this extension is available or enabled.

Declaration
public const string extensionString = "XR_EXT_hand_interaction"
Field Value
Type Description
string

featureId

The feature id string. This is used to give the feature a well known id for reference.

Declaration
public const string featureId = "com.unity.openxr.feature.input.handinteractionposes"
Field Value
Type Description
string

grip

Constant for a pose interaction binding '.../input/grip/pose' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs.

Declaration
public const string grip = "/input/grip/pose"
Field Value
Type Description
string

pinch

Constant for a pose interaction binding '.../input/pinch_ext/pose' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs.

Declaration
public const string pinch = "/input/pinch_ext/pose"
Field Value
Type Description
string

poke

Constant for a pose interaction binding '.../input/poke_ext/pose' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs.

Declaration
public const string poke = "/input/poke_ext/pose"
Field Value
Type Description
string

profile

The interaction profile string used to reference Hand Common Poses feature.

Declaration
public const string profile = "/interaction_profiles/unity/hand_interaction_poses"
Field Value
Type Description
string

Methods

GetDeviceLayoutName()

Return device layout string that used to register device in InputSystem.

Declaration
protected override string GetDeviceLayoutName()
Returns
Type Description
string

Device layout string.
Overrides

GetInteractionProfileType()

Return Interaction profile type. Hand common poses profile is Device type.

Declaration
protected override OpenXRInteractionFeature.InteractionProfileType GetInteractionProfileType()
Returns
Type Description
OpenXRInteractionFeature.InteractionProfileType

Interaction profile type.
Overrides

GetValidationChecks(List<ValidationRule>, BuildTargetGroup)

Allows a feature to add to a list of validation rules which your feature will evaluate at build time. Details of the validation results can be found in OpenXRProjectValidation.

Declaration
protected override void GetValidationChecks(List<OpenXRFeature.ValidationRule> results, BuildTargetGroup target)
Parameters
Type Name Description
List<OpenXRFeature.ValidationRule> results
BuildTargetGroup target
Overrides

OnInstanceCreate(ulong)

Called after xrCreateInstance. Override this method to validate that any necessary OpenXR extensions were successfully enabled (OpenXRRuntime.IsExtensionEnabled) and that any required system properties are supported. If this method returns false, the feature's enabled property is set to false.

Declaration
protected override bool OnInstanceCreate(ulong instance)
Parameters
Type Name Description
ulong instance
Returns
Type Description
bool

true if this feature successfully initialized. Otherwise, false.
Overrides
Remarks

If this feature is a required feature of an enabled feature set, returning false here causes the OpenXRLoader to fail, and XR Plug-in Management will fall back to another loader if enabled.

See Also

RegisterActionMapsWithRuntime()

Register action maps for this device with the OpenXR Runtime. Called at runtime before Start.

Declaration
protected override void RegisterActionMapsWithRuntime()
Overrides

RegisterDeviceLayout()

Registers the HandCommonPosesInteraction.HandInteractionPoses layout with the Input System.

Declaration
protected override void RegisterDeviceLayout()
Overrides

UnregisterDeviceLayout()

Removes the HandCommonPosesInteraction.HandInteractionPoses layout with the Input System.

Declaration
protected override void UnregisterDeviceLayout()
Overrides