ARAnchorManager.cs
7.06 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
using System;
using System.Collections.Generic;
using UnityEngine.Serialization;
using UnityEngine.XR.ARSubsystems;
namespace UnityEngine.XR.ARFoundation
{
/// <summary>
/// Manages anchors.
/// </summary>
/// <remarks>
/// <para>Use this component to programmatically add, remove, or query for
/// anchors. Anchors are <c>Pose</c>s in the world
/// which will be periodically updated by an AR device as its understanding
/// of the world changes.</para>
/// <para>Subscribe to changes (added, updated, and removed) via the
/// <see cref="ARAnchorManager.anchorsChanged"/> event.</para>
/// </remarks>
/// <seealso cref="ARTrackableManager{TSubsystem, TSubsystemDescriptor, TSessionRelativeData, TTrackable}"/>
[DefaultExecutionOrder(ARUpdateOrder.k_AnchorManager)]
[DisallowMultipleComponent]
[RequireComponent(typeof(ARSessionOrigin))]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@3.0/api/UnityEngine.XR.ARFoundation.ARAnchorManager.html")]
public sealed class ARAnchorManager : ARTrackableManager<
XRAnchorSubsystem,
XRAnchorSubsystemDescriptor,
XRAnchor,
ARAnchor>
{
[SerializeField]
[Tooltip("If not null, instantiates this prefab for each instantiated anchor.")]
[FormerlySerializedAs("m_ReferencePointPrefab")]
GameObject m_AnchorPrefab;
/// <summary>
/// Getter/setter for the Anchor Prefab.
/// </summary>
public GameObject anchorPrefab
{
get { return m_AnchorPrefab; }
set { m_AnchorPrefab = value; }
}
/// <summary>
/// Invoked once per frame to communicate changes to anchors, including
/// new anchors, the update of existing anchors, and the removal
/// of previously existing anchors.
/// </summary>
public event Action<ARAnchorsChangedEventArgs> anchorsChanged;
/// <summary>
/// Attempts to add an <see cref="ARAnchor"/> with the given <c>Pose</c>.
/// </summary>
/// <remarks>
/// If <see cref="ARTrackableManager{TSubsystem, TSubsystemDescriptor, TSessionRelativeData, TTrackable}.prefab"/>
/// is not null, a new instance of that prefab will be instantiated. Otherwise, a
/// new <c>GameObject</c> will be created. In either case, the resulting
/// <c>GameObject</c> will have an <see cref="ARAnchor"/> component on it.
/// </remarks>
/// <param name="pose">The pose, in Unity world space, of the <see cref="ARAnchor"/>.</param>
/// <returns>A new <see cref="ARAnchor"/> if successful, otherwise <c>null</c>.</returns>
public ARAnchor AddAnchor(Pose pose)
{
if (!enabled)
throw new InvalidOperationException("Cannot create a anchor from a disabled anchor manager.");
if (subsystem == null)
throw new InvalidOperationException("Anchor manager has no subsystem. Enable the manager first.");
var sessionRelativePose = sessionOrigin.trackablesParent.InverseTransformPose(pose);
// Add the anchor to the XRAnchorSubsystem
XRAnchor sessionRelativeData;
if (subsystem.TryAddAnchor(sessionRelativePose, out sessionRelativeData))
return CreateTrackableImmediate(sessionRelativeData);
return null;
}
/// <summary>
/// Attempts to create a new anchor that is attached to an existing <see cref="ARPlane"/>.
/// </summary>
/// <param name="plane">The <see cref="ARPlane"/> to which to attach.</param>
/// <param name="pose">The initial <c>Pose</c>, in Unity world space, of the anchor.</param>
/// <returns>A new <see cref="ARAnchor"/> if successful, otherwise <c>null</c>.</returns>
public ARAnchor AttachAnchor(ARPlane plane, Pose pose)
{
if (!enabled)
throw new InvalidOperationException("Cannot create a anchor from a disabled anchor manager.");
if (subsystem == null)
throw new InvalidOperationException("Anchor manager has no subsystem. Enable the manager first.");
if (plane == null)
throw new ArgumentNullException("plane");
var sessionRelativePose = sessionOrigin.trackablesParent.InverseTransformPose(pose);
XRAnchor sessionRelativeData;
if (subsystem.TryAttachAnchor(plane.trackableId, sessionRelativePose, out sessionRelativeData))
return CreateTrackableImmediate(sessionRelativeData);
return null;
}
/// <summary>
/// Attempts to remove an <see cref="ARAnchor"/>.
/// </summary>
/// <param name="anchor">The anchor you wish to remove.</param>
/// <returns>
/// <c>True</c> if the anchor was successfully removed.
/// <c>False</c> usually means the anchor is not longer tracked by the system.
/// </returns>
public bool RemoveAnchor(ARAnchor anchor)
{
if (!enabled)
throw new InvalidOperationException("Cannot create a anchor from a disabled anchor manager.");
if (subsystem == null)
throw new InvalidOperationException("Anchor manager has no subsystem. Enable the manager first.");
if (anchor == null)
throw new ArgumentNullException("anchor");
if (subsystem.TryRemoveAnchor(anchor.trackableId))
{
DestroyPendingTrackable(anchor.trackableId);
return true;
}
return false;
}
/// <summary>
/// Gets the <see cref="ARAnchor"/> with given <paramref name="trackableId"/>,
/// or <c>null</c> if it does not exist.
/// </summary>
/// <param name="trackableId">The <see cref="TrackableId"/> of the <see cref="ARAnchor"/> to retrieve.</param>
/// <returns>The <see cref="ARAnchor"/> with <paramref name="trackableId"/> or <c>null</c> if it does not exist.</returns>
public ARAnchor GetAnchor(TrackableId trackableId)
{
ARAnchor anchor;
if (m_Trackables.TryGetValue(trackableId, out anchor))
return anchor;
return null;
}
protected override GameObject GetPrefab()
{
return m_AnchorPrefab;
}
protected override string gameObjectName
{
get { return "Anchor"; }
}
protected override void OnTrackablesChanged(
List<ARAnchor> addedPoints,
List<ARAnchor> updatedPoints,
List<ARAnchor> removedPoints)
{
if (anchorsChanged != null)
{
anchorsChanged(
new ARAnchorsChangedEventArgs(
addedPoints,
updatedPoints,
removedPoints));
}
}
}
}