Class OpenXRInteractionFeature

A Unity OpenXR Interaction feature. This class can be inherited from to add a custom action mapping for OpenXR.

Inheritance

object

Object

ScriptableObject

OpenXRFeature

OpenXRInteractionFeature

DPadInteraction

EyeGazeInteraction

HPReverbG2ControllerProfile

HTCViveControllerProfile

HandCommonPosesInteraction

HandInteractionProfile

KHRSimpleControllerProfile

MetaQuestTouchProControllerProfile

MicrosoftHandInteraction

MicrosoftMotionControllerProfile

OculusTouchControllerProfile

PalmPoseInteraction

ValveIndexControllerProfile

Inherited Members

OpenXRFeature.enabled

OpenXRFeature.xrGetInstanceProcAddr

OpenXRFeature.HookGetInstanceProcAddr(IntPtr)

OpenXRFeature.OnSubsystemCreate()

OpenXRFeature.OnSubsystemStart()

OpenXRFeature.OnSubsystemStop()

OpenXRFeature.OnSubsystemDestroy()

OpenXRFeature.OnSystemChange(ulong)

OpenXRFeature.OnSessionCreate(ulong)

OpenXRFeature.OnAppSpaceChange(ulong)

OpenXRFeature.OnSessionStateChange(int, int)

OpenXRFeature.OnSessionBegin(ulong)

OpenXRFeature.OnSessionEnd(ulong)

OpenXRFeature.OnSessionExiting(ulong)

OpenXRFeature.OnSessionDestroy(ulong)

OpenXRFeature.OnInstanceDestroy(ulong)

OpenXRFeature.OnSessionLossPending(ulong)

OpenXRFeature.OnInstanceLossPending(ulong)

OpenXRFeature.OnFormFactorChange(int)

OpenXRFeature.OnViewConfigurationTypeChange(int)

OpenXRFeature.OnEnvironmentBlendModeChange(XrEnvironmentBlendMode)

OpenXRFeature.PathToString(ulong)

OpenXRFeature.StringToPath(string)

OpenXRFeature.GetCurrentInteractionProfile(ulong)

OpenXRFeature.GetCurrentInteractionProfile(string)

OpenXRFeature.GetCurrentAppSpace()

OpenXRFeature.GetViewConfigurationTypeForRenderPass(int)

OpenXRFeature.SetEnvironmentBlendMode(XrEnvironmentBlendMode)

OpenXRFeature.GetEnvironmentBlendMode()

OpenXRFeature.GetValidationChecks(List<OpenXRFeature.ValidationRule>, BuildTargetGroup)

OpenXRFeature.CreateSubsystem<TDescriptor, TSubsystem>(List<TDescriptor>, string)

OpenXRFeature.StartSubsystem<T>()

OpenXRFeature.StopSubsystem<T>()

OpenXRFeature.DestroySubsystem<T>()

OpenXRFeature.OnEnable()

OpenXRFeature.OnDisable()

OpenXRFeature.Awake()

OpenXRFeature.GetAction(InputAction)

OpenXRFeature.RegisterStatsDescriptor(string, OpenXRFeature.StatFlags)

OpenXRFeature.SetStatAsFloat(ulong, float)

OpenXRFeature.SetStatAsUInt(ulong, uint)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.OpenXR.Features

Assembly: Unity.XR.OpenXR.dll

Syntax

[Serializable]
public abstract class OpenXRInteractionFeature : OpenXRFeature

Methods

AddActionMap(ActionMapConfig)

Add an action map to the Unity Input System.

This method must be called from within the RegisterActionMapsWithRuntime method.

Declaration

protected void AddActionMap(OpenXRInteractionFeature.ActionMapConfig map)

Parameters

Type	Name	Description
OpenXRInteractionFeature.ActionMapConfig	map	Action map to add

GetDeviceLayoutName()

Return device layout name string used for register layouts in inputSystem.

Declaration

protected virtual string GetDeviceLayoutName()

Returns

Type	Description
string	Device layout string.

GetInteractionProfileType()

Return interaction profile type. Default type is XRController. Override this if interactionProfile is not derived from XRController class.

Declaration

protected virtual OpenXRInteractionFeature.InteractionProfileType GetInteractionProfileType()

Returns

Type	Description
OpenXRInteractionFeature.InteractionProfileType	Interaction profile type.

OnEnabledChange()

Handle enabled state change

Declaration

protected override void OnEnabledChange()

Overrides

OpenXRFeature.OnEnabledChange()

OnInstanceCreate(ulong)

Called after xrCreateInstance.

Declaration

protected override bool OnInstanceCreate(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession

Returns

Type	Description
bool

Overrides

OpenXRFeature.OnInstanceCreate(ulong)

RegisterActionMapsWithRuntime()

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

Declaration

protected virtual void RegisterActionMapsWithRuntime()

RegisterDeviceLayout()

Register a device layout with the Unity Input System. Called whenever this interaction profile is enabled in the Editor.

Declaration

protected virtual void RegisterDeviceLayout()

UnregisterDeviceLayout()

Remove a device layout from the Unity Input System. Called whenever this interaction profile is disabled in the Editor.

Declaration

protected virtual void UnregisterDeviceLayout()