Class ARPointCloudManager

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

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
SubsystemLifecycleManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider>
ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>
ARPointCloudManager
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)]
[RequireComponent(typeof(XROrigin))]
[DisallowMultipleComponent]
public class ARPointCloudManager : ARTrackableManager<XRPointCloudSubsystem, XRPointCloudSubsystemDescriptor, XRPointCloudSubsystem.Provider, XRPointCloud, ARPointCloud>
Remarks

Related information: AR Point Cloud Manager component

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

pointCloudPrefab

Getter or setter for the Point Cloud Prefab.

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

Methods

GetPrefab()

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

Declaration
protected override GameObject GetPrefab()
Returns
Type Description
GameObject

The Prefab that will be instantiated for each ARPointCloud.
Overrides

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 Unity.XR.CoreUtils.XROrigin.
Overrides

OnDisable()

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

Declaration
protected override void OnDisable()
Overrides

OnEnable()

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

Declaration
protected override void OnEnable()
Overrides

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

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
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.
Allocator allocator

The allocator to use for the returned NativeArray.
Returns
Type Description
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>