XRFaceSubsystemDescriptor.cs
11.7 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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
using System;
#if UNITY_2020_2_OR_NEWER
using UnityEngine.SubsystemsImplementation;
#endif
namespace UnityEngine.XR.ARSubsystems
{
/// <summary>
/// Capabilities of a face subsystem implementation.
/// </summary>
[Flags]
public enum FaceSubsystemCapabilities
{
/// <summary>
/// The subsystem has no capabilities
/// </summary>
None = 0,
/// <summary>
/// The subsystem can produce a <c>Pose</c> for a face.
/// </summary>
Pose = 1 << 0,
/// <summary>
/// The subsystem can generate vertices and triangle indices for a mesh representing a face.
/// </summary>
MeshVerticesAndIndices = 1 << 1,
/// <summary>
/// The subsystem can supply texture coordinates for a face mesh.
/// </summary>
MeshUVs = 1 << 2,
/// <summary>
/// The subsystem can supply normals for a face mesh.
/// </summary>
MeshNormals = 1 << 3,
/// <summary>
/// The subsystem can supply eye tracking data for a face.
/// </summary>
EyeTracking = 1 << 4
}
/// <summary>
/// This struct is an initializer for the creation of a <see cref="XRFaceSubsystemDescriptor"/>.
/// </summary>
/// <remarks>
/// Face Tracking data provider should create during <c>InitializeOnLoad</c> a descriptor using
/// the params here to specify which of the XRFaceSubsystem features it supports.
/// </remarks>
public struct FaceSubsystemParams : IEquatable<FaceSubsystemParams>
{
/// <summary>
/// The string identifier for a specific implementation.
/// </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>XRFaceSubsystem</c>-derived type that forwards casted calls to its provider.
/// </summary>
/// <value>
/// The type of the subsystem to use for instantiation. If null, <c>XRFaceSubsystem</c> will be instantiated.
/// </value>
public Type subsystemTypeOverride { get; set; }
#endif
/// <summary>
/// The concrete <c>Type</c> which will be instantiated if <c>Create</c> is called on this subsystem descriptor.
/// </summary>
#if UNITY_2020_2_OR_NEWER
[Obsolete("XRFaceSubsystem 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 subsystem supports getting a pose for the face.
/// </summary>
public bool supportsFacePose
{
get => (m_Capabilities & FaceSubsystemCapabilities.Pose) != 0;
set
{
if (value)
{
m_Capabilities |= FaceSubsystemCapabilities.Pose;
}
else
{
m_Capabilities &= ~FaceSubsystemCapabilities.Pose;
}
}
}
/// <summary>
/// Whether the subsystem supports getting vertices and triangle indices describing a face mesh.
/// </summary>
public bool supportsFaceMeshVerticesAndIndices
{
get => (m_Capabilities & FaceSubsystemCapabilities.MeshVerticesAndIndices) != 0;
set
{
if (value)
{
m_Capabilities |= FaceSubsystemCapabilities.MeshVerticesAndIndices;
}
else
{
m_Capabilities &= ~FaceSubsystemCapabilities.MeshVerticesAndIndices;
}
}
}
/// <summary>
/// Whether the subsystem supports texture coordinates for the face mesh.
/// </summary>
public bool supportsFaceMeshUVs
{
get => (m_Capabilities & FaceSubsystemCapabilities.MeshUVs) != 0;
set
{
if (value)
{
m_Capabilities |= FaceSubsystemCapabilities.MeshUVs;
}
else
{
m_Capabilities &= ~FaceSubsystemCapabilities.MeshUVs;
}
}
}
/// <summary>
/// Whether the subsystem supports normals for the face mesh.
/// </summary>
public bool supportsFaceMeshNormals
{
get => (m_Capabilities & FaceSubsystemCapabilities.MeshNormals) != 0;
set
{
if (value)
{
m_Capabilities |= FaceSubsystemCapabilities.MeshNormals;
}
else
{
m_Capabilities &= ~FaceSubsystemCapabilities.MeshNormals;
}
}
}
/// <summary>
/// Whether the subsystem supports eye tracking for each detected face.
/// </summary>
public bool supportsEyeTracking
{
get => (m_Capabilities & FaceSubsystemCapabilities.EyeTracking) != 0;
set
{
if (value)
{
m_Capabilities |= FaceSubsystemCapabilities.EyeTracking;
}
else
{
m_Capabilities &= FaceSubsystemCapabilities.EyeTracking;
}
}
}
FaceSubsystemCapabilities m_Capabilities;
/// <summary>
/// Tests for equality.
/// </summary>
/// <param name="other">The other <see cref="FaceSubsystemParams"/> to compare against.</param>
/// <returns>`True` if every field in <paramref name="other"/> is equal to this <see cref="FaceSubsystemParams"/>, otherwise false.</returns>
public bool Equals(FaceSubsystemParams other)
{
return
m_Capabilities == other.m_Capabilities &&
ReferenceEquals(id, other.id) &&
#if UNITY_2020_2_OR_NEWER
ReferenceEquals(providerType, other.providerType) &&
ReferenceEquals(subsystemTypeOverride, other.subsystemTypeOverride);
#else
ReferenceEquals(subsystemImplementationType, other.subsystemImplementationType);
#endif
}
/// <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="FaceSubsystemParams"/> and
/// <see cref="Equals(FaceSubsystemParams)"/> also returns `true`; otherwise `false`.</returns>
public override bool Equals(object obj) => (obj is FaceSubsystemParams) && Equals((FaceSubsystemParams)obj);
/// <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 hashCode = HashCode.ReferenceHash(id);
#if UNITY_2020_2_OR_NEWER
hashCode = 486187739 * hashCode + HashCode.ReferenceHash(providerType);
hashCode = 486187739 * hashCode + HashCode.ReferenceHash(subsystemTypeOverride);
#else
hashCode = 486187739 * hashCode + HashCode.ReferenceHash(subsystemImplementationType);
#endif
hashCode = 486187739 * hashCode + ((int)m_Capabilities).GetHashCode();
return hashCode;
}
}
/// <summary>
/// Tests for equality. Same as <see cref="Equals(FaceSubsystemParams)"/>.
/// </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==(FaceSubsystemParams lhs, FaceSubsystemParams rhs) => lhs.Equals(rhs);
/// <summary>
/// Tests for inequality. Same as `!`<see cref="Equals(FaceSubsystemParams)"/>.
/// </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!=(FaceSubsystemParams lhs, FaceSubsystemParams rhs) => lhs.Equals(rhs);
}
/// <summary>
/// The descriptor of the <see cref="XRFaceSubsystem"/> that shows which face tracking features are available on that XRSubsystem.
/// </summary>
/// <remarks>
/// You use the <c>Create</c> factory method along with <see cref="FaceSubsystemParams"/> struct to construct and
/// register one of these from each face tracking data provider.
/// </remarks>
public class XRFaceSubsystemDescriptor :
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorWithProvider<XRFaceSubsystem, XRFaceSubsystem.Provider>
#else
SubsystemDescriptor<XRFaceSubsystem>
#endif
{
XRFaceSubsystemDescriptor(FaceSubsystemParams descriptorParams)
{
id = descriptorParams.id;
#if UNITY_2020_2_OR_NEWER
providerType = descriptorParams.providerType;
subsystemTypeOverride = descriptorParams.subsystemTypeOverride;
#else
subsystemImplementationType = descriptorParams.subsystemImplementationType;
#endif
supportsFacePose = descriptorParams.supportsFacePose;
supportsFaceMeshVerticesAndIndices = descriptorParams.supportsFaceMeshVerticesAndIndices;
supportsFaceMeshUVs = descriptorParams.supportsFaceMeshUVs;
supportsFaceMeshNormals = descriptorParams.supportsFaceMeshNormals;
supportsEyeTracking = descriptorParams.supportsEyeTracking;
}
/// <summary>
/// Whether the subsystem can produce a <c>Pose</c> for each detected face.
/// </summary>
public bool supportsFacePose { get; }
/// <summary>
/// Whether the subsystem supports face meshes, and can produce vertices and triangle indices representing a face mesh.
/// </summary>
public bool supportsFaceMeshVerticesAndIndices { get; }
/// <summary>
/// Whether the subsystem supports texture coordinates for each face mesh.
/// </summary>
public bool supportsFaceMeshUVs { get; }
/// <summary>
/// Whether the subsystem supports normals for each face mesh.
/// </summary>
public bool supportsFaceMeshNormals { get; }
/// <summary>
/// Whether the subsystem supports eye tracking for each detected face.
/// </summary>
public bool supportsEyeTracking { get; }
/// <summary>
/// Creates a subsystem descriptor. Used to register an implementation of the <see cref="XRFaceSubsystem"/>.
/// </summary>
/// <param name="descriptorParams">Parameters describing the <see cref="XRFaceSubsystem"/>.</param>
public static void Create(FaceSubsystemParams descriptorParams)
{
var descriptor = new XRFaceSubsystemDescriptor(descriptorParams);
#if UNITY_2020_2_OR_NEWER
SubsystemDescriptorStore.RegisterDescriptor(descriptor);
#else
SubsystemRegistration.CreateDescriptor(descriptor);
#endif
}
}
}