Class DPadInteraction
This OpenXRInteractionFeature enables the use of DPad feature in OpenXR.
Inherited Members
Namespace: UnityEngine.XR.OpenXR.Features.Interactions
Assembly: Unity.XR.OpenXR.dll
Syntax
public class DPadInteraction : OpenXRInteractionFeatureFields
centerRegionLeft
the radius in the input value space, of a logically circular region in the center of the input, in the range (0, 1).
Declaration
public float centerRegionLeftField Value
| Type | Description |
|---|---|
| float |
centerRegionRight
the radius in the input value space, of a logically circular region in the center of the input, in the range (0, 1).
Declaration
public float centerRegionRightField Value
| Type | Description |
|---|---|
| float |
extensionStrings
The OpenXR Extension strings. This is used by OpenXR to check if this extension is available or enabled.
Declaration
public string[] extensionStringsField 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.dpadinteraction"Field Value
| Type | Description |
|---|---|
| string |
forceThresholdLeft
a number in the half-open range (0, 1] representing the force value threshold at or above which ≥ a dpad input will transition from inactive to active.
Declaration
public float forceThresholdLeftField Value
| Type | Description |
|---|---|
| float |
forceThresholdReleaseLeft
a number in the half-open range (0, 1] representing the force value threshold strictly below which less than a dpad input will transition from active to inactive.
Declaration
public float forceThresholdReleaseLeftField Value
| Type | Description |
|---|---|
| float |
forceThresholdReleaseRight
a number in the half-open range (0, 1] representing the force value threshold strictly below which less than a dpad input will transition from active to inactive.
Declaration
public float forceThresholdReleaseRightField Value
| Type | Description |
|---|---|
| float |
forceThresholdRight
a number in the half-open range (0, 1] representing the force value threshold at or above which ≥ a dpad input will transition from inactive to active.
Declaration
public float forceThresholdRightField Value
| Type | Description |
|---|---|
| float |
isStickyLeft
indicates that the implementation will latch the first region that is activated and continue to indicate that the binding for that region is true until the user releases the input underlying the virtual dpad.
Declaration
public bool isStickyLeftField Value
| Type | Description |
|---|---|
| bool |
isStickyRight
indicates that the implementation will latch the first region that is activated and continue to indicate that the binding for that region is true until the user releases the input underlying the virtual dpad.
Declaration
public bool isStickyRightField Value
| Type | Description |
|---|---|
| bool |
profile
A unique string for dpad feature
Declaration
public const string profile = "/interaction_profiles/unity/dpad"Field Value
| Type | Description |
|---|---|
| string |
thumbstickDpadDown
Constant for a boolean interaction binding '.../thumbstick/dpad_down' OpenXR Input Binding.
Declaration
public const string thumbstickDpadDown = "/input/thumbstick/dpad_down"Field Value
| Type | Description |
|---|---|
| string |
thumbstickDpadLeft
Constant for a boolean interaction binding '.../thumbstick/dpad_left' OpenXR Input Binding.
Declaration
public const string thumbstickDpadLeft = "/input/thumbstick/dpad_left"Field Value
| Type | Description |
|---|---|
| string |
thumbstickDpadRight
Constant for a boolean interaction binding '.../thumbstick/dpad_right' OpenXR Input Binding.
Declaration
public const string thumbstickDpadRight = "/input/thumbstick/dpad_right"Field Value
| Type | Description |
|---|---|
| string |
thumbstickDpadUp
Constant for a boolean interaction binding '.../thumbstick/dpad_up' OpenXR Input Binding.
Declaration
public const string thumbstickDpadUp = "/input/thumbstick/dpad_up"Field Value
| Type | Description |
|---|---|
| string |
trackpadDpadCenter
Constant for a boolean interaction binding '.../trackpad/dpad_center' OpenXR Input Binding.
Declaration
public const string trackpadDpadCenter = "/input/trackpad/dpad_center"Field Value
| Type | Description |
|---|---|
| string |
trackpadDpadDown
Constant for a boolean interaction binding '.../trackpad/dpad_down' OpenXR Input Binding.
Declaration
public const string trackpadDpadDown = "/input/trackpad/dpad_down"Field Value
| Type | Description |
|---|---|
| string |
trackpadDpadLeft
Constant for a boolean interaction binding '.../trackpad/dpad_left' OpenXR Input Binding.
Declaration
public const string trackpadDpadLeft = "/input/trackpad/dpad_left"Field Value
| Type | Description |
|---|---|
| string |
trackpadDpadRight
Constant for a boolean interaction binding '.../trackpad/dpad_right' OpenXR Input Binding.
Declaration
public const string trackpadDpadRight = "/input/trackpad/dpad_right"Field Value
| Type | Description |
|---|---|
| string |
trackpadDpadUp
Constant for a boolean interaction binding '.../trackpad/dpad_up' OpenXR Input Binding.
Declaration
public const string trackpadDpadUp = "/input/trackpad/dpad_up"Field Value
| Type | Description |
|---|---|
| string |
wedgeAngleLeft
indicates the angle in radians of each direction region and is a value in the half-open range (0, π].
Declaration
public float wedgeAngleLeftField Value
| Type | Description |
|---|---|
| float |
wedgeAngleRight
indicates the angle in radians of each direction region and is a value in the half-open range [0, π].
Declaration
public float wedgeAngleRightField Value
| Type | Description |
|---|---|
| float |
Methods
GetDeviceLayoutName()
Return device layout string for registering Dpad in InputSystem.
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.
Declaration
protected override bool OnInstanceCreate(ulong instance)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | instance |
Returns
| Type | Description |
|---|---|
| bool | Always returns true, as this is intended to be overridden. |
Overrides
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 DPadInteraction.DPad layout with the Input System.
Declaration
protected override void RegisterDeviceLayout()Overrides
UnregisterDeviceLayout()
Removes the DPadInteraction.DPad layout with the Input System.
Declaration
protected override void UnregisterDeviceLayout()