docs.unity3d.com
    Show / Hide Table of Contents

    Class ARPointCloudManager

    A manager for ARTrackedObjects. Uses the XRPointCloudSubsystem to recognize and track point cloud data in the physical environment.

    Inheritance
    Object
    UnityEngine.Object
    UnityEngine.Component
    UnityEngine.Behaviour
    UnityEngine.MonoBehaviour
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>
    ARPointCloudManager
    Inherited Members
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.trackables
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.SetTrackablesActive(Boolean)
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.origin
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.sessionOrigin
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.gameObjectName
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.GetPrefab()
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.m_Trackables
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.m_PendingAdds
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.Awake()
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.OnEnable()
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.OnDisable()
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.CanBeAddedToSubsystem(ARPointCloud)
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.Update()
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.OnTrackablesChanged(List<ARPointCloud>, List<ARPointCloud>, List<ARPointCloud>)
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.OnCreateTrackable(ARPointCloud)
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.OnAfterSetSessionRelativeData(ARPointCloud, XRPointCloud)
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.CreateTrackableImmediate(XRPointCloud)
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.DestroyPendingTrackable(TrackableId)
    ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>.CreateTrackableFromExisting(ARPointCloud, XRPointCloud)
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.subsystem
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.descriptor
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.GetActiveSubsystemInstance()
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.EnsureSubsystemInstanceSet()
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.OnEnable()
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.OnDisable()
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.OnDestroy()
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>.OnBeforeStart()
    SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.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)]
    [RequireComponent(typeof(XROrigin))]
    [DisallowMultipleComponent]
    public class ARPointCloudManager : ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>, IRaycaster

    Properties

    gameObjectName

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

    Declaration
    protected override string gameObjectName { get; }
    Property Value
    Type Description
    String
    Overrides
    UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRPointCloud, UnityEngine.XR.ARFoundation.ARPointCloud>.gameObjectName

    pointCloudPrefab

    Getter or setter for the Point Cloud Prefab.

    Declaration
    public GameObject pointCloudPrefab { get; set; }
    Property Value
    Type Description
    UnityEngine.GameObject

    Methods

    GetPrefab()

    The Prefab that will be instantiated for each ARPointCloud. Can be null.

    Declaration
    protected override GameObject GetPrefab()
    Returns
    Type Description
    UnityEngine.GameObject

    The Prefab that will be instantiated for each ARPointCloud.

    Overrides
    UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRPointCloud, UnityEngine.XR.ARFoundation.ARPointCloud>.GetPrefab()

    OnAfterSetSessionRelativeData(ARPointCloud, XRPointCloud)

    Invoked after each point cloud is updated with new data.

    Declaration
    protected override void OnAfterSetSessionRelativeData(ARPointCloud pointCloud, XRPointCloud sessionRelativeData)
    Parameters
    Type Name Description
    ARPointCloud pointCloud

    The ARPointCloud being updated.

    XRPointCloud sessionRelativeData

    The new data associated with the point cloud. All spatial data is relative to the XROrigin.

    Overrides
    UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRPointCloud, UnityEngine.XR.ARFoundation.ARPointCloud>.OnAfterSetSessionRelativeData(UnityEngine.XR.ARFoundation.ARPointCloud, UnityEngine.XR.ARSubsystems.XRPointCloud)

    OnDisable()

    Invoked when this MonoBehaviour is disabled. Used to unregister with the ARRaycastManager.

    Declaration
    protected override void OnDisable()
    Overrides
    UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRPointCloud, UnityEngine.XR.ARFoundation.ARPointCloud>.OnDisable()

    OnEnable()

    Invoked when this MonoBehaviour is enabled. Used to register with the ARRaycastManager.

    Declaration
    protected override void OnEnable()
    Overrides
    UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRPointCloud, UnityEngine.XR.ARFoundation.ARPointCloud>.OnEnable()

    OnTrackablesChanged(List<ARPointCloud>, List<ARPointCloud>, List<ARPointCloud>)

    Invokes the pointCloudsChanged event.

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

    A list of objects added this frame.

    List<ARPointCloud> updated

    A list of objects updated this frame.

    List<ARPointCloud> removed

    A list of objects removed this frame.

    Overrides
    UnityEngine.XR.ARFoundation.ARTrackableManager<UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystemDescriptor, UnityEngine.XR.ARSubsystems.XRPointCloudSubsystem.Provider, UnityEngine.XR.ARSubsystems.XRPointCloud, UnityEngine.XR.ARFoundation.ARPointCloud>.OnTrackablesChanged(System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARPointCloud>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARPointCloud>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARPointCloud>)

    Raycast(Ray, TrackableType, Allocator)

    Implementation for the IRaycaster interface. Raycasts against every point cloud.

    Declaration
    public NativeArray<XRRaycastHit> Raycast(Ray rayInSessionSpace, TrackableType trackableTypeMask, Allocator allocator)
    Parameters
    Type Name Description
    UnityEngine.Ray rayInSessionSpace

    A Ray, in session space.

    TrackableType trackableTypeMask

    The type of trackables to raycast against. If TrackableType.FeaturePoint is not set, this method returns an empty array.

    Unity.Collections.Allocator allocator

    The allocator to use for the returned NativeArray.

    Returns
    Type Description
    Unity.Collections.NativeArray<XRRaycastHit>

    A new NativeArray, allocated using allocator, containing a list of XRRaycastHits of points hit by the raycast.

    Events

    pointCloudsChanged

    Invoked once per frame with information about the ARTrackedObjects that have changed, that is, been added, updated, or removed. This happens just before ARTrackedObjects are destroyed, so you can set ARTrackedObject.destroyOnRemoval to false from this event to suppress this behavior.

    Declaration
    public event Action<ARPointCloudChangedEventArgs> pointCloudsChanged
    Event Type
    Type Description
    Action<ARPointCloudChangedEventArgs>
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023