Struct XRPlaneSubsystemDescriptor.Cinfo
Contains the parameters necessary to construct a new XRPlaneSubsystemDescriptor instance.
Implements
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
public struct XRPlaneSubsystemDescriptor.Cinfo : IEquatable<XRPlaneSubsystemDescriptor.Cinfo>
Properties
id
The unique identifier of the provider implementation. No specific format is required.
Declaration
public string id { readonly get; set; }
Property Value
Type | Description |
---|---|
string |
providerType
The provider implementation type to use for instantiation.
Declaration
public Type providerType { readonly get; set; }
Property Value
Type | Description |
---|---|
Type | The provider implementation type. |
subsystemImplementationType
The concrete Type
which will be instantiated if Create
is called on this subsystem descriptor.
Declaration
[Obsolete("XRPlaneSubsystem no longer supports the deprecated set of base classes for subsystems as of Unity 2020.2. Use providerType and, optionally, subsystemTypeOverride instead.", true)]
public Type subsystemImplementationType { readonly get; set; }
Property Value
Type | Description |
---|---|
Type |
subsystemTypeOverride
The XRPlaneSubsystem-derived type to use for instantiation. The instantiated instance of this type will forward casted calls to its provider.
Declaration
public Type subsystemTypeOverride { readonly get; set; }
Property Value
Type | Description |
---|---|
Type | The subsystem implementation type. If null, XRPlaneSubsystem will be instantiated. |
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 { readonly get; set; }
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 { readonly get; set; }
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.classification. If false, all
planes returned by XRPlaneSubsystem.GetChanges will have a
classification
value of None.
Declaration
public bool supportsClassification { readonly get; set; }
Property Value
Type | Description |
---|---|
bool | 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 XRPlaneSubsystem.GetChanges must not have their alignment value set to either HorizontalDown or HorizontalUp.
Declaration
public bool supportsHorizontalPlaneDetection { readonly get; set; }
Property Value
Type | Description |
---|---|
bool | 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 XRPlaneSubsystem.GetChanges must not have their alignment value set to Vertical.
Declaration
public bool supportsVerticalPlaneDetection { readonly get; set; }
Property Value
Type | Description |
---|---|
bool | true if the implementation supports vertical plane detection. Otherwise, false. |
Methods
Equals(object)
Tests for equality.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | The |
Returns
Type | Description |
---|---|
bool | true if |
Overrides
Equals(Cinfo)
Tests for equality.
Declaration
public bool Equals(XRPlaneSubsystemDescriptor.Cinfo other)
Parameters
Type | Name | Description |
---|---|---|
XRPlaneSubsystemDescriptor.Cinfo | other | The other XRPlaneSubsystemDescriptor.Cinfo to compare against. |
Returns
Type | Description |
---|---|
bool | true if every field in |
GetHashCode()
Generates a hash suitable for use with containers like HashSet
and Dictionary
.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | A hash code generated from this object's fields. |
Overrides
Operators
operator ==(Cinfo, Cinfo)
Tests for equality. Equivalent to Equals(Cinfo).
Declaration
public static bool operator ==(XRPlaneSubsystemDescriptor.Cinfo lhs, XRPlaneSubsystemDescriptor.Cinfo rhs)
Parameters
Type | Name | Description |
---|---|---|
XRPlaneSubsystemDescriptor.Cinfo | lhs | The left-hand side of the comparison. |
XRPlaneSubsystemDescriptor.Cinfo | rhs | The right-hand side of the comparison. |
Returns
Type | Description |
---|---|
bool |
operator !=(Cinfo, Cinfo)
Tests for inequality. Equivalent to !
Equals(Cinfo).
Declaration
public static bool operator !=(XRPlaneSubsystemDescriptor.Cinfo lhs, XRPlaneSubsystemDescriptor.Cinfo rhs)
Parameters
Type | Name | Description |
---|---|---|
XRPlaneSubsystemDescriptor.Cinfo | lhs | The left-hand side of the comparison. |
XRPlaneSubsystemDescriptor.Cinfo | rhs | The right-hand side of the comparison. |
Returns
Type | Description |
---|---|
bool |