Class ARPlaneManager

A trackable manager that detects and tracks flat surfaces in the physical environment. Add this component to your XR Origin GameObject to enable plane detection in your app.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

SubsystemLifecycleManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>

ARPlaneManager

Implements

ITrackablesChanged<ARPlane>

Inherited Members

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.trackablesChanged

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.trackables

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.SetTrackablesActive(bool)

SubsystemLifecycleManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.subsystem

SubsystemLifecycleManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.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))]
public sealed class ARPlaneManager : ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>, ITrackablesChanged<ARPlane>

Properties

currentDetectionMode

Get the current plane detection mode in use by the subsystem.

Declaration

public PlaneDetectionMode currentDetectionMode { get; }

Property Value

Type	Description
PlaneDetectionMode

gameObjectName

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

Declaration

protected override string gameObjectName { get; }

Property Value

Type	Description
string

Overrides

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.gameObjectName

planePrefab

Get or set the prefab to instantiate for each detected plane. Can be null.

Declaration

public GameObject planePrefab { get; set; }

Property Value

Type	Description
GameObject

requestedDetectionMode

Get or set the requested plane detection mode.

Declaration

public PlaneDetectionMode requestedDetectionMode { get; set; }

Property Value

Type	Description
PlaneDetectionMode

Methods

GetPlane(TrackableId)

Attempt to retrieve an existing ARPlane by trackableId.

Declaration

public ARPlane GetPlane(TrackableId trackableId)

Parameters

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

Returns

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

GetPrefab()

Get the prefab to instantiate for each detected plane. Can be null.

Declaration

protected override GameObject GetPrefab()

Returns

Type	Description
GameObject	The Prefab which will be instantiated for each ARPlane.

Overrides

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.GetPrefab()

OnAfterSetSessionRelativeData(ARPlane, BoundedPlane)

Invoked just after each ARPlane is updated.

Declaration

protected override void OnAfterSetSessionRelativeData(ARPlane plane, BoundedPlane sessionRelativeData)

Parameters

Type	Name	Description
ARPlane	plane	The ARPlane being updated.
BoundedPlane	sessionRelativeData	The new data associated with the plane. All spatial data is is session-relative space.

Overrides

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.OnAfterSetSessionRelativeData(ARPlane, BoundedPlane)

OnBeforeStart()

Invoked just before Starting the plane subsystem. Used to set the subsystem's requestedPlaneDetectionMode.

Declaration

protected override void OnBeforeStart()

Overrides

SubsystemLifecycleManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider>.OnBeforeStart()

OnDisable()

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

Declaration

protected override void OnDisable()

Overrides

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.OnDisable()

OnEnable()

Invoked when Unity enables this MonoBehaviour. Used to register with the ARRaycastManager.

Declaration

protected override void OnEnable()

Overrides

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.OnEnable()

OnTrackablesChanged(List<ARPlane>, List<ARPlane>, List<ARPlane>)

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<ARPlane> added, List<ARPlane> updated, List<ARPlane> removed)

Parameters

Type	Name	Description
List<ARPlane>	added	The list of added ARPlanes.
List<ARPlane>	updated	The list of updated ARPlanes.
List<ARPlane>	removed	The list of removed ARPlanes.

Overrides

ARTrackableManager<XRPlaneSubsystem, XRPlaneSubsystemDescriptor, XRPlaneSubsystem.Provider, BoundedPlane, ARPlane>.OnTrackablesChanged(List<ARPlane>, List<ARPlane>, List<ARPlane>)

Raycast(Ray, TrackableType, Allocator)

Performs a raycast against all currently tracked planes.

Declaration

public NativeArray<XRRaycastHit> Raycast(Ray ray, TrackableType trackableTypeMask, Allocator allocator)

Parameters

Type	Name	Description
Ray	ray	The ray, in Unity world space, to cast.
TrackableType	trackableTypeMask	A mask of raycast types to perform.
Allocator	allocator	The Allocator to use when creating the returned NativeArray.

Returns

Type	Description
NativeArray<XRRaycastHit>	A new NativeArray of raycast results allocated with allocator. The caller owns the memory and is responsible for calling Dispose on the NativeArray.

See Also

Raycast(Ray, List<ARRaycastHit>, TrackableType)

Raycast(Vector2, List<ARRaycastHit>, TrackableType)

Events

planesChanged

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

Declaration

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

Event Type

Type	Description
Action<ARPlanesChangedEventArgs>

Implements

ITrackablesChanged<TTrackable>