XRAnchorSubsystemDescriptor.cs
6.56 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
using System;
#if UNITY_2020_2_OR_NEWER
using UnityEngine.SubsystemsImplementation;
#endif
namespace UnityEngine.XR.ARSubsystems
{
/// <summary>
/// Describes the capabilities of an <see cref="XRAnchorSubsystem"/>.
/// </summary>
public class XRAnchorSubsystemDescriptor :
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorWithProvider<XRAnchorSubsystem, XRAnchorSubsystem.Provider>
#else
SubsystemDescriptor<XRAnchorSubsystem>
#endif
{
/// <summary>
/// <c>true</c> if the subsystem supports attachments, i.e., the ability to attach an anchor to a trackable.
/// </summary>
public bool supportsTrackableAttachments { get; private set; }
/// <summary>
/// Constructor info used to register a descriptor.
/// </summary>
public struct Cinfo : IEquatable<Cinfo>
{
/// <summary>
/// The string identifier for this subsystem.
/// </summary>
public string id { get; set; }
#if UNITY_2020_2_OR_NEWER
/// <summary>
/// Specifies the provider implementation type to use for instantiation.
/// </summary>
/// <value>
/// The provider implementation type to use for instantiation.
/// </value>
public Type providerType { get; set; }
/// <summary>
/// Specifies the <c>XRAnchorSubsystem</c>-derived type that forwards casted calls to its provider.
/// </summary>
/// <value>
/// The type of the subsystem to use for instantiation. If null, <c>XRAnchorSubsystem</c> will be instantiated.
/// </value>
public Type subsystemTypeOverride { get; set; }
#endif
/// <summary>
/// The concrete <c>Type</c> of the subsystem which will be instantiated if a subsystem is created from this descriptor.
/// </summary>
#if UNITY_2020_2_OR_NEWER
[Obsolete("XRAnchorSubsystem no longer supports the deprecated set of base classes for subsystems as of Unity 2020.2. Use providerType and, optionally, subsystemTypeOverride instead.", true)]
#endif
public Type subsystemImplementationType { get; set; }
/// <summary>
/// <c>true</c> if the subsystem supports attachments, i.e., the ability to attach an anchor to a trackable.
/// </summary>
public bool supportsTrackableAttachments { get; set; }
/// <summary>
/// Generates a hash suitable for use with containers like `HashSet` and `Dictionary`.
/// </summary>
/// <returns>A hash code generated from this object's fields.</returns>
public override int GetHashCode()
{
unchecked
{
int hash = HashCode.ReferenceHash(id);
#if UNITY_2020_2_OR_NEWER
hash = 486187739 * hash + HashCode.ReferenceHash(providerType);
hash = 486187739 * hash + HashCode.ReferenceHash(subsystemTypeOverride);
#else
hash = 486187738 * hash + HashCode.ReferenceHash(subsystemImplementationType);
#endif
hash = 486187738 * hash + supportsTrackableAttachments.GetHashCode();
return hash;
}
}
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="obj">The `object` to compare against.</param>
/// <returns>`True` if <paramref name="obj"/> is of type <see cref="Cinfo"/> and
/// <see cref="Equals(Cinfo)"/> also returns `true`; otherwise `false`.</returns>
public override bool Equals(object obj) => (obj is Cinfo other) && Equals(other);
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="other">The other <see cref="Cinfo"/> to compare against.</param>
/// <returns>`True` if every field in <paramref name="other"/> is equal to this <see cref="Cinfo"/>, otherwise false.</returns>
public bool Equals(Cinfo other)
{
return
String.Equals(id, other.id) &&
#if UNITY_2020_2_OR_NEWER
ReferenceEquals(providerType, other.providerType) &&
ReferenceEquals(subsystemTypeOverride, other.subsystemTypeOverride) &&
supportsTrackableAttachments == other.supportsTrackableAttachments; // NB: before 2020.2, this was excluded - just trying to keep from changing behavior
#else
ReferenceEquals(subsystemImplementationType, other.subsystemImplementationType);
#endif
}
/// <summary>
/// Tests for equality. Same as <see cref="Equals(Cinfo)"/>.
/// </summary>
/// <param name="lhs">The left-hand side of the comparison.</param>
/// <param name="rhs">The right-hand side of the comparison.</param>
/// <returns>`True` if <paramref name="lhs"/> is equal to <paramref name="rhs"/>, otherwise `false`.</returns>
public static bool operator ==(Cinfo lhs, Cinfo rhs) => lhs.Equals(rhs);
/// <summary>
/// Tests for inequality. Same as `!`<see cref="Equals(Cinfo)"/>.
/// </summary>
/// <param name="lhs">The left-hand side of the comparison.</param>
/// <param name="rhs">The right-hand side of the comparison.</param>
/// <returns>`True` if <paramref name="lhs"/> is not equal to <paramref name="rhs"/>, otherwise `false`.</returns>
public static bool operator !=(Cinfo lhs, Cinfo rhs) => !lhs.Equals(rhs);
}
/// <summary>
/// Creates a new subsystem descriptor and registers it with the <c>SubsystemManager</c>.
/// </summary>
/// <param name="cinfo">Constructor info describing the descriptor to create.</param>
public static void Create(Cinfo cinfo)
{
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorStore.RegisterDescriptor(new XRAnchorSubsystemDescriptor(cinfo));
#else
SubsystemRegistration.CreateDescriptor(new XRAnchorSubsystemDescriptor(cinfo));
#endif
}
XRAnchorSubsystemDescriptor(Cinfo cinfo)
{
id = cinfo.id;
#if UNITY_2020_2_OR_NEWER
providerType = cinfo.providerType;
subsystemTypeOverride = cinfo.subsystemTypeOverride;
#else
subsystemImplementationType = cinfo.subsystemImplementationType;
#endif
supportsTrackableAttachments = cinfo.supportsTrackableAttachments;
}
}
}