Class ConformanceAutomationFeature
This OpenXRFeature implements XR_EXT_conformance_automation. See https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_conformance_automation
Inherited Members
Namespace: UnityEngine.XR.OpenXR.Features.ConformanceAutomation
Assembly: Unity.XR.OpenXR.Features.ConformanceAutomation.dll
Syntax
public class ConformanceAutomationFeature : OpenXRFeatureFields
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.conformance"Field Value
| Type | Description |
|---|---|
| string |
Methods
ConformanceAutomationSetActive(string, string, bool)
Drive the xrSetInputDeviceActiveEXT function of the XR_EXT_conformance_automation. See https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_conformance_automation
Declaration
public static bool ConformanceAutomationSetActive(string interactionProfile, string topLevelPath, bool isActive)Parameters
| Type | Name | Description |
|---|---|---|
| string | interactionProfile | An OpenXRPath that specifies the OpenXR Interaction Profile of the value to be changed (e.g. /interaction_profiles/khr/simple_controller). |
| string | topLevelPath | An OpenXRPath that specifies the OpenXR User Path of the value to be changed (e.g. /user/hand/left). |
| bool | isActive | A boolean that specifies the desired state of the target. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the state is set successfully, or false if there was an error. |
ConformanceAutomationSetBool(string, string, bool)
Drive the xrSetInputDeviceStateBoolEXT function of the XR_EXT_conformance_automation. See https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_conformance_automation
Declaration
public static bool ConformanceAutomationSetBool(string topLevelPath, string inputSourcePath, bool state)Parameters
| Type | Name | Description |
|---|---|---|
| string | topLevelPath | An OpenXRPath that specifies the OpenXR User Path of the value to be changed (e.g. /user/hand/left). |
| string | inputSourcePath | An OpenXRPath that specifies the full path of the input component whose state you wish to set (e.g. /user/hand/left/input/select/click). |
| bool | state | A boolean that specifies the desired state of the target. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the state is set successfully, or false if there was an error. |
ConformanceAutomationSetFloat(string, string, float)
Drive the xrSetInputDeviceStateFloatEXT function of the XR_EXT_conformance_automation. See https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_conformance_automation
Declaration
public static bool ConformanceAutomationSetFloat(string topLevelPath, string inputSourcePath, float state)Parameters
| Type | Name | Description |
|---|---|---|
| string | topLevelPath |
|
| string | inputSourcePath | An OpenXRPath that specifies the full path of the input component whose state you wish to set (e.g. /user/hand/left/input/select/click). |
| float | state | A float that specifies the desired state of the target. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the state is set successfully, or false if there was an error. |
ConformanceAutomationSetPose(string, string, Vector3, Quaternion)
Drive the xrSetInputDeviceLocationEXT function of the XR_EXT_conformance_automation. See https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_conformance_automation
Declaration
public static bool ConformanceAutomationSetPose(string topLevelPath, string inputSourcePath, Vector3 position, Quaternion orientation)Parameters
| Type | Name | Description |
|---|---|---|
| string | topLevelPath | An OpenXRPath that specifies the OpenXR User Path of the value to be changed (e.g. /user/hand/left). |
| string | inputSourcePath | An OpenXRPath that specifies the full path of the input component whose state you wish to set (e.g. /user/hand/left/input/select/click). |
| Vector3 | position | A Vector3 that specifies the desired state of the target. |
| Quaternion | orientation | A Quaternion that specifies the desired state of the target. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the state is set successfully, or false if there was an error. |
ConformanceAutomationSetVec2(string, string, Vector2)
Drive the xrSetInputDeviceStateVector2fEXT function of the XR_EXT_conformance_automation. See https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_conformance_automation
Declaration
public static bool ConformanceAutomationSetVec2(string topLevelPath, string inputSourcePath, Vector2 state)Parameters
| Type | Name | Description |
|---|---|---|
| string | topLevelPath | An OpenXRPath that specifies the OpenXR User Path of the value to be changed (e.g. /user/hand/left). |
| string | inputSourcePath | An OpenXRPath that specifies the full path of the input component whose state you wish to set (e.g. /user/hand/left/input/select/click). |
| Vector2 | state | A Vector2 that specifies the desired state of the target. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the state is set successfully, or false if there was an error. |
ConformanceAutomationSetVelocity(string, string, bool, Vector3, bool, Vector3)
Set the angular and linear velocity of a pose
Declaration
public static bool ConformanceAutomationSetVelocity(string topLevelPath, string inputSourcePath, bool linearValid, Vector3 linear, bool angularValid, Vector3 angular)Parameters
| Type | Name | Description |
|---|---|---|
| string | topLevelPath | An OpenXRPath that specifies the OpenXR User Path of the value to be changed (e.g. /user/hand/left). |
| string | inputSourcePath | An OpenXRPath that specifies the full path of the input component whose state you wish to set (e.g. /user/hand/left/input/select/click). |
| bool | linearValid | True if the linear velocity is valid |
| Vector3 | linear | Linear velocity value |
| bool | angularValid | True if the angular velocity is valid |
| Vector3 | angular | Angular velocity value |
Returns
| Type | Description |
|---|---|
| bool | true if the velocity is set successfully, or false if there was an error. |
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
OnInstanceDestroy(ulong)
Called before xrDestroyInstance
Declaration
protected override void OnInstanceDestroy(ulong xrInstance)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | xrInstance | Handle of the xrInstance |
Overrides
OnSessionCreate(ulong)
Called after xrCreateSession.
Declaration
protected override void OnSessionCreate(ulong xrSessionId)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | xrSessionId |
Overrides
OnSessionDestroy(ulong)
Called before xrDestroySession.
Declaration
protected override void OnSessionDestroy(ulong xrSessionId)Parameters
| Type | Name | Description |
|---|---|---|
| ulong | xrSessionId |