Class ARParticipantManager

A manager for ARParticipants. Creates, updates, and removes GameObjects in response to other users in a multi-user collaborative session.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>

ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>

ARParticipantManager

Implements

ITrackablesChanged<ARParticipant>

Inherited Members

ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>.trackablesChanged

ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>.trackables

ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>.SetTrackablesActive(bool)

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.subsystem

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.descriptor

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.ARFoundation

Assembly: Unity.XR.ARFoundation.dll

Syntax

[DefaultExecutionOrder(-2147483647)]
[DisallowMultipleComponent]
[RequireComponent(typeof(XROrigin))]
[AddComponentMenu("XR/AR Foundation/AR Participant Manager")]
public sealed class ARParticipantManager : ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>, ITrackablesChanged<ARParticipant>

Remarks

Related information: AR Participant Manager component

Properties

gameObjectName

The name to be used for the GameObject whenever a new participant is detected.

Declaration

protected override string gameObjectName { get; }

Property Value

Type	Description
string

Overrides

ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>.gameObjectName

participantPrefab

(Optional) Instantiates this Prefab for each participant. If null, an empty GameObject with a ARParticipant component is instantiated instead.

Declaration

public GameObject participantPrefab { get; set; }

Property Value

Type	Description
GameObject

Methods

GetParticipant(TrackableId)

Attempt to retrieve an existing ARParticipant by trackableId.

Declaration

public ARParticipant GetParticipant(TrackableId trackableId)

Parameters

Type	Name	Description
TrackableId	trackableId	The TrackableId of the participant to retrieve.

Returns

Type	Description
ARParticipant	The ARParticipant with trackableId, or null if it does not exist.

GetPrefab()

The Prefab which will be instantiated for each ARParticipant. Can be null.

Declaration

protected override GameObject GetPrefab()

Returns

Type	Description
GameObject	A Prefab to instantiate for each ARParticipant.

Overrides

ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>.GetPrefab()

OnTrackablesChanged(List<ARParticipant>, List<ARParticipant>, List<ARParticipant>)

Invoked when the base class detects trackable changes.

Declaration

[Obsolete("OnTrackablesChanged() has been deprecated in AR Foundation version 6.0.", false)]
protected override void OnTrackablesChanged(List<ARParticipant> added, List<ARParticipant> updated, List<ARParticipant> removed)

Parameters

Type	Name	Description
List<ARParticipant>	added	The list of added ARParticipants.
List<ARParticipant>	updated	The list of updated ARParticipants.
List<ARParticipant>	removed	The list of removed ARParticipants.

Overrides

ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>.OnTrackablesChanged(List<ARParticipant>, List<ARParticipant>, List<ARParticipant>)

Events

participantsChanged

Invoked when participants have changed (been added, updated, or removed).

Declaration

[Obsolete("participantsChanged has been deprecated in AR Foundation version 6.0. Use trackablesChanged instead.", false)]
public event Action<ARParticipantsChangedEventArgs> participantsChanged

Event Type

Type	Description
Action<ARParticipantsChangedEventArgs>

Implements

ITrackablesChanged<TTrackable>