Class ARAnchorManager

Manages anchors.

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
SubsystemLifecycleManager<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider>
ARTrackableManager<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider, XRAnchor, ARAnchor>
ARAnchorManager
Inherited Members
MonoBehaviour.IsInvoking()
MonoBehaviour.CancelInvoke()
MonoBehaviour.StopCoroutine(Coroutine)
MonoBehaviour.StopAllCoroutines()
MonoBehaviour.useGUILayout
MonoBehaviour.runInEditMode
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Component.transform
Component.gameObject
Component.tag
Object.GetInstanceID()
Object.GetHashCode()
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Destroy(Object)
Object.DestroyImmediate(Object)
Object.DontDestroyOnLoad(Object)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.ToString()
Object.name
Object.hideFlags
Namespace: UnityEngine.XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
[DefaultExecutionOrder(-2147483647)]
[DisallowMultipleComponent]
[RequireComponent(typeof(XROrigin))]
public sealed class ARAnchorManager : ARTrackableManager<XRAnchorSubsystem, XRAnchorSubsystemDescriptor, XRAnchorSubsystem.Provider, XRAnchor, ARAnchor>
Remarks

An anchor is a pose (position and rotation) in the physical environment that is tracked by an XR device. Anchors are updated as the device refines its understanding of the environment, allowing you to reliably place mixed reality content at a physical pose.

Related information: Anchors

Properties

anchorPrefab

This prefab will be instantiated for each ARAnchor. May be null.

Declaration
public GameObject anchorPrefab { get; set; }
Property Value
Type Description
GameObject
Remarks

The purpose of this property is to extend the functionality of ARAnchors. It is not the recommended way to instantiate content associated with an ARAnchor.

See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

gameObjectName

The name to assign to the GameObject instantiated for each ARAnchor.

Declaration
protected override string gameObjectName { get; }
Property Value
Type Description
string
Overrides
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

Methods

AddAnchor(Pose)

Attempts to add an ARAnchor with the given Pose.

Declaration
[Obsolete("Add an anchor using AddComponent<ARAnchor>(). (2020-10-06)")]
public ARAnchor AddAnchor(Pose pose)
Parameters
Type Name Description
Pose pose

The pose, in Unity world space, of the ARAnchor.
Returns
Type Description
ARAnchor

A new ARAnchor if successful, otherwise null.
Remarks

If GetPrefab() is not null, a new instance of that prefab will be instantiated. Otherwise, a new GameObject will be created. In either case, the resulting GameObject will have an ARAnchor component on it.

Exceptions
Type Condition
InvalidOperationException

Thrown if this MonoBehaviour is not enabled.
InvalidOperationException

Thrown if the underlying subsystem is null.
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

AttachAnchor(ARPlane, Pose)

Attempts to create a new anchor that is attached to an existing ARPlane.

Declaration
public ARAnchor AttachAnchor(ARPlane plane, Pose pose)
Parameters
Type Name Description
ARPlane plane

The ARPlane to which to attach.
Pose pose

The initial Pose, in Unity world space, of the anchor.
Returns
Type Description
ARAnchor

A new ARAnchor if successful, otherwise null.
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

GetAnchor(TrackableId)

Gets the ARAnchor with given trackableId, or null if it does not exist.

Declaration
public ARAnchor GetAnchor(TrackableId trackableId)
Parameters
Type Name Description
TrackableId trackableId

The TrackableId of the ARAnchor to retrieve.
Returns
Type Description
ARAnchor

The ARAnchor with trackableId or null if it does not exist.
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

GetPrefab()

Get the prefab to instantiate for each ARAnchor.

Declaration
protected override GameObject GetPrefab()
Returns
Type Description
GameObject

The prefab to instantiate for each ARAnchor.
Overrides
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

OnTrackablesChanged(List<ARAnchor>, List<ARAnchor>, List<ARAnchor>)

Invoked when the base class detects trackable changes.

Declaration
protected override void OnTrackablesChanged(List<ARAnchor> added, List<ARAnchor> updated, List<ARAnchor> removed)
Parameters
Type Name Description
List<ARAnchor> added

The list of added anchors.
List<ARAnchor> updated

The list of updated anchors.
List<ARAnchor> removed

The list of removed anchors.
Overrides
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

RemoveAnchor(ARAnchor)

Attempts to remove an ARAnchor.

Declaration
[Obsolete("Call Destroy() on the ARAnchor component to remove it. (2020-10-06)")]
public bool RemoveAnchor(ARAnchor anchor)
Parameters
Type Name Description
ARAnchor anchor

The anchor you wish to remove.
Returns
Type Description
bool

True if the anchor was successfully removed. False usually means the anchor is not longer tracked by the system.
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

Events

anchorsChanged

Invoked once per frame to communicate changes to anchors, including new anchors, the update of existing anchors, and the removal of previously existing anchors.

Declaration
public event Action<ARAnchorsChangedEventArgs> anchorsChanged
Event Type
Type Description
Action<ARAnchorsChangedEventArgs>
See Also
ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>

See Also

ARTrackableManager<TSubsystem, TSubsystemDescriptor, TProvider, TSessionRelativeData, TTrackable>