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
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
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 GetChanges(Allocator) must not have their alignment value set to NotAxisAligned.
Declaration
public bool supportsArbitraryPlaneDetection { get; }
Property Value
Type | Description |
---|---|
Boolean | 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, GetBoundary(TrackableId, Allocator, ref NativeArray<Vector2>) must throw a NotSupportedException.
Declaration
public bool supportsBoundaryVertices { get; }
Property Value
Type | Description |
---|---|
Boolean | true if the implementation supports boundary vertices for its planes. Otherwise, false. |
supportsClassification
Indicates whether the provider implementation can provide a value for
classification. If false, all
planes returned by GetChanges(Allocator) will have a
classification
value of None.
Declaration
public bool supportsClassification { get; }
Property Value
Type | Description |
---|---|
Boolean | true if the implementation supports plane classification. Otherwise, false. |
supportsHorizontalPlaneDetection
Indicates whether the provider implementation supports the detection of horizontal planes, such as the floor. If false, BoundedPlane trackables returned by GetChanges(Allocator) must not have their alignment values set to either HorizontalDown or HorizontalUp.
Declaration
public bool supportsHorizontalPlaneDetection { get; }
Property Value
Type | Description |
---|---|
Boolean | true if the implementation supports horizontal plane detection. Otherwise, false. |
supportsVerticalPlaneDetection
Indicates whether the provider implementation supports the detection of vertical planes, such as walls. If false, BoundedPlane trackables returned by GetChanges(Allocator) must not have their alignment value set to Vertical.
Declaration
public bool supportsVerticalPlaneDetection { get; }
Property Value
Type | Description |
---|---|
Boolean | true if the implementation supports vertical plane detection. Otherwise, false. |
Methods
Create(XRPlaneSubsystemDescriptor.Cinfo)
Creates a new subsystem descriptor instance and registers it with the UnityEngine.SubsystemManager.
Declaration
public static void Create(XRPlaneSubsystemDescriptor.Cinfo cinfo)
Parameters
Type | Name | Description |
---|---|---|
XRPlaneSubsystemDescriptor.Cinfo | cinfo | Construction info for the descriptor. |