Struct XRPlaneSubsystemDescriptor.Cinfo

Contains the parameters necessary to construct a new XRPlaneSubsystemDescriptor instance.

Implements

IEquatable<XRPlaneSubsystemDescriptor.Cinfo>

Inherited Members

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

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.

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

[Obsolete("supportsBoundaryVertices is deprecated in AR Foundation 6.5.0-pre.1. Use supportsBoundaryVerticesDelegate instead.")]
public bool supportsBoundaryVertices { readonly get; set; }

Property Value

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

supportsBoundaryVerticesDelegate

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

Declaration

public Func<bool> supportsBoundaryVerticesDelegate { readonly get; set; }

Property Value

Type	Description
Func<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 a classifications value of None.

Declaration

[Obsolete("supportsClassification is deprecated in AR Foundation 6.5.0-pre.1. Use supportsClassificationDelegate instead.")]
public bool supportsClassification { readonly get; set; }

Property Value

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

supportsClassificationDelegate

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

Declaration

public Func<bool> supportsClassificationDelegate { readonly get; set; }

Property Value

Type	Description
Func<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.

supportsPlaneSubsumptionDelegate

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 Func<bool> supportsPlaneSubsumptionDelegate { readonly get; set; }

Property Value

Type	Description
Func<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 { 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 object to compare against.

Returns

Type	Description
bool	true if obj is of type XRPlaneSubsystemDescriptor.Cinfo and Equals(Cinfo) also returns true. Otherwise, false.

Overrides

ValueType.Equals(object)

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 other is equal to this instance. Otherwise, false.

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

ValueType.GetHashCode()

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	true if lhs is equal to rhs. Otherwise, false.

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	true if lhs is not equal to rhs. Otherwise, false.

Implements

IEquatable<T>