Class ARParticipantManager

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

Inheritance

Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>

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

ARParticipantManager

Inherited Members

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.GetActiveSubsystemInstance()

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.EnsureSubsystemInstanceSet()

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.OnEnable()

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.OnDisable()

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.OnDestroy()

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.OnBeforeStart()

SubsystemLifecycleManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider>.OnAfterStart()

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.MonoBehaviour.runInEditMode

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)

UnityEngine.Component.TryGetComponent<T>(T)

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInChildren<T>()

UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInParent(System.Type)

UnityEngine.Component.GetComponentInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentInParent<T>()

UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInParent(System.Type)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)

UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponentsInParent<T>()

UnityEngine.Component.GetComponents(System.Type)

UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)

UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)

UnityEngine.Component.GetComponents<T>()

UnityEngine.Component.CompareTag(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessageUpwards(System.String, System.Object)

UnityEngine.Component.SendMessageUpwards(System.String)

UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, System.Object)

UnityEngine.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

UnityEngine.Component.BroadcastMessage(System.String, System.Object)

UnityEngine.Component.BroadcastMessage(System.String)

UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)

UnityEngine.Component.transform

UnityEngine.Component.gameObject

UnityEngine.Component.tag

UnityEngine.Object.GetInstanceID()

UnityEngine.Object.GetHashCode()

UnityEngine.Object.Equals(System.Object)

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

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

UnityEngine.Object.Instantiate(UnityEngine.Object)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)

UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Instantiate<T>(T)

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

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

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

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)

UnityEngine.Object.Destroy(UnityEngine.Object)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)

UnityEngine.Object.DestroyImmediate(UnityEngine.Object)

UnityEngine.Object.FindObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)

UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)

UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)

UnityEngine.Object.DestroyObject(UnityEngine.Object)

UnityEngine.Object.FindSceneObjectsOfType(System.Type)

UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)

UnityEngine.Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)

UnityEngine.Object.ToString()

UnityEngine.Object.name

UnityEngine.Object.hideFlags

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine.XR.ARFoundation

Syntax

[DefaultExecutionOrder(-2147483647)]
[DisallowMultipleComponent]
[RequireComponent(typeof(XROrigin))]
public sealed class ARParticipantManager : ARTrackableManager<XRParticipantSubsystem, XRParticipantSubsystemDescriptor, XRParticipantSubsystem.Provider, XRParticipant, ARParticipant>

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

UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRParticipantSubsystem, UnityEngine.XR.ARSubsystems.XRParticipantSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRParticipantSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRParticipant, UnityEngine.XR.ARFoundation.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
UnityEngine.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
UnityEngine.GameObject	A Prefab to instantiate for each ARParticipant.

Overrides

UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRParticipantSubsystem, UnityEngine.XR.ARSubsystems.XRParticipantSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRParticipantSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRParticipant, UnityEngine.XR.ARFoundation.ARParticipant>.GetPrefab()

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

Invoked when the base class detects trackable changes.

Declaration

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

UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRParticipantSubsystem, UnityEngine.XR.ARSubsystems.XRParticipantSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRParticipantSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRParticipant, UnityEngine.XR.ARFoundation.ARParticipant>.OnTrackablesChanged(System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARParticipant>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARParticipant>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARParticipant>)

Events

participantsChanged

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

Declaration

public event Action<ARParticipantsChangedEventArgs> participantsChanged

Event Type

Type	Description
Action<ARParticipantsChangedEventArgs>