Class PalmPoseInteraction
This OpenXRInteractionFeature enables the use of Palm Pose feature in OpenXR.
Inheritance
Inherited Members
Namespace: UnityEngine.XR.OpenXR.Features.Interactions
Assembly: Unity.XR.OpenXR.dll
Syntax
public class PalmPoseInteraction : OpenXRInteractionFeatureFields
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_palm_pose"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.palmpose"Field Value
| Type | Description |
|---|---|
| string |
gripSurfacePose
Constant for a pose interaction binding '.../grip_surface/pose' OpenXR Input Binding, which is supported in OpenXR 1.1 specification
Declaration
public const string gripSurfacePose = "/input/grip_surface/pose"Field Value
| Type | Description |
|---|---|
| string |
palmPose
Constant for a pose interaction binding '.../palm_ext/pose' OpenXR Input Binding.
Declaration
public const string palmPose = "/input/palm_ext/pose"Field Value
| Type | Description |
|---|---|
| string |
profile
A unique string for palm pose feature
Declaration
public const string profile = "/interaction_profiles/ext/palmpose"Field Value
| Type | Description |
|---|---|
| string |
Methods
GetDeviceLayoutName()
Return device layout string that used for registering device for the Input System.
Declaration
protected override string GetDeviceLayoutName()Returns
| Type | Description |
|---|---|
| string | Device layout string. |
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 PalmPoseInteraction.PalmPose layout with the Input System.
Declaration
protected override void RegisterDeviceLayout()Overrides
UnregisterDeviceLayout()
Removes the PalmPoseInteraction.PalmPose layout with the Input System.
Declaration
protected override void UnregisterDeviceLayout()