Class SpatialPlaneFeature

Enables AR Foundation plane support via OpenXR Spatial Entities extensions.

Inheritance

object

Object

ScriptableObject

OpenXRFeature

SpatialSetupConfigurationProvider

SpatialPlaneFeature

Implements

IConfigurationAnalytic

Inherited Members

SpatialSetupConfigurationProvider.OnEnabledChange()

OpenXRFeature.enabled

OpenXRFeature.ShouldUseExtension(string)

OpenXRFeature.GetExtensions()

OpenXRFeature.xrGetInstanceProcAddr

OpenXRFeature.HookGetInstanceProcAddr(IntPtr)

OpenXRFeature.OnSubsystemStart()

OpenXRFeature.OnSubsystemStop()

OpenXRFeature.OnExtensionsReady(ulong)

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.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.GetAction(InputDevice, InputFeatureUsage)

OpenXRFeature.GetAction(InputDevice, string)

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.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

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

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

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

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

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.SpatialEntities

Assembly: Unity.XR.SpatialEntities.dll

Syntax

public class SpatialPlaneFeature : SpatialSetupConfigurationProvider, IConfigurationAnalytic

Fields

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.arfoundation-spatialentities-plane"

Field Value

Type	Description
string

Methods

GetValidationChecks(List<ValidationRule>, BuildTargetGroup)

Get validation rules for this feature.

Declaration

protected override void GetValidationChecks(List<OpenXRFeature.ValidationRule> rules, BuildTargetGroup targetGroup)

Parameters

Type	Name	Description
List<OpenXRFeature.ValidationRule>	rules
BuildTargetGroup	targetGroup

Overrides

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

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 xrInstance)

Parameters

Type	Name	Description
ulong	xrInstance	Handle of the native xrInstance.

Returns

Type	Description
bool	true if this feature successfully initialized. Otherwise, false.

Overrides

OpenXRFeature.OnInstanceCreate(ulong)

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

Enabling OpenXR spec extension strings

OnSubsystemCreate()

Called after the OpenXR Loader is initialized and has created its subsystems.

Declaration

protected override void OnSubsystemCreate()

Overrides

UnityEngine.XR.OpenXR.Features.OpenXRFeature.OnSubsystemCreate()

OnSubsystemDestroy()

Called before the OpenXR Loader destroys its subsystems.

Declaration

protected override void OnSubsystemDestroy()

Overrides

UnityEngine.XR.OpenXR.Features.OpenXRFeature.OnSubsystemDestroy()

Implements

IConfigurationAnalytic