Class XRPlaneSubsystemDescriptor

Indicates the capabilities supported by a provider of the XRPlaneSubsystem. Provider implementations must derive from XRPlaneSubsystem.Provider and may override virtual class members.

Inheritance

object

SubsystemDescriptorWithProvider

SubsystemDescriptorWithProvider<XRPlaneSubsystem, XRPlaneSubsystem.Provider>

XRPlaneSubsystemDescriptor

Implements

ISubsystemDescriptor

Inherited Members

SubsystemDescriptorWithProvider<XRPlaneSubsystem, XRPlaneSubsystem.Provider>.Create()

SubsystemDescriptorWithProvider.id

SubsystemDescriptorWithProvider.providerType

SubsystemDescriptorWithProvider.subsystemTypeOverride

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public class XRPlaneSubsystemDescriptor : SubsystemDescriptorWithProvider<XRPlaneSubsystem, XRPlaneSubsystem.Provider>, ISubsystemDescriptor

Properties

supportsArbitraryPlaneDetection

Indicates whether the provider implementation supports the detection of planes that are aligned with neither the horizontal nor vertical axes. If false, BoundedPlane trackables returned by XRPlaneSubsystem.GetChanges must not have their alignment value set to NotAxisAligned.

Declaration

public bool supportsArbitraryPlaneDetection { get; }

Property Value

Type	Description
bool	`true` if the implementation supports the detection of planes oriented at arbitrary angles. Otherwise, `false`.

supportsBoundaryVertices

Indicates whether the provider implementation supports boundary vertices for its planes. If false, XRPlaneSubsystem.GetBoundary must throw a NotSupportedException.

Declaration

public bool supportsBoundaryVertices { get; }

Property Value

Type	Description
bool	`true` if the implementation supports boundary vertices for its planes. Otherwise, `false`.

supportsClassification

Indicates whether the provider implementation can provide a value for BoundedPlane.classifications. If false, all planes returned by XRPlaneSubsystem.GetChanges will have classifications value of None.

Declaration

public bool supportsClassification { get; }

Property Value

Type	Description
bool	`true` if the implementation supports plane classifications. Otherwise, `false`.

supportsHorizontalPlaneDetection

Indicates whether the provider implementation supports the detection of horizontal planes, such as the floor. If false, BoundedPlane trackables returned by XRPlaneSubsystem.GetChanges must not have their alignment values set to either HorizontalDown or HorizontalUp.

Declaration

public bool supportsHorizontalPlaneDetection { get; }

Property Value

Type	Description
bool	`true` if the implementation supports horizontal plane detection. Otherwise, `false`.

supportsPlaneSubsumption

Indicates whether the provider implementation supports the ability to absorb one plane into another while plane detection is enabled, if the runtime determines that both planes represent the same surface. If false, BoundedPlane trackables returned by XRPlaneSubsystem.GetChanges must have their subsumedById properties set to TrackableId.invalidId.

Declaration

public bool supportsPlaneSubsumption { get; }

Property Value

Type	Description
bool	`true` if the implementation supports plane subsumption. Otherwise, `false`.

supportsVerticalPlaneDetection

Indicates whether the provider implementation supports the detection of vertical planes, such as walls. If false, BoundedPlane trackables returned by XRPlaneSubsystem.GetChanges must not have their alignment value set to Vertical.

Declaration

public bool supportsVerticalPlaneDetection { get; }

Property Value

Type	Description
bool	`true` if the implementation supports vertical plane detection. Otherwise, `false`.

Methods

Create(Cinfo)

Creates a new subsystem descriptor instance and registers it with the SubsystemManager.

Declaration

[Obsolete("Create(Cinfo) has been deprecated in AR Foundation version 6.0. Use Register(Cinfo) instead (UnityUpgradable) -> Register(*)", false)]
public static void Create(XRPlaneSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRPlaneSubsystemDescriptor.Cinfo	cinfo	Construction info for the descriptor.

Register(Cinfo)

Creates a new subsystem descriptor instance and registers it with the SubsystemManager.

Declaration

public static void Register(XRPlaneSubsystemDescriptor.Cinfo cinfo)

Parameters

Type	Name	Description
XRPlaneSubsystemDescriptor.Cinfo	cinfo	Construction info for the descriptor.

Implements

ISubsystemDescriptor