ARTrackedImageManager.cs
12.5 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
using System;
using System.Collections.Generic;
using Unity.Jobs;
using UnityEngine.Serialization;
using UnityEngine.XR.ARSubsystems;
namespace UnityEngine.XR.ARFoundation
{
/// <summary>
/// A manager for <see cref="ARTrackedImage"/>s. Uses the <c>XRImageTrackingSubsystem</c>
/// to recognize and track 2D images in the physical environment.
/// </summary>
[DefaultExecutionOrder(ARUpdateOrder.k_TrackedImageManager)]
[RequireComponent(typeof(ARSessionOrigin))]
[HelpURL(HelpUrls.ApiWithNamespace + nameof(ARTrackedImageManager) + ".html")]
public sealed class ARTrackedImageManager : ARTrackableManager<
XRImageTrackingSubsystem,
XRImageTrackingSubsystemDescriptor,
#if UNITY_2020_2_OR_NEWER
XRImageTrackingSubsystem.Provider,
#endif
XRTrackedImage,
ARTrackedImage>
{
[SerializeField]
[FormerlySerializedAs("m_ReferenceLibrary")]
[Tooltip("The library of images which will be detected and/or tracked in the physical environment.")]
XRReferenceImageLibrary m_SerializedLibrary;
/// <summary>
/// Get or set the reference image library, the set of images to search for in the physical environment.
/// </summary>
/// <remarks>
/// An <c>IReferenceImageLibrary</c> can be either an <c>XRReferenceImageLibrary</c>
/// or a <c>RuntimeReferenceImageLibrary</c>. <c>XRReferenceImageLibrary</c>s can only be
/// constructed at edit-time and are immutable at runtime. A <c>RuntimeReferenceImageLibrary</c>
/// is the runtime representation of a <c>XRReferenceImageLibrary</c> and may be mutable
/// at runtime (see <c>MutableRuntimeReferenceImageLibrary</c>).
/// </remarks>
/// <exception cref="System.InvalidOperationException">Thrown if the <see cref="referenceLibrary"/> is set to <c>null</c> while image tracking is enabled.</exception>
public IReferenceImageLibrary referenceLibrary
{
get
{
if (subsystem != null)
{
return subsystem.imageLibrary;
}
else
{
return m_SerializedLibrary;
}
}
set
{
if (value == null && subsystem != null && subsystem.running)
throw new InvalidOperationException("Cannot set a null reference library while image tracking is enabled.");
if (value is XRReferenceImageLibrary serializedLibrary)
{
m_SerializedLibrary = serializedLibrary;
if (subsystem != null)
subsystem.imageLibrary = subsystem.CreateRuntimeLibrary(serializedLibrary);
}
else if (value is RuntimeReferenceImageLibrary runtimeLibrary)
{
m_SerializedLibrary = null;
EnsureSubsystemInstanceSet();
if (subsystem != null)
subsystem.imageLibrary = runtimeLibrary;
}
if (subsystem != null)
UpdateReferenceImages(subsystem.imageLibrary);
}
}
/// <summary>
/// Creates a <c>UnityEngine.XR.ARSubsystems.RuntimeReferenceImageLibrary</c> from an existing
/// <c>UnityEngine.XR.ARSubsystems.XRReferenceImageLibrary</c>
/// or an empty library if <paramref name="serializedLibrary"/> is <c>null</c>.
/// Use this to construct reference image libraries at runtime. If the library is of type
/// <c>MutableRuntimeReferenceImageLibrary</c>, it is modifiable at runtime.
/// </summary>
/// <param name="serializedLibrary">An existing <c>XRReferenceImageLibrary</c>, or <c>null</c> to create an empty mutable image library.</param>
/// <returns>A new <c>RuntimeReferenceImageLibrary</c> representing the deserialized version of <paramref name="serializedLibrary"/>or an empty library if <paramref name="serializedLibrary"/> is <c>null</c>.</returns>
/// <exception cref="System.NotSupportedException">Thrown if there is no subsystem. This usually means image tracking is not supported.</exception>
public RuntimeReferenceImageLibrary CreateRuntimeLibrary(XRReferenceImageLibrary serializedLibrary = null)
{
EnsureSubsystemInstanceSet();
if (subsystem == null)
throw new NotSupportedException("No image tracking subsystem found. This usually means image tracking is not supported.");
return subsystem.CreateRuntimeLibrary(serializedLibrary);
}
[SerializeField]
[Tooltip("The maximum number of moving images to track in realtime. Not all implementations support this feature.")]
int m_MaxNumberOfMovingImages;
/// <summary>
/// The maximum number of moving images to track in realtime.
/// This property is obsolete.
/// Use <see cref="requestedMaxNumberOfMovingImages"/>
/// or <see cref="currentMaxNumberOfMovingImages"/> instead.
/// </summary>
[Obsolete("Use requestedMaxNumberOfMovingImages or currentMaxNumberOfMovingImages instead. (2020-01-16)")]
public int maxNumberOfMovingImages
{
get => m_MaxNumberOfMovingImages;
set => requestedMaxNumberOfMovingImages = value;
}
bool supportsMovingImages => descriptor?.supportsMovingImages == true;
/// <summary>
/// The requested maximum number of moving images to track in realtime. Support may vary between devices and providers. Check
/// for support at runtime with <see cref="SubsystemLifecycleManager{TSubsystem,TSubsystemDescriptor}.descriptor"/>'s
/// `supportsMovingImages` property.
/// </summary>
public int requestedMaxNumberOfMovingImages
{
get => supportsMovingImages ? subsystem.requestedMaxNumberOfMovingImages : m_MaxNumberOfMovingImages;
set
{
m_MaxNumberOfMovingImages = value;
if (enabled && (descriptor?.supportsMovingImages == true))
{
subsystem.requestedMaxNumberOfMovingImages = value;
}
}
}
/// <summary>
/// Get the maximum number of moving images to track in realtime currently in use by the subsystem.
/// </summary>
public int currentMaxNumberOfMovingImages => supportsMovingImages ? subsystem.currentMaxNumberOfMovingImages : 0;
[SerializeField]
[Tooltip("If not null, instantiates this prefab for each detected image.")]
GameObject m_TrackedImagePrefab;
/// <summary>
/// If not null, instantiates this prefab for each detected image.
/// </summary>
/// <remarks>
/// The purpose of this property is to _extend_ the functionality of <see cref="ARTrackedImage"/>s.
/// It is not the recommended way to instantiate _content_ associated with an <see cref="ARTrackedImage"/>.
/// See [Tracked Image Prefab](xref:arfoundation-tracked-image-manager#tracked-image-prefab) for more details.
/// </remarks>
public GameObject trackedImagePrefab
{
get => m_TrackedImagePrefab;
set => m_TrackedImagePrefab = value;
}
/// <summary>
/// Get the prefab that will be instantiated for each <see cref="ARTrackedImage"/>.
/// </summary>
/// <returns>The prefab that will be instantiated for each <see cref="ARTrackedImage"/>.</returns>
protected override GameObject GetPrefab() => m_TrackedImagePrefab;
/// <summary>
/// Invoked once per frame with information about the <see cref="ARTrackedImage"/>s that have changed, i.e., been added, updated, or removed.
/// This happens just before <see cref="ARTrackedImage"/>s are destroyed, so you can set <c>ARTrackedImage.destroyOnRemoval</c> to <c>false</c>
/// from this event to suppress this behavior.
/// </summary>
public event Action<ARTrackedImagesChangedEventArgs> trackedImagesChanged;
/// <summary>
/// The name to be used for the <c>GameObject</c> whenever a new image is detected.
/// </summary>
protected override string gameObjectName => nameof(ARTrackedImage);
/// <summary>
/// Sets the image library on the subsystem before Start() is called on the <c>XRImageTrackingSubsystem</c>.
/// </summary>
protected override void OnBeforeStart()
{
if (subsystem.imageLibrary == null && m_SerializedLibrary != null)
{
subsystem.imageLibrary = subsystem.CreateRuntimeLibrary(m_SerializedLibrary);
m_SerializedLibrary = null;
}
UpdateReferenceImages(subsystem.imageLibrary);
if (supportsMovingImages)
{
subsystem.requestedMaxNumberOfMovingImages = m_MaxNumberOfMovingImages;
}
enabled = (subsystem.imageLibrary != null);
#if DEVELOPMENT_BUILD
if (subsystem.imageLibrary == null)
{
Debug.LogWarning($"{nameof(ARTrackedImageManager)} '{name}' was enabled but no reference image library is specified. To enable, set a valid reference image library and then re-enable this component.");
}
#endif
}
bool FindReferenceImage(Guid guid, out XRReferenceImage referenceImage)
{
if (m_ReferenceImages.TryGetValue(guid, out referenceImage))
return true;
// If we are using a mutable library, then its possible an image
// has been added that we don't yet know about, so search the library.
if (referenceLibrary is MutableRuntimeReferenceImageLibrary mutableLibrary)
{
foreach (var candidateImage in mutableLibrary)
{
if (candidateImage.guid.Equals(guid))
{
referenceImage = candidateImage;
m_ReferenceImages.Add(referenceImage.guid, referenceImage);
return true;
}
}
}
return false;
}
/// <summary>
/// Invoked just after updating each <see cref="ARTrackedImage"/>. Used to update the <see cref="ARTrackedImage.referenceImage"/>.
/// </summary>
/// <param name="image">The tracked image being updated.</param>
/// <param name="sessionRelativeData">New data associated with the tracked image. Spatial data is
/// relative to the <see cref="ARSessionOrigin"/>.</param>
protected override void OnAfterSetSessionRelativeData(
ARTrackedImage image,
XRTrackedImage sessionRelativeData)
{
if (FindReferenceImage(sessionRelativeData.sourceImageId, out XRReferenceImage referenceImage))
{
image.referenceImage = referenceImage;
}
#if DEVELOPMENT_BUILD
else
{
Debug.LogError($"Could not find reference image with guid {sessionRelativeData.sourceImageId}");
}
#endif
}
/// <summary>
/// Invokes the <see cref="trackedImagesChanged"/> event.
/// </summary>
/// <param name="added">A list of images added this frame.</param>
/// <param name="updated">A list of images updated this frame.</param>
/// <param name="removed">A list of images removed this frame.</param>
protected override void OnTrackablesChanged(
List<ARTrackedImage> added,
List<ARTrackedImage> updated,
List<ARTrackedImage> removed)
{
if (trackedImagesChanged != null)
{
using (new ScopedProfiler("OnTrackedImagesChanged"))
trackedImagesChanged(
new ARTrackedImagesChangedEventArgs(
added,
updated,
removed));
}
}
void UpdateReferenceImages(RuntimeReferenceImageLibrary library)
{
if (library == null)
return;
int count = library.count;
for (int i = 0; i < count; ++i)
{
var referenceImage = library[i];
m_ReferenceImages[referenceImage.guid] = referenceImage;
}
}
Dictionary<Guid, XRReferenceImage> m_ReferenceImages = new Dictionary<Guid, XRReferenceImage>();
}
}