XRFaceSubsystemDescriptor.cs
8.77 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
using System;
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; }
/// <summary>
/// The concrete <c>Type</c> which will be instantiated if <c>Create</c> is called on this subsystem descriptor.
/// </summary>
public Type subsystemImplementationType { get; set; }
/// <summary>
/// Whether the subsystem supports getting a pose for the face.
/// </summary>
public bool supportsFacePose
{
get { return (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 { return (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 { return (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 { return (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 { return (m_Capabilities & FaceSubsystemCapabilities.EyeTracking) != 0; }
set
{
if (value)
{
m_Capabilities |= FaceSubsystemCapabilities.EyeTracking;
}
else
{
m_Capabilities &= FaceSubsystemCapabilities.EyeTracking;
}
}
}
FaceSubsystemCapabilities m_Capabilities;
//IEquatable boilerplate
public bool Equals(FaceSubsystemParams other)
{
return
(m_Capabilities == other.m_Capabilities) &&
(id == other.id) &&
(subsystemImplementationType == other.subsystemImplementationType);
}
public override bool Equals(object obj)
{
if (!(obj is FaceSubsystemParams))
{
return false;
}
return Equals((FaceSubsystemParams)obj);
}
public override int GetHashCode()
{
unchecked
{
var hashCode = (id == null) ? 0 : id.GetHashCode();
hashCode = (hashCode * 486187739) + subsystemImplementationType.GetHashCode();
hashCode = (hashCode * 486187739) + ((int)m_Capabilities).GetHashCode();
return hashCode;
}
}
public static bool operator==(FaceSubsystemParams lhs, FaceSubsystemParams rhs)
{
return lhs.Equals(rhs);
}
public static bool operator!=(FaceSubsystemParams lhs, FaceSubsystemParams rhs)
{
return !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 : SubsystemDescriptor<XRFaceSubsystem>
{
XRFaceSubsystemDescriptor(FaceSubsystemParams descriptorParams)
{
id = descriptorParams.id;
subsystemImplementationType = descriptorParams.subsystemImplementationType;
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);
SubsystemRegistration.CreateDescriptor(descriptor);
}
}
}