Class HandInteractionProfile

This OpenXRInteractionFeature enables the use of New Hand interaction profiles in OpenXR.

Inheritance
object
OpenXRFeature
OpenXRInteractionFeature
HandInteractionProfile
Inherited Members
Namespace: UnityEngine.XR.OpenXR.Features.Interactions
Assembly: Unity.XR.OpenXR.dll
Syntax
public class HandInteractionProfile : 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
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
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
Field Value
Type Description
string

graspReady

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

Declaration
public const string graspReady
Field Value
Type Description
string

graspValue

Constant for a float or boolean interaction binding '.../input/grasp_ext/value' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs.

Declaration
public const string graspValue
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
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
Field Value
Type Description
string

pinchReady

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

Declaration
public const string pinchReady
Field Value
Type Description
string

pinchValue

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

Declaration
public const string pinchValue
Field Value
Type Description
string

pointerActivateReady

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

Declaration
public const string pointerActivateReady
Field Value
Type Description
string

pointerActivateValue

Constant for a float or boolean interaction binding '.../input/aim_activate_ext/value' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs.

Declaration
public const string pointerActivateValue
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
Field Value
Type Description
string

profile

The interaction profile string used to reference Hand Interaction Profile.

Declaration
public const string profile
Field Value
Type Description
string

Methods

GetDeviceLayoutName()

Return device layout string that used for registering device in InputSystem.

Declaration
protected override string GetDeviceLayoutName()
Returns
Type Description
string

Device layout string.
Overrides

OnExtensionsReady(ulong)

Called when all extensions are ready. Some systems may require enumeration of optional extension availability at the OnSystemChange stage.

Override this method to validate that any necessary OpenXR extensions were successfully enabled (OpenXRRuntime.IsSystemExtensionEnabled) 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 OnExtensionsReady(ulong instance)
Parameters
Type Name Description
ulong instance
Returns
Type Description
bool

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

This cannot be used with loader-required features as required extensions must be available at OnInstanceCreate(ulong). Therefore, failures that return false will simply disable the feature, not the loader.

See Also

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 HandInteractionProfile.HandInteraction layout with the Input System.

Declaration
protected override void RegisterDeviceLayout()
Overrides

UnregisterDeviceLayout()

Removes the HandInteractionProfile.HandInteraction layout with the Input System.

Declaration
protected override void UnregisterDeviceLayout()
Overrides