Class VIVEFocus3Profile

This UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature enables the use of HTC VIVE Focus 3 interaction profiles in OpenXR.

Inheritance

object

Object

ScriptableObject

OpenXRFeature

OpenXRInteractionFeature

VIVEFocus3Profile

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VIVE.OpenXR

Assembly: VIVE.OpenXR.dll

Syntax

public class VIVEFocus3Profile : OpenXRInteractionFeature

Fields

aim

Constant for a hand point 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

buttonA

Constant for a boolean interaction binding '.../input/a/click' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs. This binding is only available for the UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.UserPaths.rightHand user path.

Declaration

public const string buttonA = "/input/a/click"

Field Value

Type	Description
string

buttonB

Constant for a boolean interaction binding '..."/input/b/click' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs. This binding is only available for the UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.UserPaths.rightHand user path.

Declaration

public const string buttonB = "/input/b/click"

Field Value

Type	Description
string

buttonX

Constant for a boolean interaction binding '.../input/x/click' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs. This binding is only available for the UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.UserPaths.leftHand user path.

Declaration

public const string buttonX = "/input/x/click"

Field Value

Type	Description
string

buttonY

Constant for a boolean interaction binding '.../input/y/click' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs. This binding is only available for the UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.UserPaths.leftHand user path.

Declaration

public const string buttonY = "/input/y/click"

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 = "vive.openxr.feature.focus3controller"

Field Value

Type	Description
string

grip

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

Declaration

public const string grip = "/input/squeeze/value"

Field Value

Type	Description
string

gripPose

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

Declaration

public const string gripPose = "/input/grip/pose"

Field Value

Type	Description
string

gripPress

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

Declaration

public const string gripPress = "/input/squeeze/click"

Field Value

Type	Description
string

gripTouch

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

Declaration

public const string gripTouch = "/input/squeeze/touch"

Field Value

Type	Description
string

haptic

Constant for a haptic interaction binding '.../output/haptic' OpenXR Input Binding. Used by input subsystem to bind actions to physical outputs.

Declaration

public const string haptic = "/output/haptic"

Field Value

Type	Description
string

kOpenxrExtensionString

Declaration

public const string kOpenxrExtensionString = "XR_HTC_vive_focus3_controller_interaction"

Field Value

Type	Description
string

menu

Constant for a boolean interaction binding '.../input/menu/click' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs. This binding is only available for the UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.UserPaths.leftHand user path.

Declaration

public const string menu = "/input/menu/click"

Field Value

Type	Description
string

profile

The interaction profile string used to reference the Interaction Profile.

Declaration

public const string profile = "/interaction_profiles/htc/vive_focus3_controller"

Field Value

Type	Description
string

system

Constant for a boolean interaction binding '.../input/system/click' OpenXR Input Binding. Used by input subsystem to bind actions to physical inputs. This binding is only available for the UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.UserPaths.rightHand user path.

Declaration

public const string system = "/input/system/click"

Field Value

Type	Description
string

thumbrest

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

Declaration

public const string thumbrest = "/input/thumbrest/touch"

Field Value

Type	Description
string

thumbstick

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

Declaration

public const string thumbstick = "/input/thumbstick"

Field Value

Type	Description
string

thumbstickClick

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

Declaration

public const string thumbstickClick = "/input/thumbstick/click"

Field Value

Type	Description
string

thumbstickTouch

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

Declaration

public const string thumbstickTouch = "/input/thumbstick/touch"

Field Value

Type	Description
string

trigger

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

Declaration

public const string trigger = "/input/trigger/value"

Field Value

Type	Description
string

triggerClick

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

Declaration

public const string triggerClick = "/input/trigger/click"

Field Value

Type	Description
string

triggerTouch

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

Declaration

public const string triggerTouch = "/input/trigger/touch"

Field Value

Type	Description
string

Methods

OnInstanceCreate(ulong)

Called when xrCreateInstance is done.

Declaration

protected override bool OnInstanceCreate(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance	The created instance.

Returns

Type	Description
bool	True for valid XrInstance

Overrides

OpenXRInteractionFeature.OnInstanceCreate(ulong)

OnInstanceDestroy(ulong)

Called when xrDestroyInstance is done.

Declaration

protected override void OnInstanceDestroy(ulong xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance	The instance to destroy.

Overrides

OpenXRFeature.OnInstanceDestroy(ulong)

OnSessionCreate(ulong)

Called when xrCreateSession is done.

Declaration

protected override void OnSessionCreate(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession	The created session ID.

Overrides

OpenXRFeature.OnSessionCreate(ulong)

OnSessionDestroy(ulong)

Called when xrDestroySession is done.

Declaration

protected override void OnSessionDestroy(ulong xrSession)

Parameters

Type	Name	Description
ulong	xrSession	The session ID to destroy.

Overrides

OpenXRFeature.OnSessionDestroy(ulong)

RegisterActionMapsWithRuntime()

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

Declaration

protected override void RegisterActionMapsWithRuntime()

Overrides

UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.RegisterActionMapsWithRuntime()

RegisterDeviceLayout()

Registers the VIVEFocus3Profile.VIVEFocus3Controller layout with the Input System.

Declaration

protected override void RegisterDeviceLayout()

Overrides

UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.RegisterDeviceLayout()

UnregisterDeviceLayout()

Removes the VIVEFocus3Profile.VIVEFocus3Controller layout from the Input System.

Declaration

protected override void UnregisterDeviceLayout()

Overrides

UnityEngine.XR.OpenXR.Features.OpenXRInteractionFeature.UnregisterDeviceLayout()