XRRaycastSubsystemDescriptor.cs
8.43 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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
using System;
#if UNITY_2020_2_OR_NEWER
using UnityEngine.SubsystemsImplementation;
#endif
namespace UnityEngine.XR.ARSubsystems
{
/// <summary>
/// Descriptor for the <see cref="XRRaycastSubsystem"/>. Describes capabilities of a specific raycast provider.
/// </summary>
public sealed class XRRaycastSubsystemDescriptor :
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorWithProvider<XRRaycastSubsystem, XRRaycastSubsystem.Provider>
#else
SubsystemDescriptor<XRRaycastSubsystem>
#endif
{
/// <summary>
/// Used to register a descriptor. See <see cref="RegisterDescriptor(Cinfo)"/>.
/// </summary>
public struct Cinfo : IEquatable<Cinfo>
{
/// <summary>
/// A provider-specific identifier.
/// </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 <c>Type</c> of the subsystem.
/// </summary>
#if UNITY_2020_2_OR_NEWER
[Obsolete("XRRaycastSubsystem 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>
/// Whether the provider supports casting a ray from a screen point.
/// </summary>
public bool supportsViewportBasedRaycast { get; set; }
/// <summary>
/// Whether the provider supports casting an arbitrary ray.
/// </summary>
public bool supportsWorldBasedRaycast { get; set; }
/// <summary>
/// The types of trackables against which raycasting is supported.
/// </summary>
public TrackableType supportedTrackableTypes { get; set; }
/// <summary>
/// Whether "tracked" raycasts are supported. A tracked raycast is repeated
/// over time and the results are updated automatically.
/// </summary>
public bool supportsTrackedRaycasts { 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() => HashCode.Combine(
HashCode.ReferenceHash(id),
#if UNITY_2020_2_OR_NEWER
HashCode.ReferenceHash(providerType),
HashCode.ReferenceHash(subsystemTypeOverride),
#else
HashCode.ReferenceHash(subsystemImplementationType),
#endif
supportsViewportBasedRaycast.GetHashCode(),
supportsWorldBasedRaycast.GetHashCode(),
((int)supportedTrackableTypes).GetHashCode(),
supportsTrackedRaycasts.GetHashCode());
/// <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) && Equals((Cinfo)obj);
/// <summary>
/// Generates a string representation of this <see cref="Cinfo"/>.
/// </summary>
/// <returns>A string representation of this <see cref="Cinfo"/>.</returns>
public override string ToString()
{
return string.Format("XRRaycastSubsystemDescriptor:\nsupportsViewportBasedRaycast: {0}\nsupportsWorldBasedRaycast: {1}",
supportsViewportBasedRaycast, supportsWorldBasedRaycast);
}
/// <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) &&
#else
ReferenceEquals(subsystemImplementationType, other.subsystemImplementationType) &&
#endif
supportsViewportBasedRaycast == other.supportsViewportBasedRaycast &&
supportsWorldBasedRaycast == other.supportsWorldBasedRaycast &&
supportedTrackableTypes == other.supportedTrackableTypes;
}
/// <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) { return 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) { return !lhs.Equals(rhs); }
}
/// <summary>
/// Whether the provider supports casting a ray from a screen point.
/// </summary>
public bool supportsViewportBasedRaycast { get; private set; }
/// <summary>
/// Whether the provider supports casting an arbitrary ray.
/// </summary>
public bool supportsWorldBasedRaycast { get; private set; }
/// <summary>
/// The types of trackables against which raycasting is supported.
/// </summary>
public TrackableType supportedTrackableTypes { get; private set; }
/// <summary>
/// Whether "tracked" raycasts are supported. A tracked raycast is repeated
/// over time and the results are updated automatically.
/// </summary>
public bool supportsTrackedRaycasts { get; set; }
/// <summary>
/// Registers a new descriptor. Should be called by provider implementations.
/// </summary>
/// <param name="cinfo"></param>
public static void RegisterDescriptor(Cinfo cinfo)
{
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorStore.RegisterDescriptor(new XRRaycastSubsystemDescriptor(cinfo));
#else
SubsystemRegistration.CreateDescriptor(new XRRaycastSubsystemDescriptor(cinfo));
#endif
}
XRRaycastSubsystemDescriptor(Cinfo cinfo)
{
id = cinfo.id;
#if UNITY_2020_2_OR_NEWER
providerType = cinfo.providerType;
subsystemTypeOverride = cinfo.subsystemTypeOverride;
#else
subsystemImplementationType = cinfo.subsystemImplementationType;
#endif
supportsViewportBasedRaycast = cinfo.supportsViewportBasedRaycast;
supportsWorldBasedRaycast = cinfo.supportsWorldBasedRaycast;
supportedTrackableTypes = cinfo.supportedTrackableTypes;
supportsTrackedRaycasts = cinfo.supportsTrackedRaycasts;
}
}
}